Create Cash Deposit
Create cash deposit, using the created quote. Returns the deposit transaction, including the payment details the customer must pay into.
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.
Body
Details required to create a cash deposit. The amount and currency must align with an existing quote.
Identifier of an existing cash deposit quote, retrieved from the cash deposit quote endpoint.
Account to credit for this deposit. Can be the main account ID or a sub-account ID.
Alpha-numeric deposit reference, unique for this deposit.
8 - 48^[a-zA-Z0-9_-]{8,48}$"CTR123456"
x > 0Should be same as one of pay-in or account currencies in the quote. Defaults to account currency if not provided.
Identifies the party sending fiat for the deposit. When omitted on a deposit request, it is constructed from the business details.
Notes to be included with the deposit.
Response
Cash deposit created
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