Skip to content
/
Inbound message regarding...

Inbound message regarding the ramp status
Webhook

Request

When a ramp transitions into a new status, the status update will be sent to the provided callback endpoint to your server.

Bodyapplication/jsonrequired
order_idstringrequired

The ID of the ramp, returned on creation of a ramp, or via the GET ramp endpoint.

Example:"fd04c5780062121628e05324003eef30"
statusstringrequired
StatusDescription
IN_PROGRESSOrder is in progress.
REFUNDEDOrder has been refunded
EXPIREDOrder has expired.
FULFILLEDOrder has been completed.
EXTRA_VERIFICATIONCustomer requires extra verification.
COIN_DEPOSIT_READYCoin deposit is ready.
COIN_DEPOSIT_CONFIRMEDCoin deposit has been confirmed.
COIN_TRANSFERREDCoin has been transferred.
FIAT_TRANSFERREDFiat has been transferred.
ACCOUNT_BLOCKEDCustomer account is blocked., a separate webhook will be sent with the Identity reference of the customer
PAYMENT_READYPayment is ready to be processed.
PAYMENT_ACCEPTEDPayment has been accepted for the order
PAYMENT_RECEIVEDPayment has been received.
PAYMENT_DECLINEDPayment has been declined.
PAYMENT_CANCELLEDPayment has been cancelled.
Enum:"IN_PROGRESS""REFUNDED""EXPIRED""FULFILLED""EXTRA_VERIFICATION""COIN_DEPOSIT_READY""COIN_DEPOSIT_CONFIRMED""COIN_TRANSFERRED""FIAT_TRANSFERRED""ACCOUNT_BLOCKED"
Example:"IN_PROGRESS"
status_datestring, (datetime)required

The date of the status update

Example:"2023-06-05 19:53:08"
created_atstring, (datetime)

The date of the status update

Example:"2023-06-02 14:44:00"
updated_atstring, (datetime)

The date of the status update

Example:"2023-06-09 13:53:08"
internal_reasonstringrequired

The internal body for this inbound message containing the reason of the message, this is for internal use.

Example:"Order is in progress"
external_reasonstringrequired

The external reason to provide to your customer via your designated messaging channel.

Example:"Your payment was successfully received. Your order is now being processed."
order_typestring

The transaction type of the ramp

Enum:"ONRAMP""OFFRAMP"
Example:"ONRAMP"
crypto_coinstring

The crypto currency requested

Example:"ETH"
crypto_blockchainstring

The blockchain

Example:"ETH"
crypto_amountstring

The amount of crypto

Example:"0.228632"
fiat_currencystring

The requested fiat currency

Example:"USD"
fiat_amountstring

The amount of fiat

Example:"100"
asset_pricestring

The market rate of the asset (crypto)

Example:"0.018656"
paymentstring

The payment requested

Example:"100"
processing_feestring

The processing fee associated to the ramp

Example:"1.95"
network_feestring

The network fee associated to the ramp

Example:"2.33"
usd_exchange_ratestring

Represent the value of 1 unit of the source Fiat in USD

Example:"1.36"
transaction_hashstring

The transaction hash of the completed ramp

Example:"0x9401a7173d7bd2ad73e8b798fdc30c83fb0529e6edbad163c549a5ad136407be"
Payload
{
  "order_id": "fd04c5780062121628e05324003eef30",
  "status": "IN_PROGRESS",
  "status_date": "2023-06-05 19:53:08",
  "created_at": "2023-06-02 14:44:00",
  "updated_at": "2023-06-09 13:53:08",
  "internal_reason": "Order is in progress",
  "external_reason": "Your payment was successfully received. Your order is now being processed.",
  "order_type": "ONRAMP",
  "crypto_coin": "ETH",
  "crypto_blockchain": "ETH",
  "crypto_amount": "0.228632",
  "fiat_currency": "USD",
  "fiat_amount": "100",
  "asset_price": "0.018656",
  "payment": "100",
  "processing_fee": "1.95",
  "network_fee": "2.33",
  "usd_exchange_rate": "1.36",
  "transaction_hash": "0x9401a7173d7bd2ad73e8b798fdc30c83fb0529e6edbad163c549a5ad136407be"
}

Responses

Your server returns this code if it accepts the callback. On a failed response we will retry sending the webook.

© Banxa 2026