Request and Response fields for: Create Transaction Endpoint

Request fields:

FieldDescriptionData typeMandatoryMaxLimitComments
referenceThis is 9-digit unique ICTC number given to the Sender. (Required)stringrequired9
partnerReferenceUnique number sent by Agent system for each transaction. (Required)stringrequired20
payingAgentpayingAgentstringrequired6
targetCurrencyThe currency code of the target amount as specified by ISO4217.stringrequired3
targetAmountThe amount of money the recipient will receive.double14,3
Either TargetAmount or SourceAmount is required. Both values cannot be passed at a time.
sourceCurrencyThe currency code of the settlement amount as specified by ISO4217.stringrequired3
sourceAmountThe 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
customerPrincAmountThe amount collected from customer.doublerequired14,3
originatingCountryOriginating country from where the remittance is sent. stringrequired2
Format: ISO-3166 alpha-2 code.
destinationCountryDestination country. stringrequired2
Format: ISO-3166 alpha-2 code.
sourceOfFundSource of the funds.stringrequired50
deliveryModeDefines the method of remittance to the recipient.int32required2
remittancePurposePurpose of the remittanceint32required2
otherRemittancePurposeAdditional notes for remittance purpose.string
Mandatory if RemittancePurpose is 23 (Others)
remarksAn additional remittance details. string150
pepIdentifiedPolitically Exposed Personboolean1
If true, transaction will go to Compliance block to check if Remitter is PEP.
messagePayeeBranchMessage to Payee agent.string100
callBeneficiaryDetermines whether Beneficiary branch should call to Beneficiary.boolean5
onBehalfOfAnotherPersonThe value indicates that the transaction is being sent on behalf of another person.boolean1
totalTransactionAmountPerAnnumExpected total amount per annum.double 14,3
It is mandatory if the receiving country is one of the Gulf Cooperation Council (GCC) countries.
transactionsPerAnnumExpected transactions per annum.int32 3
It is mandatory if the receiving country is one of the Gulf Cooperation Council (GCC) countries
remitter object
cardNoSender's identifier.string8
firstNameSender first name.stringrequired50
middleNameSender middle name.string50
lastNamestringrequired50
mobileNumberstringrequired20
phoneNumberSender's phone number. string 25
emailSender's email.string50
dateOfBirthSender's birthday. date-timerequired8
Format: yyyy-MM-dd (ISO-8601)
genderSender's gender. string1
M-Male, F-Female
nationalityA value represented by a 2-letter ISO-3166 code. stringrequired2
countryOfBirthCountry of origin represented by a 2-letter ISO-3166 code.stringrequired2
countryOfResidenceEither a country outside of your country of origin Or the same as your nationality if you live in that same country.stringrequired2
Format: ISO-3166 2-letter code
relationSender's relationship.stringrequired3
otherRelationRelationship remarks.string50
Mandatory if Relation is OTH.
professionSender's profession.stringrequired3
employerNameSender's employer name. string 50
employerStatusSender's employer status.stringrequired13
remitter address object
addressLine1Address line 1.stringrequired35
addressLine2Address line 2. Additional details.string35
Mandatory if sending country is GB (United Kingdom).
districtDistrict name.string20
Mandatory if receiving country is BD AND nationality is BD (Bangladesh).
cityCity name.string20
Mandatory if sending country is UAE or receiving country is Tanzania.
postCodeIf Originating Country is United Kingdom (GB) postal code is mandatory.stringThis field is currently always null and reserved for future compatibility.
Mandatory if sending country is GB (United Kingdom).
stateState name.stringThis field is currently always null and reserved for future compatibility.
countryCountry name.string2
remitter primary ID object
typeID type.int32required2
numberID number.stringrequired20
issueDateID issue datedate-time8
Format: yyyy-MM-dd (ISO-8601)
Either Issue Date or Expiry Date is required.
expiryDateID expiry date.date-time8
Format: yyyy-MM-dd (ISO-8601)
Either Issue Date or Expiry Date is required.
placeOfIssueThe place of issue ID document.stringrequired2
Format: ISO-3166 alpha-2 code
remitter secondary ID object
typeID type.int322
numberID number.string20
issueDateID issue date.date-time8
Format: yyyy-MM-dd (ISO-8601)
expiryDateID expiry date.date-time8
Format: yyyy-MM-dd (ISO-8601)
placeOfIssueThe place of issue ID document.string 2
Format: ISO-3166 alpha-2 code
Beneficiary object
cardNoBeneficiary's unique reference number.string10
firstNameBeneficiary first name.stringrequired50
middleNameBeneficiary middle name.string50
lastNameBeneficiary last name. stringrequired50
mobileNumberBeneficiary's mobile number.stringrequired15
phoneNumberBeneficiary's phone mumber.string25
emailBeneficiary's email. string 50
dateOfBirthBeneficiary's date of birth. date-time 8
Format: yyyy-MM-dd (ISO-8601)
genderBeneficiary's sex.string 1
M-Male, F-Female
nationalityA value represented by a 2-letter ISO-3166 code.stringrequired2
countryOfBirthCountry of origin represented by a 2-letter ISO-3166 codestring2
Beneficiary address object
addressLine1Address line 1.stringrequired35
addressLine2Address line 2. Additional details.string35
Mandatory if sending country is GB (United Kingdom).
districtDistrict name.string20
Mandatory if receiving country is BD AND nationality is BD (Bangladesh).
cityCity name.stringrequired50
postCodeIf 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).
stateState name.stringThis field is currently always null and reserved for future compatibility.
countryCountry name.string This field is currently always null and reserved for future compatibility.
beneficiary primary ID object
typeID type.int322
Mandatory if PrimaryId is not null.
numberID number.string20
Mandatory if PrimaryId is not null.
issueDateID issue date.date-time8
Format: yyyy-MM-dd (ISO-8601)
Either Issue Date or Expiry Date is required.
expiryDateID expiry date.date-time8
Format: yyyy-MM-dd (ISO-8601)
Either Issue Date or Expiry Date is required.
placeOfIssueThe place of issue ID document.string2
Format: ISO-3166 alpha-2 code
beneficiary secondary ID object
typeID type.int322
numberID number.string20
issueDateID issue date.date-time8
Format: yyyy-MM-dd (ISO-8601)
expiryDateID expiry date.date-time 8
Format: yyyy-MM-dd (ISO-8601)
placeOfIssueThe place of issue ID document.string2
Format: ISO-3166 alpha-2 code
beneficiary bank details object
bankNameThe name of the bank.string100
• Mandatory for delivery modes “Account Transfers”: 04 - “Account Transfer To Other Bank”, 08 - ”Account Transfer To Same Bank
bankAccountNumberAccount number or IBAN.string20
Mandatory for delivery modes “Account Transfers”: 03 - “Credit To Same Bank”, 04 - “Account Transfer To Other Bank”, 08 - ”Account Transfer To Same Bank”.
bankAddress1Address Line 1.string 35
Mandatory for delivery modes “Account Transfers”: 04 - “Account Transfer To Other Bank”, 08 - ”Account Transfer To Same Bank”.
bankAddress2Address Line 2.string35
bankCodeBank short code.string15
"• 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:

FieldDescriptionData typeMandatoryMaxLimit
referenceTransaction ID.stringrequired9
partnerReferenceUnique number sent by Agent system for each transaction.stringrequired20
payingAmountThe amount that recipient will receive.doublerequired14,3
payingCurrencyThe currency code of the paying amount as specified by ISO4217.stringrequired3
exchangeRateThe rate applied for the transaction.doublerequired18,9
settlementAmountThe amount that remitter is sent.doublerequired14,3
settlementCurrencyThe currency code of the settlement amount as specified by ISO4217.stringrequired3
commissionAmountThe commission settlement amount.doublerequired18,9
totalSettlementAmountTotal settlement amount.doublerequired18,9
remitterCardNoRemitter’s Unique reference number.string8
beneficiaryCardNoBeneficiary’s unique reference number.string10
statusActual transaction status.stringrequired1
receivingAgentHOCodeReceiving Agent Head Office Code.stringrequired6
receivingAgentPinSome receiving agent having exclusive PIN code constant or dynamic.string20