Request and Response fields for: Create Transaction Endpoint
This page outlines the specifications for the request and response fields associated with our Send Partners - Create Transaction endpoint. It includes field names, descriptions, and maximum character lengths critical for understanding the data structure posted and returned when processing transactions through the API.
Request fields:
| Field | Description | Data type | Mandatory | MaxLimit | Comments |
|---|---|---|---|---|---|
| reference | This is 9-digit unique ICTC number given to the Sender. (Required) | string | required | 9 | |
| partnerReference | Unique number sent by Agent system for each transaction. (Required) | string | required | 20 | |
| payingAgent | payingAgent | string | required | 6 | |
| targetCurrency | The currency code of the target amount as specified by ISO4217. | string | required | 3 | |
| targetAmount | The amount of money the recipient will receive. | double | 14,3 | ||
| Either TargetAmount or SourceAmount is required. Both values cannot be passed at a time. | |||||
| sourceCurrency | The currency code of the settlement amount as specified by ISO4217. | string | required | 3 | |
| sourceAmount | The amount of money the remitter is sent in local currency. | double | 14,3 | ||
| Either TargetAmount or SourceAmount is required. Both values cannot be passed at a time | |||||
| customerPrincAmount | The amount collected from customer. | double | required | 14,3 | |
| originatingCountry | Originating country from where the remittance is sent. | string | required | 2 | |
| Format: ISO-3166 alpha-2 code. | |||||
| destinationCountry | Destination country. | string | required | 2 | |
| Format: ISO-3166 alpha-2 code. | |||||
| sourceOfFund | Source of the funds. | string | required | 50 | |
| deliveryMode | Defines the method of remittance to the recipient. | int32 | required | 2 | |
| remittancePurpose | Purpose of the remittance | int32 | required | 2 | |
| otherRemittancePurpose | Additional notes for remittance purpose. | string | |||
| Mandatory if RemittancePurpose is 23 (Others) | |||||
| remarks | An additional remittance details. | string | 150 | ||
| pepIdentified | Politically Exposed Person | boolean | 1 | ||
| If true, transaction will go to Compliance block to check if Remitter is PEP. | |||||
| messagePayeeBranch | Message to Payee agent. | string | 100 | ||
| callBeneficiary | Determines whether Beneficiary branch should call to Beneficiary. | boolean | 5 | ||
| onBehalfOfAnotherPerson | The value indicates that the transaction is being sent on behalf of another person. | boolean | 1 | ||
| totalTransactionAmountPerAnnum | Expected total amount per annum. | double | 14,3 | ||
| It is mandatory if the receiving country is one of the Gulf Cooperation Council (GCC) countries. | |||||
| transactionsPerAnnum | Expected transactions per annum. | int32 | 3 | ||
| It is mandatory if the receiving country is one of the Gulf Cooperation Council (GCC) countries | |||||
| remitter object | |||||
| cardNo | Sender's identifier. | string | 8 | ||
| firstName | Sender first name. | string | required | 50 | |
| middleName | Sender middle name. | string | 50 | ||
| lastName | string | required | 50 | ||
| mobileNumber | string | required | 20 | ||
| phoneNumber | Sender's phone number. | string | 25 | ||
| Sender's email. | string | 50 | |||
| dateOfBirth | Sender's birthday. | date-time | required | 8 | |
| Format: yyyy-MM-dd (ISO-8601) | |||||
| gender | Sender's gender. | string | 1 | ||
| M-Male, F-Female | |||||
| nationality | A value represented by a 2-letter ISO-3166 code. | string | required | 2 | |
| countryOfBirth | Country of origin represented by a 2-letter ISO-3166 code. | string | required | 2 | |
| countryOfResidence | Either a country outside of your country of origin Or the same as your nationality if you live in that same country. | string | required | 2 | |
| Format: ISO-3166 2-letter code | |||||
| relation | Sender's relationship. | string | required | 3 | |
| otherRelation | Relationship remarks. | string | 50 | ||
| Mandatory if Relation is OTH. | |||||
| profession | Sender's profession. | string | required | 3 | |
| employerName | Sender's employer name. | string | 50 | ||
| employerStatus | Sender's employer status. | string | required | 13 | |
| remitter address object | |||||
| addressLine1 | Address line 1. | string | required | 35 | |
| addressLine2 | Address line 2. Additional details. | string | 35 | ||
| Mandatory if sending country is GB (United Kingdom). | |||||
| district | District name. | string | 20 | ||
| Mandatory if receiving country is BD AND nationality is BD (Bangladesh). | |||||
| city | City name. | string | 20 | ||
| Mandatory if sending country is UAE or receiving country is Tanzania. | |||||
| postCode | If Originating Country is United Kingdom (GB) postal code is mandatory. | string | This field is currently always null and reserved for future compatibility. | ||
| Mandatory if sending country is GB (United Kingdom). | |||||
| state | State name. | string | This field is currently always null and reserved for future compatibility. | ||
| country | Country name. | string | 2 | ||
| remitter primary ID object | |||||
| type | ID type. | int32 | required | 2 | |
| number | ID number. | string | required | 20 | |
| issueDate | ID issue date | date-time | 8 | ||
| Format: yyyy-MM-dd (ISO-8601) | |||||
| Either Issue Date or Expiry Date is required. | |||||
| expiryDate | ID expiry date. | date-time | 8 | ||
| Format: yyyy-MM-dd (ISO-8601) | |||||
| Either Issue Date or Expiry Date is required. | |||||
| placeOfIssue | The place of issue ID document. | string | required | 2 | |
| Format: ISO-3166 alpha-2 code | |||||
| remitter secondary ID object | |||||
| type | ID type. | int32 | 2 | ||
| number | ID number. | string | 20 | ||
| issueDate | ID issue date. | date-time | 8 | ||
| Format: yyyy-MM-dd (ISO-8601) | |||||
| expiryDate | ID expiry date. | date-time | 8 | ||
| Format: yyyy-MM-dd (ISO-8601) | |||||
| placeOfIssue | The place of issue ID document. | string | 2 | ||
| Format: ISO-3166 alpha-2 code | |||||
| Beneficiary object | |||||
| cardNo | Beneficiary's unique reference number. | string | 10 | ||
| firstName | Beneficiary first name. | string | required | 50 | |
| middleName | Beneficiary middle name. | string | 50 | ||
| lastName | Beneficiary last name. | string | required | 50 | |
| mobileNumber | Beneficiary's mobile number. | string | required | 15 | |
| phoneNumber | Beneficiary's phone mumber. | string | 25 | ||
| Beneficiary's email. | string | 50 | |||
| dateOfBirth | Beneficiary's date of birth. | date-time | 8 | ||
| Format: yyyy-MM-dd (ISO-8601) | |||||
| gender | Beneficiary's sex. | string | 1 | ||
| M-Male, F-Female | |||||
| nationality | A value represented by a 2-letter ISO-3166 code. | string | required | 2 | |
| countryOfBirth | Country of origin represented by a 2-letter ISO-3166 code | string | 2 | ||
| Beneficiary address object | |||||
| addressLine1 | Address line 1. | string | required | 35 | |
| addressLine2 | Address line 2. Additional details. | string | 35 | ||
| Mandatory if sending country is GB (United Kingdom). | |||||
| district | District name. | string | 20 | ||
| Mandatory if receiving country is BD AND nationality is BD (Bangladesh). | |||||
| city | City name. | string | required | 50 | |
| postCode | If Originating Country is United Kingdom (GB) postal code is mandatory. | string | This field is currently always null and reserved for future compatibility. | ||
| Mandatory if sending country is GB (United Kingdom). | |||||
| state | State name. | string | This field is currently always null and reserved for future compatibility. | ||
| country | Country name. | string | This field is currently always null and reserved for future compatibility. | ||
| beneficiary primary ID object | |||||
| type | ID type. | int32 | 2 | ||
| Mandatory if PrimaryId is not null. | |||||
| number | ID number. | string | 20 | ||
| Mandatory if PrimaryId is not null. | |||||
| issueDate | ID issue date. | date-time | 8 | ||
| Format: yyyy-MM-dd (ISO-8601) | |||||
| Either Issue Date or Expiry Date is required. | |||||
| expiryDate | ID expiry date. | date-time | 8 | ||
| Format: yyyy-MM-dd (ISO-8601) | |||||
| Either Issue Date or Expiry Date is required. | |||||
| placeOfIssue | The place of issue ID document. | string | 2 | ||
| Format: ISO-3166 alpha-2 code | |||||
| beneficiary secondary ID object | |||||
| type | ID type. | int32 | 2 | ||
| number | ID number. | string | 20 | ||
| issueDate | ID issue date. | date-time | 8 | ||
| Format: yyyy-MM-dd (ISO-8601) | |||||
| expiryDate | ID expiry date. | date-time | 8 | ||
| Format: yyyy-MM-dd (ISO-8601) | |||||
| placeOfIssue | The place of issue ID document. | string | 2 | ||
| Format: ISO-3166 alpha-2 code | |||||
| beneficiary bank details object | |||||
| bankName | The name of the bank. | string | 100 | ||
| • Mandatory for delivery modes “Account Transfers”: 04 - “Account Transfer To Other Bank”, 08 - ”Account Transfer To Same Bank | |||||
| bankAccountNumber | Account number or IBAN. | string | 20 | ||
| Mandatory for delivery modes “Account Transfers”: 03 - “Credit To Same Bank”, 04 - “Account Transfer To Other Bank”, 08 - ”Account Transfer To Same Bank”. | |||||
| bankAddress1 | Address Line 1. | string | 35 | ||
| Mandatory for delivery modes “Account Transfers”: 04 - “Account Transfer To Other Bank”, 08 - ”Account Transfer To Same Bank”. | |||||
| bankAddress2 | Address Line 2. | string | 35 | ||
| bankCode | Bank short code. | string | 15 | ||
| "• IBFT - In Case of Pakistan | |||||
| • IFSC - In Case of India | |||||
| • BEFTN - In Case of Bangladesh" | |||||
| Mandatory if delivery mode is 04 - “Account Transfer To Other Bank”. |
Response fields:
| Field | Description | Data type | Mandatory | MaxLimit | |
|---|---|---|---|---|---|
| reference | Transaction ID. | string | required | 9 | |
| partnerReference | Unique number sent by Agent system for each transaction. | string | required | 20 | |
| payingAmount | The amount that recipient will receive. | double | required | 14,3 | |
| payingCurrency | The currency code of the paying amount as specified by ISO4217. | string | required | 3 | |
| exchangeRate | The rate applied for the transaction. | double | required | 18,9 | |
| settlementAmount | The amount that remitter is sent. | double | required | 14,3 | |
| settlementCurrency | The currency code of the settlement amount as specified by ISO4217. | string | required | 3 | |
| commissionAmount | The commission settlement amount. | double | required | 18,9 | |
| totalSettlementAmount | Total settlement amount. | double | required | 18,9 | |
| remitterCardNo | Remitter’s Unique reference number. | string | 8 | ||
| beneficiaryCardNo | Beneficiary’s unique reference number. | string | 10 | ||
| status | Actual transaction status. | string | required | 1 | |
| receivingAgentHOCode | Receiving Agent Head Office Code. | string | required | 6 | |
| receivingAgentPin | Some receiving agent having exclusive PIN code constant or dynamic. | string | 20 |
Updated about 2 months ago
Did this page help you?