Offramp webhooks
Webhook events
| Event type | Description |
|---|---|
| FIAT_WITHDRAWAL_ORDER_CREATED | Withdrawal order was created. |
| FIAT_WITHDRAWAL_ORDER_CONFIRM | Withdrawal order was confirmed. |
| FIAT_WITHDRAWAL_FIAT_FUNDS_RECEIVED | Fiat funds were received for the withdrawal order. |
| FIAT_WITHDRAWAL_SUCCESS | Withdrawal order was completed successfully. |
| FIAT_WITHDRAWAL_ORDER_EXPIRED | Withdrawal order expired and withdrawal was not fulfilled. |
| FIAT_WITHDRAWAL_ORDER_FAILED | Withdrawal order failed. |
Payload description
FIAT_WITHDRAWAL_ORDER_CREATED
| Parameter | Type | Description |
|---|---|---|
| cryptoAmount | string | Cryptocurrency amount of this order. |
| fiatCurrency | string | Fiat currency of this order. |
| fiatAmount | string | Fiat amount of this order. |
| orderId | string | Unique order identifier. |
| externalId | string | External order identifier specified by the merchant. |
| parentExternalId | number | System ID of the order. |
| idempotencyKey | string | External ID generated by the merchant while creating the fiat order through API. |
| currency | string | Cryptocurrency of this order. |
| type | string | Event type. |
FIAT_WITHDRAWAL_ORDER_CONFIRM
| Parameter | Type | Description |
|---|---|---|
| orderId | string | Unique order identifier. |
| externalId | string | External order identifier specified by the merchant. |
| parentExternalId | number | System ID of the order. |
| idempotencyKey | string | External ID generated by the merchant while creating the fiat order through API. |
| currency | string | Cryptocurrency of this order. |
| type | string | Event type. |
FIAT_WITHDRAWAL_FIAT_FUNDS_RECEIVED
| Parameter | Type | Description |
|---|---|---|
| cryptoAmount | string | Cryptocurrency amount of this order. |
| fiatCurrency | string | Fiat currency of this order. |
| fiatAmount | string | Fiat amount of this order. |
| orderId | string | Unique order identifier. |
| externalId | string | External order identifier specified by the merchant. |
| parentExternalId | number | System ID of the order. |
| idempotencyKey | string | External ID generated by the merchant while creating the fiat order through API. |
| currency | string | Cryptocurrency of this order. |
| type | string | Event type. |
FIAT_WITHDRAWAL_ORDER_FAILED
| Parameter | Type | Description |
|---|---|---|
| orderId | string | Unique order identifier. |
| externalId | string | External order identifier specified by the merchant. |
| parentExternalId | number | System ID of the order. |
| idempotencyKey | string | External ID generated by the merchant while creating the fiat order through API. |
| currency | string | Cryptocurrency of this order. |
| type | string | Event type. |
| reason | string | Reason why the fiat withdrawal order failed. |
FIAT_WITHDRAWAL_ORDER_EXPIRED
| Parameter | Type | Description |
|---|---|---|
| orderId | string | Unique order identifier. |
| externalId | string | External order identifier specified by the merchant. |
| parentExternalId | number | System ID of the order. |
| idempotencyKey | string | External ID generated by the merchant while creating the fiat order through API. |
| currency | string | Cryptocurrency of this order. |
| type | string | Event type. |