Transaction Request Parameters

Parameter name	Description	Data Type	Requirement	Field Length
requestDate	The creation date and time of the transaction as supplied by the sending partner in YYYY-MM-DD HH:mm:ss format.	String	Mandatory	19
amount	Destination amount payable to the beneficiary with precision of 2 decimal places.	String	Mandatory	10,2
currency	Destination amount currency in ISO 4217 format. e.g., NGN	String	Mandatory	3
type	The harmonized Transaction Type. Fixed value - b2b, b2p, p2b	String	Mandatory	3
descriptionText	Free format text description of the transaction provided by the client. This can be provided as a message for the receiver on the account statement.	String	Optional	1-256
transactionReference	Unique Transaction reference generated by the sending partner.	String	Mandatory	4-50
provider	Provider value should be same as sent in the validation request. If a different value is sent then the transaction will be rejected. Note: Mandatory/Optional requirement of this field is destination country specific.	Numeric	Conditional	5-12
sendingAmount	Paying Amount with precision of 2 decimal places	String	Optional	10,2
payinCcyCode	Paying Currency in ISO 4217 format. e.g., USD	String	Optional	3
paymentMode	Type of Payment i.e., Cash, Card, Bank account or Others	String	Mandatory	0-20
authenticationPartnerCode	Multi factor authentication partner code. Unique code with a combination of 4 letters of the Company's first name, Country Code, City Code	String	Optional	4-20
paymentOption	Mobile Wallet/Account Credit	String	Mandatory	4-100
sendingPartnerCode	Unique send partner code. Unique code with a combination of 4 letters of the Company's first name, Country Code, City Code	String	Optional	4-20
recievingPartnerCode	Unique Receive Partner Code	String	Optional	4-20
kidNumber	KID number is a Norwegian payment reference number used to identify both the customer and the specific invoice in an electronic banking transaction, specifically for P2B (Person to Business) and B2B (Business to Business) transactions.	String	Optional	3-25

Debit Party Parameters

Parameter name	Description	Data Type	Requirement	Field Length
key	msisdn	String	Mandatory	6
value	Sender Mobile Number with country code. e.g., +254123456789	String	Mandatory	10-18

Credit Party Parameters

Parameter name	Description	Data Type	Requirement	Field Length
Key	msisdn	String	Mandatory	6
Value	Beneficiary wallet Number with country code. e.g., +254123456789.	String	Optional - For Bank Accounts Mandatory - For Mobile Wallet	5-50
Key	beneficiarySmsNotify	String	Optional	20
Value	Status Update through SMS notification. Values are true or false. True indicates notification required. Notification will be sent for b2b and p2b transactions on BusinessMsisdn number (part of business recipient KYC).	String	Optional	4-5
Key	bankaccountno	String	Conditional	13
Value	Beneficiary bank account or IBAN number as applicable and required in the destination country for receiving funds. e.g., 2365417895 or AT483200000012345864.	String	Mandatory - For bank accounts Optional - For mobile wallets	5-50
Key	accounttype	String	Optional	11
Value	Type of the bank account. Supported account types: Checking, Savings. The default account type for p2p transactions is Savings.	String		0-20
Key	sortcode	String	Conditional	8
Value	Bank Code as required in the destination Country. It is the IFSC code for India and Swift BIC for all other countries. The requirement of this code is destination country specific.	String	Mandatory - For bank accounts Optional - For mobile wallets	4-25
Key	organisationid	String	Conditional	14
Value	Full name of the beneficiary bank	String	Mandatory - For bank accounts Optional - For mobile wallets	4-60
Key	banksubcode	String	Conditional	11
Value	This is a code that indicates the branch code or routing code or routing number of the specific bank branch to which the transaction is to be sent.	String	Mandatory - For bank accounts Optional - For mobile wallets	1-10
Key	accountIBAN	String	Conditional	11
Value	Recieve Account IBAN Number for receiving funds. This should be the same as the value in bankaccountno.	String	Mandatory - For bank accounts Optional - For mobile wallets	13
Key	accountAdditionalNo1	String	Optional	20
Value	If any additional accounts to be provided.	String	Optional	13
Key	accountAdditionalNo2	String	Optional	20
Value	If any additional accounts to be provided.	String	Optional	13

Sender KYC Parameters (Applicable for p2b type transactions)

