API Reference

This API is used to query the status of a payout.

Use the external reference that you provided when payout was initialised.

Request And Headers

GET: /api/payouts/status?externalReference=<reference>

Content-Type: application/json

Authorization: Basic <token>

NB: We will provide you with the Basic Auth credentials.

Response

Status: 200, 400, 404

{
	"recipientCode": "CPC_210468877705707",
	"externalReference": "12345",
	"reference": "C-12345-T”,
	"amount": 100,
	"countryCode": "NG",
	"currencyCode": "NGN",
	"status": “SUCCESSFUL
}