originatorConversationId | Unique ID for the payment transaction | Mandatory |
paymentNotes | Notes for the payment transaction | Mandatory |
paymentOrderLines | Contains the details of the payment order | Mandatory |
paymentOrderLines.remitter.name | Name of the remitter (sender) | Mandatory |
paymentOrderLines.remitter.address | Address of the remitter | Mandatory |
paymentOrderLines.remitter.phoneNumber | Phone number of the remitter | Mandatory |
paymentOrderLines.remitter.idType | ID type (e.g., National ID) | Mandatory |
paymentOrderLines.remitter.idNumber | ID number of the remitter | Mandatory |
paymentOrderLines.remitter.country | Country of the remitter (KE for Kenya) | Mandatory |
paymentOrderLines.remitter.ccy | Currency code (404 for KES) | Mandatory |
paymentOrderLines.remitter.financialInstitution | Financial institution code | Mandatory |
paymentOrderLines.remitter.sourceOfFunds | Source of funds for the remitter (e.g., Business) | Mandatory |
paymentOrderLines.remitter.principalActivity | Principal activity of the remitter (e.g., Business) | Mandatory |
paymentOrderLines.remitter.institutionIdentifier | Institution identifier | Mandatory |
paymentOrderLines.recipient.name | Name of the recipient | Mandatory |
paymentOrderLines.recipient.address | Address of the recipient | Mandatory |
paymentOrderLines.recipient.emailAddress | Email address of the recipient (optional) | Not Mandatory |
paymentOrderLines.recipient.phoneNumber | Phone number of the recipient (optional) | Not Mandatory |
paymentOrderLines.recipient.idType | ID type for the recipient | Mandatory |
paymentOrderLines.recipient.idNumber | ID number of the recipient | Mandatory |
paymentOrderLines.recipient.financialInstitution | Financial institution code of recipient | Mandatory |
paymentOrderLines.recipient.primaryAccountNumber | Recipient's primary account number | Mandatory |
paymentOrderLines.recipient.mccmnc | Mobile country code or mobile network code | Mandatory |
paymentOrderLines.recipient.ccy | Currency code for recipient (404 for KES) | Mandatory |
paymentOrderLines.recipient.country | Country code for recipient (KE for Kenya) | Mandatory |
paymentOrderLines.recipient.purpose | Purpose of the payment (optional) | Not Mandatory |
paymentOrderLines.recipient.institutionIdentifier | Institution identifier | Mandatory |
paymentOrderLines.transaction.routeId | Transaction route identifier | Mandatory |
paymentOrderLines.transaction.ChannelType | Channel type for the transaction (e.g., 175) | Mandatory |
paymentOrderLines.transaction.amount | Amount of the transaction | Mandatory |
paymentOrderLines.transaction.reference | Reference for the payment | Mandatory |
paymentOrderLines.transaction.systemTraceAuditNumber | Unique system trace number | Mandatory |
paymentOrderLines.metaDataList | Additional metadata for the transaction | Not Mandatory |
paymentOrderLines.metaDataList.key | Key in metadata (e.g., bankSwiftCode) | Mandatory |
paymentOrderLines.metaDataList.value | Value of the metadata (e.g., CBAFKENX for SWIFT) | Mandatory |