Mobile Payouts

Initiate mobile payout

Initiate mobile payout

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

Headers

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

400: Bad Request invalid payload

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

200: OK payout initiated

{
    "message": "payout initiated",
    "success": false,
    "status": 200
}

401: Unauthorized merchant not activated

{
    "message": "merchant not activated. please contact [e-mail] ",
    "success": false,
    "status": 401
}

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

Quick view

API Body

{
	"client_details": {
		"full_name": "John Doe",
		"phone_number": "254700123123",
		"email": "[e-mail]"
	},
	"destination_details": {
		"country_code": "KE",
		"mobile_number": "254700123123",
		"wallet_type": "mpesa"
	},
	"transfer_details": {
		"currency_code": "KES",
		"amount": 100.25
	},
	"callback_details": {
		 "notify_customer": true,
		"payout_reference": "DEF456",
		"callback_url": "https://example.com/callback"
	}
}

Successfull Callback Response

{
    "message": "Success",
    "success": true,
    "status": 200,
    "amount": 100,
    "currency": "KES",
    "payout_reference": "ABCD123",
}

Failed Callback Response

{
    "message": "Payout failed contact [e-mail]",
    "success": false,
    "status": 200,
    "payout_reference": "ABCD123",
}