Create Cash Payout
Create cash payment, using the created quote
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 payment. The amount and currency must align with an existing quote.
Identifier of an existing cash payment quote, retrieved from the cash payment quote endpoint.
Account to debit for this payment. Can be the main account ID or a sub-account ID.
Alpha-numeric transfer reference, unique for this transfer.
8 - 48^[a-zA-Z0-9_-]{8,48}$"CTR123456"
x > 0Identifier of an existing beneficiary to whom the transfer will be made.
Reason for the payment, to be provided at the time of transfer creation.
Should be same as one of payout or account currencies in the quote. Defaults to account currency if not provided.
Notes to be included in the transfer.
Response
Cash payment created
The payment initiation response
"P12005E1DV"
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 Indicates if transfer is awaiting 2FA confirmation. This applies mostly to transaction initiated via dashboard
List of 2fa enabled
AUTHENTICATOR_APP, EMAIL, SMS