Get Cash Deposit
Get specific cash deposit 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 deposit details
Details of a cash deposit transaction.
Reference for the cash deposit transaction at initiation.
Currency in which the account was credited.
"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 the customer paid in.
"NGN"
Amount credited to the account.
100
Exchange rate applied for this deposit.
1450.75
Amount the customer paid in, in the pay-in currency.
145075
Identifier of the credit transaction on the account.
Reference provided by the cash deposit provider.
"PROV123456"
Destination account details the customer must pay into to fund the deposit. Mirrors a Beneficiary (without an id). Carries only the account details needed to make the payment; transaction context (amount, status, etc.) lives on the enclosing CashDepositTransaction.
details can be nullable when the account number provider is still generating it