Kenya
M-PESA (Wallet)
Overview
| Available | Yes |
targetCurrency | Kenyan Shilling (KES) |
countryCode | KE |
| Earliest Beneficiary Credit | real-time |
| Cut-Off Time (UK Time) | N/A |
| Decimal Places | 0 |
Minimum targetAmount | 100.00 |
Maximum targetAmount | 250000.00 |
Submission data
| API field name | Required? | Field length | Description |
|---|---|---|---|
bankDetails.beneficiaryAccountNumber | ✅ | 13 | Please provide the beneficiary's phone number associated with the M-PESA account. |
bankDetails.bankName | ✅ | Max 35 | Name of the beneficiary bank. Must be:
|
parties.personalDetails.partyTypeCode | ✅ | 4 | Type of the party. Must be:
|
parties.personalDetails.typeCode | ✅ | 4 | Entity description code for the party. Available values:
|
parties.personalDetails.titleCode | Conditional | 4 | Title code for the Individual. Available values:
Condition Mandatory if parties.personalDetails.typeCode is:
|
parties.personalDetails.firstName | Conditional | Max 50 | Beneficiary first name. Full name should be provided (no initials). Condition Mandatory if parties.personalDetails.typeCode is:
|
parties.personalDetails.middleName | ❌ | Max 50 | Beneficiary middle name. |
parties.personalDetails.lastName | Conditional | Max 50 | Beneficiary last name. Full name should be provided (no initials). Condition Mandatory if parties.personalDetails.typeCode is:
|
parties.personalDetails.companyName | Conditional | Max 140 | Full name of the organization. Important Failure to provide the full name could result in delays and potential rejection of your payment. This must consist of 2 words, separated by a space. To whitelist any other naming format please contact your Relationship Manager. Condition Mandatory if parties.personalDetails.typeCode is:
|
parties.personalDetails.dateOfBirth | ❌ | 10 | Beneficiary's date of birth in YYYY-MM-DD format. |
parties.address.street | ❌ | Max 35 | Beneficiary's residential (if payee is an individual) or registered (if payee is a company) house number/name and street e.g. 1 Main Street. |
parties.address.additionalAddressLine | ❌ | Max 35 | Beneficiary's residential (if payee is an individual) or registered (if payee is a company) address e.g. apartment no., unit, studio. |
parties.address.city | ❌ | Max 35 | Beneficiary's city or town of their residential (if payee is an individual) or registered (if payee is a company) address. |
parties.address.postCodeOrZipCode | ❌ | Max 10 | Beneficiary's postal code or zip code of their residential (if payee is an individual) or registered (if payee is a company) address. |
parties.address.countryCode | ❌ | 2 | Beneficiary's country of their residential (if payee is an individual) or registered (if payee is a company) address. Enter the 2 character ISO 3166-1 standard country code API request. |
Important
Additional data is required if the requestor of the payout is a Payment Service Provider (PSP) or Money Service Business (MSB).
Domestic Payment
Overview
| Available | Yes |
targetCurrency | Kenyan Shilling (KES) |
countryCode | KE |
| Earliest Beneficiary Credit | T+1 |
| Cut-Off Time (UK Time) | 11:30 |
| Decimal Places | 2 |
Minimum targetAmount | 0.01 |
Maximum targetAmount | 1000000.00 |
Submission data
| API field name | Required? | Field length | Description |
|---|---|---|---|
bankDetails.beneficiaryAccountNumber | ✅ | Max 15 | Account number of the beneficiary. |
bankDetails.bankCode | ✅ | 5 | Bank code of the beneficiary (bank). |
bankDetails.bankName | ✅ | Max 35 | Name of the beneficiary bank. |
parties.personalDetails.partyTypeCode | ✅ | 4 | Type of the party. Must be:
|
parties.personalDetails.typeCode | ✅ | 4 | Entity description code for the party. Available values:
|
parties.personalDetails.titleCode | Conditional | 4 | Title code for the Individual. Available values:
Condition Mandatory if parties.personalDetails.typeCode is:
|
parties.personalDetails.firstName | Conditional | Max 50 | Beneficiary first name. Full name should be provided (no initials). Condition Mandatory if parties.personalDetails.typeCode is:
|
parties.personalDetails.middleName | ❌ | Max 50 | Beneficiary middle name. |
parties.personalDetails.lastName | Conditional | Max 50 | Beneficiary last name. Full name should be provided (no initials). Condition Mandatory if parties.personalDetails.typeCode is:
|
parties.personalDetails.companyName | Conditional | Max 140 | Full name of the organization. Important Failure to provide the full name could result in delays and potential rejection of your payment. This must consist of 2 words, separated by a space. To whitelist any other naming format please contact your Relationship Manager. Condition Mandatory if parties.personalDetails.typeCode is:
|
parties.personalDetails.dateofBirth | ❌ | 10 | Beneficiary's date of birth in YYYY-MM-DD format. |
parties.address.street | ✅ | Max 35 | Phone Number of the party. |
parties.address.additionalAddressLine | ❌ | Max 35 | Beneficiary's residential (if payee is an individual) or registered (if payee is a company) address e.g. apartment no., unit, studio. |
parties.address.city | ✅ | Max 35 | Beneficiary's city or town of their residential (if payee is an individual) or registered (if payee is a company) address. |
parties.address.postCodeOrZipCode | ❌ | Max 16 | Beneficiary's postal code or zip code of their residential (if payee is an individual) or registered (if payee is a company) address. |
parties.address.countryCode | ✅ | 2 | Beneficiary's country of their residential (if payee is an individual) or registered (if payee is a company) address. Enter the 2 character ISO 3166-1 standard country code in your API request. |
Important
Additional data is required if the requestor of the payout is a Payment Service Provider (PSP) or Money Service Business (MSB).
International WIRE
Overview
| Available | Yes |
targetCurrency | Available WIRE currencies.md |
countryCode | KE |
| Earliest Beneficiary Credit | The estimated delivery time will vary by country and currency. |
| Cut-Off Time (UK Time) | Currency specific |
| Decimal Places | 2 |
Minimum targetAmount | 0.01 |
Maximum targetAmount | 9999999.99 |
Submission data
| API field name | Required? | Field length | Description |
|---|---|---|---|
bankDetails.beneficiaryAccountNumber | ✅ | 35 | Account number of the beneficiary. |
bankDetails.bankCode | ❌ | 5 | Bank code of the beneficiary (bank). |
bankDetails.swiftBic | ✅ | 8 or 11 | The SWIFT BIC is the Bank Identification Code of the beneficiary bank. |
bankDetails.bankName | ✅ | Max 35 | Name of the beneficiary bank. |
parties.personalDetails.partyTypeCode | ✅ | 4 | Type of the party. Must be:
|
parties.personalDetails.typeCode | ✅ | 4 | Entity description code for the party. Available values:
|
parties.personalDetails.titleCode | Conditional | 4 | Title code for the Individual. Available values:
Condition Mandatory if parties.personalDetails.typeCode is:
|
parties.personalDetails.firstName | Conditional | Max 50 | Beneficiary first name. Full name should be provided (no initials). Condition Mandatory if parties.personalDetails.typeCode is:
|
parties.personalDetails.middleName | ❌ | Max 50 | Beneficiary middle name. |
parties.personalDetails.lastName | Conditional | Max 50 | Beneficiary last name. Full name should be provided (no initials). Condition Mandatory if parties.personalDetails.typeCode is:
|
parties.personalDetails.companyName | Conditional | Max 140 | Full name of the organization. Important Failure to provide the full name could result in delays and potential rejection of your payment. This must consist of 2 words, separated by a space. To whitelist any other naming format please contact your Relationship Manager. Condition Mandatory if parties.personalDetails.typeCode is:
|
parties.personalDetails.dateofBirth | ❌ | 10 | Beneficiary's date of birth in YYYY-MM-DD format. |
parties.address.street | ❌ | Max 35 | Beneficiary's residential (if payee is an individual) or registered (if payee is a company) house number/name and street e.g. 1 Main Street. |
parties.address.additionalAddressLine | ❌ | Max 35 | Beneficiary's residential (if payee is an individual) or registered (if payee is a company) address e.g. apartment no., unit, studio. |
parties.address.city | ❌ | Max 35 | Beneficiary's city or town of their residential (if payee is an individual) or registered (if payee is a company) address. |
parties.address.postCodeOrZipCode | ❌ | Max 10 | Beneficiary's postal code or zip code of their residential (if payee is an individual) or registered (if payee is a company) address. |
parties.address.countryCode | Conditional | 2 | Beneficiary's country of their residential (if payee is an individual) or registered (if payee is a company) address. Condition Mandatory if any of the optional Beneficiary address details are provided. Enter the 2 character ISO 3166-1 standard country code in your API request. |
Important
Additional data is required if the requestor of the payout is a Payment Service Provider (PSP) or Money Service Business (MSB).