Sign in

Queries for the payouts status using payout’s Order Reference

get/payouts/{orderReference}

Path parameters

orderReferencestring required

Unique identifier for the payout order

Response

Query Payout Response

updatedAtstring date-time

Last updated timestamp

createdAtstring date-time

Creation timestamp

idstring

Payout ID

orderReferencestring

Associated order reference

amountstring

Payout amount

currencystring

Currency code

feestring

Transaction fee

status'SUCCESS' | 'PROCESSING' | 'PENDING' | 'FAILED' | 'REFUNDED' | 'REVERSED'

Payout status

channel'BANK TRANSFER' | 'MOBILE MONEY'

Payout channel

channelProviderstring

Name of the payout channel provider

transferType'ACH' | 'RTGS'

Transfer type - when applicable

notesstring

Additional notes if available

clientIdstring

Application Client ID associated with the payout

Changes