Get Cash Payout
Get specific cash payment by reference
Authorizations
Requires authentication via API key and HMAC signature.
x-api-key: Your API key generated from your Onboard Business dashboard.x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 secondsx-signature: SHA256 HMAC HEX signature calculated overt={x-timestamp}&{requestBody}using your API Secret.
Path Parameters
Response
cash payment details
Details of a cash payment transaction.
Reference for the cash payment transaction at initiation.
Currency in which the account was debited.
"USD"
Status of the transaction, indicating its current state in the processing lifecycle.
- PENDING: The transaction has been created but not yet processed.
- IN_PROGRESS: The transaction is currently being processed.
- FAILED: The transaction processing has failed.
- SUCCESS: The transaction has been successfully processed.
PENDING, IN_PROGRESS, FAILED, SUCCESS Currency in which the beneficiary will be paid out.
"NGN"
Amount transferred.
100
Exchange rate applied for this transfer.
1450.75
Amount paid out to the beneficiary in payout currency.
145075
Basic information about a beneficiary as at the time of transaction.
Identifier of the transaction on the account.
Reference provided by the cash payment provider.
"PROV123456"