Create Bridge Transaction
Initiate a bridge transaction to on-ramp fiat to stablecoin or off-ramp stablecoin to fiat. Bridge transactions are processed in two phases: conversion and delivery.Endpoint
Request Headers
| Header | Required | Description |
|---|---|---|
X-API-Key | Yes | Your API key |
Content-Type | Yes | application/json |
Idempotency-Key | No | Unique identifier for idempotent retries |
Request
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
quote_id | string | Yes | Quote ID from a prior quote request. Locks in rates and fees. |
direction | string | Yes | "onramp" (fiat to stablecoin) or "offramp" (stablecoin to fiat). |
source_currency | string | Yes | Fiat code (onramp) or stablecoin (offramp). |
source_network | string | Conditional | Required if source is stablecoin (offramp). Blockchain network. |
source_address | string | Conditional | Required if source is stablecoin. Wallet to debit. |
destination_currency | string | Yes | Stablecoin (onramp) or fiat code (offramp). |
destination_network | string | Conditional | Required if destination is stablecoin. Blockchain network. |
destination_address | string | Conditional | Required if destination is stablecoin. Wallet to credit. |
destination_account | object | Conditional | Required if destination is fiat. Bank account object: account_holder, account_number, bank_code, country. |
amount | integer (fiat) or string (stablecoin) | Yes | Amount in appropriate unit. |
metadata | object | No | Key-value pairs for your reference. |
Response
Response Fields
| Field | Type | Description |
|---|---|---|
bridge_id | string | Unique bridge transaction identifier. |
quote_id | string | Associated quote ID. |
status | string | Current status: pending, converting, completed, failed. |
direction | string | "onramp" or "offramp". |
source_currency | string | Source currency. |
source_amount | integer | string | Amount in source currency. |
destination_currency | string | Destination currency. |
destination_network | string | null | Destination blockchain (if stablecoin). |
destination_address | string | null | Destination wallet (if stablecoin). |
destination_account | object | null | Destination bank account (if fiat). |
destination_amount | integer | string | Amount in destination currency. |
created_at | string | ISO 8601 timestamp of creation. |
completed_at | string | null | ISO 8601 timestamp of completion. |
Bridge States
| Status | Description |
|---|---|
pending | Bridge transaction initiated. |
converting | Conversion in progress. |
completed | Funds converted and delivered to destination. |
failed | Bridge failed. Check details for reason. |
Notes
- Ensure the quote is not expired before creating a bridge transaction.
- For onramp, provide destination wallet or account details where stablecoins will be delivered.
- For offramp, provide source wallet details where stablecoins will be debited.
- Monitor bridge status via the Get Bridge Transaction endpoint or webhooks.