Domestic Banks Payouts

Good to know: The minimum payout amount to a domestic bank is KES. 100

Initiate domestic bank payout

POST https://api.chpter.co/v1/payout/domestic-bank

Headers

Name
Type
Description

Api-Key*

String

Your chpter Public Key

Content-Type

String

application/json

{
    "message": "invalid payload",
    "success": false,
    "status": 400
}

Good to know: This API uses webhooks to notify you of the payout status through the callback url.

Quick view

{
	"client_details": {
		"full_name": "John Doe",
		"phone_number": "254700123123",
		"email": "johndoe@mail.com"
	},
	"destination_details": {
		"country_code": "KE",
		"bank_code": "1234",
		"bank_name": "Example Bank",
		"bank_account_name": "John Doe",
		"bank_account_number": "0123456789"
	},
	"transfer_details": {
		"currency_code": "KES",
		"amount": 200.5
	},
	"callback_details": {
		 "notify_customer": true,
		"payout_reference": "ABC123",
		"callback_url": "https://eozdpom307nca3.m.pipedream.net"
	}
}

Last updated