Payout Destinations

Mobile Payout Destination

Creating a mobile payout destination.

POST https://api.chpter.co/v1/payout/mobile-destination

Headers

Name	Type	Description
Api-Key*	String	Your chpter Public Key
Content-Type	String	application/json

Request Body

Name	Type	Description
type*	String	Mobile destination type (mpesa)
phone_number*	String	Mobile destination phone number

200 destination exists

{
    "message": "destination exists",
    "success": true,
    "status": 200
}

401 Unauthorized

{
    "message": "unauthorized",
    "success": false,
    "status": 401
}

400: Bad Request Bad request payload

{
    "message": "payload validation error.",
    "success": false,
    "status": 400
}

201: Created destination created

{
    "message": "destination created",
    "success": true,
    "status": 201
}

Mobile Payout Destination Quick view

API Body

{
    "type": "mpesa",
    "phone_number": "254700123123"
}

Domestic Banks Payout Destination

Creating a domestic bank payout destination.

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

Headers

Name	Type	Description
Api-Key*	String	Your chpter Public Key
Content-Type	String	application/json

Request Body

Name	Type	Description
bank_name*	String	Bank name
bank_account_name*	String	Bank account name
bank_account_number*	String	Bank account number

200 destination exists

{
    "message": "destination exists",
    "success": true,
    "status": 200
}

401 Unauthorized

{
    "message": "unauthorized",
    "success": false,
    "status": 401
}

400: Bad Request Bad request payload

{
    "message": "payload validation error.",
    "success": false,
    "status": 400
}

201: Created destination created

{
    "message": "destination created",
    "success": true,
    "status": 201
}

Domestic Banks Payout Destination Quick view

API Body

{
    "bank_name": "KCB",
    "bank_account_name": "ALBERT CHELA",
    "bank_account_number": "123451267"
}