Developer Portal
  • Kuwait Finance House Portal

Sandbox Environment

Our Sandbox contains a full simulation of our APIs but without connecting to any real customer accounts.

APIs Supported

Account Access Consents

  • Create Account Access Consents
  • Get Account Access Consents by ConsentId
  • Update Account Access Consent Status by ConsentId

Accounts

  • Get Accounts
  • Get Account by AccountId

Balances

  • Get Accounts Balances by AccountId
  • Get Balances

Transactions

  • Get Accounts Transactions by AccountId
  • Get Transactions

Beneficiaries

  • Get Accounts Beneficiaries by AccountId
  • Get Beneficiaries

Direct Debits

  • Get Accounts Direct Debits by AccountId
  • Get Direct Debits

Standing Orders

  • Get Accounts Standing Orders by AccountId
  • Get Standing Orders

Offers

  • Get Accounts Offers by AccountId
  • Get Offers

Parties

  • Get Accounts Parties by AccountId
  • Get Accounts Party by AccountId
  • Get Party

Future Dated Payments

  • Get Accounts Future Dated Payments by AccountId
  • Get Future Dated Payments

Statements

  • Get Accounts Statements by AccountId
  • Get Accounts Statement by AccountId and StatementId
  • Get Accounts Statements File by AccountId and StatementId
  • Get Accounts Statement Transactions by AccountId and StatementId
  • Get Statements

Supplementary Account Info

  • Get Accounts Supplementary Account Info by AccountId

Domestic Payments Consents

  • Create Domestic Payment Consents
  • Get Domestic Payment Consents by ConsentId
  • Get Domestic Payment Consents Funds Confirmation by ConsentId

Domestic Payments

  • Create Domestic Payments
  • Get Domestic Payments by DomesticPaymentId
  • Get Domestic Payment details by DomesticPaymentId

Domestic Standing Orders

  • Create Domestic Standing Order Consents
  • Get Domestic Standing Order Consents
  • Create Domestic Standing Orders
  • Get Domestic Standing Orders
  • Get Domestic Standing Orders

Domestic Future Dated Payment Consents

  • Create Domestic Future Dated Payment Consents
  • Get Domestic Future Dated Payment Consents by ConsentId
  • Create Domestic Future Dated Payment Cancellation Consents
  • Get Domestic Future Dated Payment Cancellation Consents by ConsentId

Domestic Future Dated Payments

  • Create Domestic Future Dated Payments
  • Get Domestic Future Dated Payments by DomesticFutureDatedPaymentId
  • Patch Domestic Future Dated Payments by DomesticFutureDatedPaymentId
  • Get Domestic Future Dated Payment Details by DomesticFutureDatedPaymentId

File Payment Consents

  • Create File Payment Consents
  • Get File Payment Consents by ConsentId
  • Create File Payment Consents File by ConsentId
  • Get File Payment Consents File by ConsentId

File Payments

  • Create File Payments
  • Get File Payments by FilePaymentId
  • Get File Payment Details by FilePaymentId
  • Get File Payments Report File by FilePaymentId

International Future Dated Payments

  • Create International Future Dated Payment Consents
  • Get International Future Dated Payment Consents
  • Get International Future Dated Payment Consents Funds Confirmation
  • Create International Future Dated Payments
  • Get International Future Dated Payments
  • Get International Future Dated Payments

International Standing Orders

  • Create International Standing Order Consents
  • Get International Standing Order Consents
  • Create International Standing Orders
  • Get International Standing Orders
  • Get International Standing Orders

International Payment Consents

  • Create International Payment Consents
  • Get International Payment Consents by ConsentId
  • Get International Payment Consents Funds Confirmation by ConsentId

International Payments

  • Create International Payments
  • Get International Payments by InternationalPaymentId
  • Get International Payment Details by InternationalPaymentId

Getting Started

Postman is a free tool to help developers build and test APIs without having to write any code. Download the postman app available on both Mac and Windows from this link https://www.postman.com/. Once you have the postman app installed on a developer's machine you can follow the steps below.

Step 1: Register

Request Client Profile, Signing Certificate, Transport Key and Certificate from Tarabut Gateway.

Step 2: Import Environment Files and Collections into Postman

Step 2.1: Import your client profile and postman collection file.

Click on the import file button and browse or drag your file to the window. This will add your postman collection and client profile to postman.

Import 1

Import 2

Step 2.1: Select your client profile

Once you have imported the client profile in previous step you can select your profile from the environment dropdown in the top right corner.

Import 2

Step 3: Add Client Certificates

Add the following certs to your postman settings on certificates tab.

The CRT should be set to the transport certificate provided by Tarabut Gateway. The Key value should be set to the private key for the transport certificate.

In Postman settings ensure SSL Certificate Verification is set to off.

Import 2

Step 4: Account Information Flow

4.1 Client Credentials Grant

Client Credentials Grant

Account Access Consent

TPPs can generate the consent flow URL by postman

Consent 1

Once the URL is constructed, open the URL to initiate the PSU consent flow

4.4 Authenticate User

Consent 2

Sandbox User Accounts:

user password
rora rora
mits mits
ivsa ivsa

4.5 Select Accounts

Consent 3

Once the PSU consent is successful, the Sandbox will redirect back to the redirect URI. Copy the auth code from the URL.

Consent 4

4.6 Generate the Access Token

Access Token

4.7 Retrieve Account Data

Accounts

4.8 Retrieve Transaction Data

Transactions

Step 5: Payment Initiation Flow

Once you have completed steps 1 to 3 above, you can also follow the step by step guides in the Postman Collection to try out the Payment Initiation API.

Table of Content
Please wait