Zafin System API

About Zafin System API

Zafin APIs are built to perform business functions in Pricing and Billing domain.

Description

For all API calls, all data must be provided as parameters in the request. The system does not do any database lookups for example, to get the customer segment for a customer.

Below is the list of supported APIs

• Standard Deposit Rate

• Deposit Rate Adjustment

• Consolidated Deposit Rate

• Consolidated Tiered Deposit Rate

• Search Deposit Rate

• Standard Time Deposit Rate

• Time Deposit Rate Adjustment

• Consolidated Time Deposit Rate

• Search Time Deposit Rate

• Standard Loan Rate

• Loan Rate Adjustment

• Consolidated Loan Rate

• Search Loan Rate

• Standard Mortgage Rate

• Mortgage Rate Adjustment

• Consolidated Mortgage Rate

• Search Mortgage Rate

• Search Eligible Offers

• Get Offer Detail

• Request Offer Enrollment

• Request Offer Unenrollment

• Get Offer Instance

• Get Reward Earning

• Create Pricing Arrangement

• Update Pricing Arrangement Associations

• Get Pricing Arrangement

• Get Pricing Arrangement Associations

• Search Pricing Arrangement

• Create Billing Arrangement

• Apply Bill Discount

• Correct Fee

• Charge Deposit Transaction Fee

• Quote Deposit Transaction Price

• Quote Deposit Transaction Prices

• Accept Deposit Transaction Price Quote

• Accept Deposit Transaction Price Quotes

API Authentication

Making API Calls

API calls are a secure way of making requests for an implementation. The requests are authenticated using the server that you have set up. The system implements the “Resource Owner Password Credentials Grant” (a.k.a. password grant), and the “Client Credentials Grant” (a.k.a. client credentials).

The following types of requests exist:

  a) To authenticate a user against an OAuth authentication server and receive a session-level token

  b) To make a Pricing & Billing API request of the server using the session-level token

       The session-level token remains valid until one of the following occurs:

         • The access token has expired

         • The access token has been forcefully invalidated (which can be accomplished through a support request)

Obtaining an Access Token

Upon successful login, an access token is returned which is encoded with the permissions enabled for that user and which must be used for any of the other API requests. These permissions should be used to validate that the user has the right to perform operations before they are attempted.

Making another API Call

When the system receives a request which requires authentication, it will search the request for a standard-bearer token. If it is found and if it is valid (and not expired) the system will allow the call to be performed.

Any errors encountered will result in an unsuccessful HTTP response code.