KES Payout(new encryption)
Summary
These APIs are used to initiate a KES payout
Integration steps
Token GenerationGet Bank Lists
Make a GET call to the Bank List API
GET
{{env_url}}/wallet/merchant/bank/transfer/request/banks/KES
Headers
Key | Value |
---|---|
Content-Type | application/json |
Authorization | Bearer <token here> |
Resolve Bank Account
Make a POST call to the resolve account API
POST
{{env_url}}/wallet/merchant/bank/transfer/request/resolve/account
Headers
Key | Value |
---|---|
Context-Type | application/json |
Authorization | Bearer <token here> |
Request Body
Name | Type | Description |
---|---|---|
bankCode* | 430000 | |
countryCode* | KE | |
accountNumber* | Sydney Mark | |
accountType* | personal | |
documentType* | String | Customer’s mode of identity. This could be one of: [ |
businessId* | String | 133 |
documentNumber* | String | 8801235111088 |
Merchant Payout request
Make a POST call to the Merchant payout request API
POST
{{env_url}}/wallet/merchant/{businessId}/bank/transfer/v2/request
You would need to pass, as a header the x-auth-token. This can be obtained from your merchant dashboard → Settings → Generate API keys → Merchant public key.
Headers
Key | Value |
---|---|
Content-Type | application/json |
x-auth-token | Your merchant public key |
Authorization | Bearer <token here> |
Request body (encrypted):
Request body (plain)
Request Body
Name | Type | Description |
---|---|---|
country* | KE | |
bankCode* | 430000 | |
amount* | 100 | |
accountName* | Sydney Mark | |
requestId* | String | kbtr-3857-011-133-166993253334816 |
description* | String | Payout |
currency* | String | KES |
bankName* | String | Ubank Ltd |
accountNumber* | String | 1222951828 |
Query payout status
Make a GET call to the Fetch All API
GET
{{env_url}}/wallet/wire/fetch/all
Make a GET call to the Fetch All API to retrieve all your previously initiated wire payments.
Key | Value |
---|---|
Content-Type | application/json |
Authorization | Bearer <token here> |
Last updated