Body Parameters
Here is a breakdown of the body parameters from the provided JSON structure:
| Field Name | Data Type | Description | State | Example Value |
|---|---|---|---|---|
| originatorConversationId | string | A unique identifier of the request from the client. | Mandatory | "3fa85f64-5717-4562-b3fc-2c963f66afa7" |
| paymentNotes | string | Notes regarding the payment. | Optional | "send christmas to grandma" |
| paymentOrderLines | array | An array containing the details of the payment orders. | Mandatory | |
| paymentOrderLines.remitter | object | Object containing details about the remitter. | Mandatory | |
| remitter.name | string | Name of the remitter. | Mandatory | "Dorothy A Kees" |
| remitter.email | string | Email of the remitter. | Mandatory | "[email protected]" |
| remitter.address | string | Address of the remitter. | Mandatory | "3068 Kessla Way" |
| remitter.phoneNumber | string | Phone number of the remitter. | Mandatory | "843-360-6258" |
| remitter.idType | string | Type of ID of the remitter. | Mandatory | "Social Security Number" |
| remitter.idNumber | string | ID number of the remitter. | Mandatory | "657-18-9292" |
| remitter.idIssuePlace | string | Place where the ID was issued. | Mandatory | "Nairobi" |
| remitter.idIssueDate | string | Date when the ID was issued. | Mandatory | "1997/01/03" |
| remitter.idExpireDate | string | Expiry date of the ID. | Mandatory | "1997/01/03" |
| remitter.nationality | string | Nationality of the remitter. | Mandatory | "Kenyan" |
| remitter.dateOfBirth | string | Date of birth of the remitter. | Mandatory | "1997/01/03" |
| remitter.country | string | Country of the remitter. | Mandatory | "USA" |
| remitter.ccy | integer | Currency code. | Mandatory | 404 |
| remitter.financialInstitution | string | Financial institution of the remitter. | Mandatory | "Foo Credit Union" |
| remitter.sourceOfFunds | string | Source of funds for the remitter. | Mandatory | "Business" |
| remitter.principalActivity | string | Principal activity of the remitter. | Mandatory | "Business" |
| remitter.state | string | State of the remitter. | Optional | "state" |
| remitter.city | string | City of the remitter. | Mandatory | "Nairobi" |
| remitter.postalCode | string | Postal code of the remitter. | Mandatory | "00100" |
| paymentOrderLines.recipient | object | Object containing details about the recipient. | Mandatory | |
| recipient.name | string | Name of the recipient. | Mandatory | "Larry China" |
| recipient.address | string | Address of the recipient. | Mandatory | "65 Beijing Rd" |
| recipient.emailAddress | string | Email address of the recipient. | Mandatory | "[email protected]" |
| recipient.phoneNumber | string | Phone number of the recipient. | Mandatory | "+156722000000" |
| recipient.idType | string | Type of ID of the recipient. | Mandatory | "National Id" |
| recipient.idNumber | string | ID number of the recipient. | Mandatory | "730870472" |
| recipient.idExpireDate | string | Expiry date of the ID. | Mandatory | "20200707" |
| recipient.financialInstitution | string | Financial institution of the recipient. | Mandatory | "BANK OF COMMUNICATIONS" |
| recipient.institutionIdentifier | string | Identifier of the financial institution. | Mandatory | "8600067" |
| recipient.primaryAccountNumber | string | Primary account number of the recipient. | Mandatory | "8656985625478586" |
| recipient.ccy | integer | Currency code. | Mandatory | 156 |
| recipient.purpose | string | Purpose of the payment. | Mandatory | "Christmas gift" |
| recipient.country | string | Country of the recipient. | Mandatory | "CN" |
| recipient.state | string | State of the recipient. | Optional | "Shangai" |
| recipient.city | string | City of the recipient. | Mandatory | "Shangai" |
| recipient.postalCode | string | Postal code of the recipient. | Mandatory | "00100" |
| recipient.nationality | string | Nationality of the recipient. | Mandatory | "CHINA" |
| paymentOrderLines.transaction | object | Object containing details about the transaction. | Mandatory | |
| transaction.routeId | string | Unique identifier of the route. | Mandatory | "43a2c786-1e22-44b2-ad76-77d86c817686" |
| transaction.amount | integer | Amount of the transaction. | Mandatory | 1000 |
| transaction.channelType | integer | Type of channel (e.g., 4 for RTGS). | Mandatory | 4 |
| transaction.reference | string | Reference for the transaction. | Mandatory | "PMT_20210101_000001" |
| transaction.systemTraceAuditNumber | string | Unique number generated by the consumer. | Mandatory | "67536e3b-af81-eb11-9b69-ec5c683ffd00" |
| transaction.relationShip | string | Relationship to the recipient. | Mandatory | "spouse" |