Skip to main content
For on-ramp (BUY) orders created through the API with a destination network and wallet address, VelaFi can withdraw the purchased crypto to that address after the order completes. When the withdrawal succeeds, VelaFi sends a signed HTTP POST request to your ON_RAMP_WITHDRAW_WEBHOOK endpoint. Verify the signature header and respond with {"callbackStatus": "SUCCESS"} to acknowledge receipt.
Automatic withdrawal to a destination address is enabled per account by VelaFi, and not every order is withdrawn automatically. Orders that are not withdrawn automatically do not trigger this webhook. Automatic withdrawals also trigger CRYPTO_WITHDRAW_WEBHOOK if you subscribe to it.

​
Request Headers

​
Payload Fields

​
string
The ID of the webhook the event was queued for.
​
string
Always ON_RAMP_WITHDRAW_WEBHOOK for this event type.
​
string
ID of the on-ramp order.
​
string
Your VelaFi account (user) ID.
​
string
Your client-supplied order identifier. Omitted if you did not supply one.
​
string
Network of the withdrawal, as set on the order.
​
string
Destination wallet address, as set on the order.
​
string
Cryptocurrency of the order, e.g. USDT.
​
string
Crypto amount of the order (the same value as cryptoAmount in ORDER_WEBHOOK).
​
string
On-chain transaction hash of the withdrawal. Omitted if not available.
​
string
Always succeeded. Failed withdrawals do not trigger this webhook.
​
string
Unix timestamp (milliseconds) at which this delivery attempt was signed.

​
Example Payload

Incoming POST body

​
Required Response

Return an HTTP 2xx status (for example 200) with the following JSON body to acknowledge receipt:
Your response
The same event can arrive more than once, so deduplicate on orderId. See Delivery and Retries.