Data Types

📝 Data Definition for Payment Orders

This table defines the mandatory and optional fields required for a payment order request.

These include supported Currencies, Channel Types, Category Types, Transaction Status Types and Field Definitions

Field Name	Data Type	Max Length	State	Description
`originatorConversationId`	string	100	Mandatory	Unique identifier for the transaction.
`paymentNotes`	string	255	Mandatory	Notes related to the payment.
`remitterName`	string	128	Mandatory	Sender's full name.
`remitterAddress`	string	128	Mandatory	Sender's address.
`remitterPhoneNumber`	string	13	Mandatory	Sender's phone number.
`remitterIdType`	string	13	Mandatory	Type of sender's ID (e.g., National ID).
`remitterIdNumber`	string	13	Mandatory	Sender's ID number.
`remitterCountry`	string	50	Mandatory	Sender's country.
`remitterCCY`	string	3	Mandatory	Sender's currency code.
`remitterNationality`	string	64	Mandatory	Sender's nationality.
`remitterIdIssuePlace`	string	64	Optional	Place of ID issuance.
`remitterIdIssueDate`	string	64	Optional	Date of ID issuance.
`remitterIdExpiryDate`	string	64	Optional	Date of ID expiry.
`recipientName`	string	64	Mandatory	Recipient's full name.
`remitterFinancialInstitution`	string	64	Mandatory	Sender's financial institution.
`remitterSourceOfFunds`	string	64	Mandatory	Source of the sender's funds.
`remitterPrincipalActivity`	string	64	Mandatory	Sender's principal activity/occupation.
`remitterDateOfBirth`	string	64	Mandatory	Sender's date of birth.
`recipientAddress`	string	64	Optional	Recipient's address.
`recipientEmailAddress`	string	64	Optional	Recipient's email address.
`recipientPhoneNumber`	string	13	Mandatory	Recipient's phone number.
`recipientMCCMNC`	integer	6	Required Mobile only	Mobile Country Code/Mobile Network Code.
`recipientInstitutionIdentifier`	string	6	Optional (Only for Mobile)	Recipient's institution identifier.
`recipientPrimaryAccountNumber`	string	50	Mandatory	Recipient's account number (e.g., mobile number).
`recipientCCY`	integer	6	Mandatory	Recipient's currency code.
`recipientCountry`	string	3	Mandatory	Recipient's country code.
`recipientIdType`	string	3	Mandatory	Recipient's ID type.
`recipientIdNumber`	string	3	Mandatory	Recipient's ID number.
`recipientPurpose`	string	3	Mandatory	Purpose of the transaction.
`transactionRouteId`	guid	6	Mandatory	The ID of the transaction route.
`transactionAmount`	decimal	6	Mandatory	The amount of the transaction.
`transactionChannelType`	integer	6	Mandatory	The channel type of the transaction.
`transactionReference`	string	100	Mandatory	Reference for the transaction.
`transactionSystemTraceAudiNumber`	string	50	Mandatory	System Trace Audit Number.
`transactionCustomerAccountNo`	string	50	Optional	Customer Account Number.

Name Specification Note: The recipient and remitter names must adhere to the following specifications:
1.
Should contain at least two names.
2.
No capturing of initials.
3.
No input of numbers.
4.
A single space should be used between the names.

📊 Reference Codes

Transaction Status Types

Reference for the transactionStatus field on the Transfers callback payload.

Type	Description
0	Pending
1	Queued
2	Submitted
3	Submit Acknowledged
4	Success
6	Failed
7	Rejected
8	Timed Out

Category Types

Reference for the category field from the Find Transaction Routes request. Describes the transaction type for a particular route.

Type	Description
0	Mobile Wallet Transfer
1	Bank Transfer
4	Bill Payments
6	Business Transfers

Channel Types

Reference for the channel field from the Find Transaction Routes request. Describes the available transaction routes.

Type	Description
1	Mpesa
2	Pesalink
3	EFT
4	RTGS
6	B2B
8	Bill Payments
13	Business Buy Goods
14	Business PayBill
15	Business Deposit
16	Business To Business Transfer
17	Business Transfer From MMF To Utility
18	Business Transfer From Utility To MMF
19	Express Bank Transfer (via Paybill)
23	Business PayBill

Currencies

The API supports the following currencies:

Name	Code	Description
Kenyan Shillings	404	KES
Naira	566	NGN
Ghana Cedi	936	GHS
Tanzanian Shilling	834	TZS
Ugandan Shilling	800	UGX
U.S. Dollar (For Liberia)	840	USD
United Arab Emirates dirham	784	AED

📝 Data Definition for Payment Orders#

📊 Reference Codes#

Transaction Status Types#

Category Types#