{
"createdAt": "2023-11-07T05:31:56Z",
"eventType": "<string>",
"eventUid": "<string>",
"payload": {
"createTime": "2023-11-07T05:31:56Z",
"dstAmount": "<string>",
"dstChain": "<string>",
"dstCurrency": "<string>",
"dstFillAmount": "<string>",
"externalOrderUid": "<string>",
"feeDetails": [
{
"currency": "<string>",
"fee": "<string>",
"isInclusive": true,
"type": "<string>",
"discountValue": "<string>",
"slippage": 123
}
],
"orderUid": "<string>",
"partnerCurrency": "<string>",
"partnerFee": "<string>",
"paymentMode": "<string>",
"srcAmount": "<string>",
"srcChain": "<string>",
"srcCurrency": "<string>",
"transactionHash": [
"<string>"
],
"updateTime": "2023-11-07T05:31:56Z",
"walletAddress": "<string>",
"walletAddressTag": "<string>",
"bankAccountDetail": {
"accountNumber": "<string>",
"accountType": "<string>",
"address": "<string>",
"bankName": "<string>",
"bic": "<string>",
"branchName": "<string>",
"country": "<string>",
"currency": "<string>",
"email": "<string>",
"iban": "<string>",
"name": "<string>",
"phone": "<string>",
"taxId": "<string>",
"transferCode": "<string>"
}
}
}Webhooks for ramp order status changes
Webhooks for ramp order status changes
{
"createdAt": "2023-11-07T05:31:56Z",
"eventType": "<string>",
"eventUid": "<string>",
"payload": {
"createTime": "2023-11-07T05:31:56Z",
"dstAmount": "<string>",
"dstChain": "<string>",
"dstCurrency": "<string>",
"dstFillAmount": "<string>",
"externalOrderUid": "<string>",
"feeDetails": [
{
"currency": "<string>",
"fee": "<string>",
"isInclusive": true,
"type": "<string>",
"discountValue": "<string>",
"slippage": 123
}
],
"orderUid": "<string>",
"partnerCurrency": "<string>",
"partnerFee": "<string>",
"paymentMode": "<string>",
"srcAmount": "<string>",
"srcChain": "<string>",
"srcCurrency": "<string>",
"transactionHash": [
"<string>"
],
"updateTime": "2023-11-07T05:31:56Z",
"walletAddress": "<string>",
"walletAddressTag": "<string>",
"bankAccountDetail": {
"accountNumber": "<string>",
"accountType": "<string>",
"address": "<string>",
"bankName": "<string>",
"bic": "<string>",
"branchName": "<string>",
"country": "<string>",
"currency": "<string>",
"email": "<string>",
"iban": "<string>",
"name": "<string>",
"phone": "<string>",
"taxId": "<string>",
"transferCode": "<string>"
}
}
}Authorizations
Partner API key sent in the X-RAMPNOW-API-KEY header. Every request must ALSO send X-RAMPNOW-TIMESTAMP (unix seconds) and X-RAMPNOW-SIGN (hex HMAC-SHA256 of timestamp + METHOD + requestURI + rawBody, keyed with your API secret). See the Authentication guide.
Body
Webhook is the envelope Rampnow POSTs to your webhook endpoint. payload is event-specific —
see the concrete payload struct for each eventType (e.g. RampOrderStatusChangeWebhook for
ramp_order.status_change). Use eventUid for idempotent processing.
When the webhook event was generated (UTC)
Event kind, e.g. ramp_order.status_change
Unique event ID; use for deduplication across retries
Event-specific payload; shape depends on eventType
Show child attributes
Show child attributes
Response
OK
Was this page helpful?