Skip to main content

Payouts to Kenya

Payout parameters

NameMandatoryTypeDescription
payment_method+objectPayout data
 type+stringValue: bank_account
 bank_account+objectBank account
  system_type+stringValue: global
  global+objectBank account details
   description+stringPurpose of remittance for the payout. This description should match the classification given in How to specify the remittance purpose
   bank_account_number+stringBank account number for the payout
participant_details+objectInformation on the payout participants
 recipient+objectRecipient details
  bank_name+stringImportant: the bank name must be chosen from the List of supported banks, otherwise the payout will fail
  currency+stringRecipient's currency in ISO 4217 format. Case insensitive
  country_iso3+stringRecipient's country code (ISO-3166-1 alpha-3)
  first_name+stringRecipient's first name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
  last_name+stringRecipient's last name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
 sender+objectSender details
  company_name+stringSender company name. Limited to 100 characters, cannot contain digits only
  registration_number+stringSender company registration number
  country_iso3+stringSender’s country code (ISO-3166-1 alpha-3)
  code+stringSender company registration number
amount_details+objectPayout amount details
 amount+intPayout amount in decimal format. The value must be greater than zero. If you are sending 100 USD, write 10000
 currency+stringISO 4217 currency code. Case insensitive

Example

curl -X POST \
https://demo.smart-glocal.com/api/v1/session/start/payout \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d'{
"session_id": "ps_1053680",
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "global",
"global": {
"iban": "NUMBER_VALUE",
"description": "purpose of remittance"
}
}
},
"participant_details": {
"recipient": {
"bank_name": "Bank name from the list below",
"currency": "kes",
"first_name": "John",
"last_name": "Johnson"
},
"sender": {
"company_name": "Company name",
"registration_number": "1234567890",
"country_iso3": "USA",
"code": "1234567890"
}
},
"amount_details": {
"amount": 1000,
"currency": "usd"
}
}'

List of supported banks

CountryCurrencyBank
KenyaKESConsolidated Bank of Kenya Limited
KenyaKESABSA Bank
KenyaKESBank of Africa Kenya Limited
KenyaKESDiamond Trust Bank Limited
KenyaKESCredit Bank Limited
KenyaKESStanbic Bank Kenya Limited
KenyaKESNIC Bank Limited
KenyaKESCitibank N A
KenyaKESJamii Bora Bank
KenyaKESSpire Bank Ltd
KenyaKESSidian Bank Limited
KenyaKESGuaranty Trust Bank ( Kenya) Ltd.
KenyaKESKenya Commercial Bank Limited
KenyaKESI&M Bank Limited
KenyaKESGulf African Bank Ltd
KenyaKESParamount Universal Bank Limited
KenyaKESEquity Bank Limited
KenyaKESFamily Bank Ltd
KenyaKESMiddle East Bank Kenya Limited
KenyaKESFirst Community Bank
KenyaKESKENYA WOMEN MICROFINANCE BANK LT
KenyaKESNational Bank of Kenya Limited
KenyaKESCo-operative Bank of Kenya Limited
KenyaKESPrime Bank Limited
KenyaKESNCBA Bank Kenya
KenyaKESHabib Bank A G Zurich
KenyaKESStandard Chartered Bank Kenya Limited
KenyaKESGuardian Bank Limited