Parameter name	Description	Data Type	Requirement	Field Length
nationality	Nationality of the customer in ISO Alpha-2 format. e.g., US	String	Mandatory	2
dateOfBirth	Sender's Date of Birth in YYYY-MM-DD format	String	Mandatory	10
countryOfBirth	Sender's country of birth in ISO Alpha-2 format, e.g., US	String	Optional	10
gender	Sender's Gender. Enumeration = (M)ale, (F)emale, (U)nspecified	String	Optional	1
primaryContactCountryCode	Primary Contact Country Code	String	Optional	2
primaryContactNo	Primary Contact Number	String	Optional	10-15
primaryContactNoType	Primary Contact Number type i.e., Personal/Office	String	Optional	4-50
senderKyc:idDocument:idType	Sender's Id document type: For example nationalidcard, drivinglicense, passport, etc	String	Mandatory	1-20
idNumber	Sender's Id document number	String	Mandatory	1-30
issueDate	Sender's Id document issue date in YYYY-MM-DD format.	String	Optional	10
expiryDate	Sender's Id document expiry date in YYYY-MM-DD format.	String	Mandatory	10
issuerCountry	Country where the identification type was issued in ISO Alpha-2 format.	String	Optional	2
senderKyc:postalAddress:addressLine1	First line of the address	String	Mandatory	1-256
addressLine2	Second line of the address	String	Optional	4-20
addressLine3	Third line of the address	String	Optional	4-20
city	City/Town of sender's address	String	Mandatory	2-20
stateProvince	Sender's address state. Note: State in ISO Alpha-2 format if the transaction originated in US, Canada and payout is in Guatemala.	String	Conditional	2-20
postalCode	Postal Code of sender's address	String	Conditional	6-8
country	Country in ISO Alpha-2 format	String	Mandatory	2
senderKyc:subjectName:title	Title of the Sender	String	Optional	0-6
firstName	First name of the Sender	String	Mandatory	1-50
middleName	Middle name of the Sender	String	Optional	0-20
lastName	Last name of the Sender	String	Mandatory	1-50
fullName	Full name of the Sender	String	Optional	1-128

Recipient KYC Parameters (Applicable for b2p type transactions)

Parameter name	Description	Data Type	Requirement	Field Length
nationality	Nationality of the customer in ISO Alpha-2 format. e.g., US	String	Optional	2
dateOfBirth	Beneficiary's Date of Birth in YYYY-MM-DD format	String	Optional	10
gender	Beneficiary's Gender. Enumeration = (M)ale, (F)emale, (U)nspecified	String	Optional	1
emailAddress	Personal email Id	String	Optional	0-60
firstName	First name of the beneficiary	String	Mandatory	1-50
lastName	Last name of the beneficiary	String	Mandatory	1-50
fullName	Full name of the beneficiary	String	Mandatory	1-120
regionalBeneficiaryName	Regional Beneficiary Name as per bank account (Japanese language: Katakana)	String	Conditional	1-50
recipientKyc:idDocument:idType	Beneficiary's Id document as required in the destination country. Please click here for the list of required documents in each country.	String	Conditional	1-20
idNumber	Beneficiary's Id document number.	String	Conditional	1-30
issueDate	Beneficiary's Id document issue date in YYYY-MM-DD format.	String	Optional	10
expiryDate	Beneficiary's Id document expiry date in YYYY-MM-DD format.	String	Conditional	10
issuerCountry	Country where the identification type was issued in ISO Alpha-2 format.	String	Optional	2

International Transfer Information Parameters

Parameter name	Description	Data Type	Requirement	Field Length
quoteId	The specific quoteId to be used for the transaction. This quoteId is generated when a quotation is created and it is returned on the quotation response.	String	Mandatory	16-20
receivingCountry	Destination country where the payout is to be made. To be specified in ISO Alpha 2 format. e.g., NG	String	Mandatory	2
remittancePurpose	Reason for the transfer. Click here to find the accepted values.	String	Mandatory	4-30
sourceOfFunds	Source of funds.	String	Mandatory	4-17
relationshipSender	The relation between the sender and the beneficiary.	String	Optional	3-11

Business Sender KYC Parameters (Applicable for b2p and b2b business transactions)

