Confirm a Transaction

Input Fields:
nationality
countryOfBirth
countryOfResidence
Beneficiary ID-placeOfIssue
Previously, any two characters could be entered; this will now be restricted to valid ISO codes only.

Before:
For Pakistan,
"nationality" - PT could also be passed.
After:
"nationality" - Only PK will be accepted.

20/05/2025

Create a Transaction

Input Fields:
Remitter ID-placeOfIssue
Beneficiary ID-placeOfIssue
Previously, any two characters could be entered; this will now be restricted to valid ISO codes only.

Before:
For UAE,
"Remitter ID-placeOfIssue" - UA could also be passed.
After:
"Remitter ID-placeOfIssue" - Only AE will be accepted.

20/05/2025

Create Transaction

1. Beneficiary Nationality - Should be ‘Pakistan’ for Pakistan account transfers (same bank transfer and third-party transfer).
2. Purpose of Remittance - Should be “Family Maintenance” for Pakistan account transfers (same bank transfer and third party transfer).

1. "nationality" = "Pakistan" 2. "remittancePurpose" = "Family Maintenance"

LIVE

All relevant methods where the country code is accepted.

1. A new parameter 'payoutCurrency' ‘is added as a mandatory parameter wherever ‘destinationCountry’ is mandatory, in all relevant methods.
2. Only standard ISO codes and the corresponding payout currency will be accepted, and no dummy codes will be accepted.
3. If ‘destinationCountry’ parameter is optional, then ‘payoutCurrency’ is also optional. However, if ‘destinationCountry’ value is entered then payout currency should be mandatory.
4. In all the relevant methods (as listed below) wherever ‘destinationCountry’ is a part of the response, only standard ISO codes will be returned and no dummy codes.

E.g., For Uganda payout in
USD or UGX (local currency):
"destinationCountry" - UG
"Payout Currency" - USD
or
"destinationCountry" - UG
"Payout Currency" - UGX

LIVE

Create Transaction

optional parameters become mandatory if Receiving Country=Oman and Delivery mode=4:

Beneficiary ID Type
Beneficiary ID Number
Beneficiary ID Issue Date
Beneficiary ID Expiry Date

"primaryId": {
"type": 11,
"number": "IN123TEST",
"issueDate": "2000-01-01",
"expiryDate": "2030-01-01",

To be announced

Create Transaction

optional parameter "City" becomes mandatory in Remitter and Beneficiary "Address" object for all countries

"city": "Delhi"

To be announced

Create Transaction

optional parameter "District" becomes mandatory in "Address" object if Receiving Country=BD, Delivery Mode=7, Remitter/ Beneficiary Nationality=BD

"district": "Bagerhat"

To be announced

Get Outstanding Remittance

new field in response body:

"SourceOfFundCode"

"sourceOfFunds": "Business",
"sourceOfFundCode": 1

14/05/2024

Get Outstanding Remittance

new fields in response body:

"Settlement Currency"
"countryOfBirth" (Remitter)

"settlementCurrency": "AED"
"countryOfBirth": "PK"

To be announced

Get Outstanding Remittance

new field Remitter "cardNo" in response body, if Receiving Country=AE

"cardNo": "646464"

To be announced

Get Outstanding Remittance

values for the following parameters to be displayed:

1. Fields for AE: Remitter ID type, Remitter ID number, Remitter country of birth
2. Fields for NP: Remitter Mobile Number, Remitter ID type, Remitter ID number, Relationship with Beneficiary, Source of Fund
3. Common fields

"type": 11,
"number": "IN123TEST"
"countryOfBirth": "IN"
"relation": "HUS"

To be announced

Receive Payment

new field in response body:

"SourceOfFundCode"

"sourceOfFunds": "Business",
"sourceOfFundCode": 1,

14/05/2024

Receive Payment

new fields in response body:

"Settlement Currency"
"nationalityCountryCode" (Remitter/Beneficiary)
"countryOfBirth" (Remitter)

"nationality": "BANGLADESH",
"nationalityCountryCode": "BD"
"settlementCurrency": "AED"
"countryOfBirth": "PK"

To be announced

Receive Payment

new field Remitter "cardNo" in response body, if Receiving Country=AE

"cardNo": "646464"

To be announced

Receive Payment

values for the following parameters to be displayed:

1. Fields for AE: Remitter ID type, Remitter ID number, Remitter country of birth
2. Fields for NP: Remitter Mobile Number, Remitter ID type, Remitter ID number, Relationship with Beneficiary, Source of Fund
3. Common fields

"type": 11,
"number": "IN123TEST"
"countryOfBirth": "IN"
"relation": "HUS"

To be announced

Create "dummy" transaction

New Sandbox endpoint is solving the issue of Receiving Partners who need to call several endpoints on the sending side for testing receiving endpoints. Therefore, a Receiving Partner can call "Create Dummy Transaction" without populating the standard "Create Transaction" payload. To do this, the Receiving Partner would need to execute the following steps:

1. Prepare API headers
2. Select endpoint: {{baseUrl}}/api/v1/simulations/transactions/initiate.
3. Press "Send" with:
   • Option 1: An empty body request. Sample: { }
   • Option 2: A request with a minimal set of data (including delivery mode).
4. Retrieve a response - a transaction created with an ICTC number.

{
"payingAgent": "PK01RH",
"targetCurrency": "PKR",
"targetAmount": 0,
"sourceAmount": 100,
"sourceOfFund": "Salary",
"deliveryMode": "7",
"remittancePurpose": "16"
}

26/06/2024

Partner Support System endpoints

The Partner Support System (PSS) is designed to help our Partners seamlessly incorporate our request management capabilities into their application. PSS consists of 3 endpoints:

• Post Request
• Track Request
• Attend Request

More information

11/07/2024