Webhook events for currency conversion (RFQ) transaction status changes.
Events
| Event Name | Status | Description |
|---|---|---|
conversion.completed | COMPLETED | Conversion executed successfully |
conversion.failed | FAILED | Conversion transaction failed |
conversion.completed
Triggered when a currency conversion is successfully executed.
Payload
{
"event_name": "conversion.completed",
"resource": {
"type": "conversions",
"id": "conv_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"data": {
"status": "COMPLETED",
"customer_id": "cus_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"account_id": "BZ-ABCD-1234",
"transaction_id": "conv_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"created_at": "2024-01-22T12:00:00.000Z",
"modified_at": "2024-01-22T12:00:05.000Z"
}
}Fields
| Field | Type | Description |
|---|---|---|
status | string | Always COMPLETED for this event |
customer_id | string | The customer ID who executed the conversion |
account_id | string | Account ID of the customer |
transaction_id | string | Unique identifier for the conversion transaction |
created_at | string | ISO 8601 timestamp when the conversion was initiated |
modified_at | string | ISO 8601 timestamp when the conversion was completed |
conversion.failed
Triggered when a currency conversion fails.
Payload
{
"event_name": "conversion.failed",
"resource": {
"type": "conversions",
"id": "conv_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"data": {
"status": "FAILED",
"customer_id": "cus_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"account_id": "BZ-ABCD-1234",
"transaction_id": "conv_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"created_at": "2024-01-22T12:00:00.000Z",
"modified_at": "2024-01-22T12:00:05.000Z"
}
}Fields
| Field | Type | Description |
|---|---|---|
status | string | Always FAILED for this event |
customer_id | string | The customer ID who initiated the conversion |
account_id | string | Account ID of the customer |
transaction_id | string | Unique identifier for the conversion transaction |
created_at | string | ISO 8601 timestamp when the conversion was initiated |
modified_at | string | ISO 8601 timestamp when the conversion failed |
Common Failure Reasons
Conversions may fail due to:
- Insufficient balance
- Quote expired
- Market conditions changed
- System errors