Parameter name	Description	Data Type	Requirement	Field Length
businessName	Company Name	String	Mandatory	4-180
businessPINCode	Company Pin Code	String	Optional	2-20
businessAddress1	Registered Address 1	String	Mandatory	4-512
businessAddress2	Registered Address 2	String	Optional	4-20
businessAddressCity	Registered City. Note: Mandatory/Optional requirement of this field is destination country specific.	String	Conditional	2-20
businessAddressState	Registered State.	String	Conditional	4-20
businessAddressCountryCode	Registered Country Code in ISO Alpha 2 standard	String	Optional	2
businessAddressZip	Registered address Zip Code	String	Conditional	4-20
businessPrimaryContactCountryCode	Company Primary Contact Country Code in ISO Alpha 2 standard	String	Mandatory	2
businessPrimaryContactNo	Company Primary Contact Number	String	Mandatory	10-15
businessDescription	Short description of the business	String	Optional	0-100
businessEmail	Company email id	String	Mandatory	0-100
businessCountryCode	Company Country Code in ISO Alpha 2 standard	String	Mandatory	2
businessRegistrationType	Type of Registration	String	Mandatory	4-100
businessRegistrationIssuedBy	Company Incorporation Issued by	String	Optional	0-20
businessRegistrationIssuedAt	Company Incorporation Issued at	String	Optional	0-20
businessRegistrationNumber	Company Incorporation Number	String	Mandatory	4-20
businessRegistrationIssueDate	Company Incorporation Issued Date in YYYY-MM-DD format.	String	Mandatory	10
businessIDValidThru	Company Incorporation Expiry Date in YYYY-MM-DD format.	String	Mandatory	10

Business Recipient KYC Parameters (Applicable for p2b and b2b business transactions)

Parameter name	Description	Data Type	Requirement	Field Length
businessName	Company Name	String	Mandatory	4-180
businessPINCode	Company Pin Code	String	Optional	2-20
businessAddress1	Registered Address 1	String	Optional	4-20
businessAddress2	Registered Address 2	String	Optional	4-20
businessAddressCity	Registered City	String	Optional	4-20
businessAddressState	Registered State	String	Optional	4-20
businessAddressCountryCode	Registered Country Code in ISO Alpha 2 standard	String	Mandatory	2
businessAddressZip	Registered address Zip Code	String	Optional	4-20
businessPrimaryContactCountryCode	Company Primary contact country code in ISO Alpha 2 standard	String	Optional	2
businessPrimaryContactNo	Company Primary Contact Number	String	Optional	10-15
businessPrimaryContactNoType	Company Primary Contact Number type i.e., Personal/Office	String	Optional	4-50
businessDescription	Short description of the business	String	Optional	0-100
businessEmail	Company email id	String	Optional	0-100
businessCountryCode	Company country code in ISO Alpha 2 standard	String	Optional	2
businessRegistrationType	Type of Registration	String	Conditional	0-100
businessRegistrationNumber	Company Incorporation Number. Note: Mandatory/Optional requirement of this field is destination country specific.	String	Conditional	0-20
businessRegistrationIssuedBy	Company Incorporation Issued by	String	Optional	0-20
businessRegistrationIssuedAt	Company Incorporation Issued at	String	Optional	0-20
businessRegistrationIssueDate	Company Incorporation Issued Date	String	Optional	0-10
businessIDValidThru	Company Incorporation Expiry Date	String	Optional	0-10
typeofbusiness	Type of Company	String	Optional	0-20
businessPObox	Company PO Box	String	Optional	0-10
regionalBeneficiaryName	Regional Beneficiary Name as per bank account (Japanese language: Katakana)	String	Conditional	1-50

Request parameter list

Transaction Request Parameters#

Debit Party Parameters#

Credit Party Parameters#

Sender KYC Parameters (Applicable for p2b type transactions)#

Recipient KYC Parameters (Applicable for b2p type transactions)#

International Transfer Information Parameters#

Business Sender KYC Parameters (Applicable for b2p and b2b business transactions)#

Business Recipient KYC Parameters (Applicable for p2b and b2b business transactions)#

Transaction Request Parameters

Debit Party Parameters

Credit Party Parameters

Sender KYC Parameters (Applicable for p2b type transactions)

Recipient KYC Parameters (Applicable for b2p type transactions)

International Transfer Information Parameters

Business Sender KYC Parameters (Applicable for b2p and b2b business transactions)

Business Recipient KYC Parameters (Applicable for p2b and b2b business transactions)