Skip to main content
GET
Get a payout

Authorizations

Authorization
string
header
required

Your API key: sk_live_… / sk_test_… (secret), pk_live_… / pk_test_… (publishable, read-only reference data) or rk_live_… / rk_test_… (payments only).

Path Parameters

reference
string
required

The payout's reference.

Example:

"PO-8d3f0c1e6b2a4f7e9c5d1a3b7e2f4c6d"

Response

The payout.

reference
string
Example:

"PO-8d3f0c1e6b2a4f7e9c5d1a3b7e2f4c6d"

type
enum<string>
Available options:
mobile_money,
bank
status
enum<string>
Available options:
processing,
success,
failed,
reversed
amount
number
fee
number
levy
number
currency
string
Example:

"MWK"

merchantReference
string | null

Your own reference.

description
string
recipient
object

{ provider, phone } for mobile money, { bankName, accountLast4, accountName } for a bank account.

providerReference
string | null
failureCode
string | null
Example:

null

createdAt
string<date-time>
completedAt
string<date-time> | null