Initiate Crypto Transfer
This operation allow the client to perform crypto transfer to an external wallet.
N.B. The amount field is the withdrawal amount only (fees are not included). The applicable fee, including any platform fee, is computed server-side and is not a client-supplied input.
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
Request object for crypto payment initiation request. The sourceAccountId can be a main account or sub-account.
The source account ID from which funds will be debited. This can be a main account or sub-account.
Transaction amount, specified in the source account's currency.
x >= 0"100.00"
The destination details of the transfer. Either beneficiaryId or address must be provided.
Notes
Response
Request received, do 2FA
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