Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Bridge transfer details. The source and destination chains are derived from the referenced wallets and must be different. Provide exactly one of destination.walletId or destination.externalWalletId.

Fields required to create a cross-chain bridge transfer.

requestId
string<uuid>
required

Client-supplied idempotency key (UUID). Reusing a value returns the existing bridge.

Example:

"b3d1f2a4-5c6e-4a7b-8c9d-0e1f2a3b4c5d"

amount
number
required

Amount of the source currency to bridge. When the source or destination currency is USDT, the minimum amount is 10.

Required range: 0.000001 <= x <= 999999999
Example:

100

source
object
required

Source of the bridge transfer.

destination
object
required

Destination of the bridge transfer. Provide exactly one of walletId or externalWalletId. The destination chain is derived from the referenced wallet and must differ from the source chain.

requireApproval
boolean

When true, the bridge is held for transfer approval before execution.

Example:

false

Response

Bridge transfer created successfully.

A cross-chain bridge transfer.

id
string

Public ID of the bridge transfer (prefixed with brdg_).

Example:

"brdg_9dQ2mNpXwZ7bV1aLcs3Kf"

requestId
string<uuid>

Client-supplied idempotency key.

Example:

"b3d1f2a4-5c6e-4a7b-8c9d-0e1f2a3b4c5d"

status
enum<string>
Available options:
NOT_INITIATED,
OPEN_QUOTE,
CREATED,
SOURCE_INITIATED,
SOURCE_PENDING,
SOURCE_PROCESSED,
SOURCE_FAILED,
DESTINATION_INITIATED,
DESTINATION_PENDING,
COMPLETED,
DESTINATION_FAILED,
QUOTE_FAILED,
UNKNOWN,
PENDING_APPROVAL,
APPROVED,
REJECTED,
EXPIRED
Example:

"OPEN_QUOTE"

failedReason
string | null
Example:

null

error
string | null
Example:

null

errorDetails
string | null
Example:

null

amount
string
Example:

"100"

source
object

Resolved source of the bridge transfer.

destination
object

Resolved destination of the bridge transfer. One of walletId or externalWalletId is present.

receipt
object

On-chain receipt for the bridge. transactionHash is the final settlement hash. operations contains provider-specific step hashes (for example approve, send, mint, burn, deposit) and is empty until execution begins.

fee
object | null

Developer fee charged for the bridge transfer, or null when no fee applies.

quote
object

Quote information for the bridge transfer.

createdAt
string<date-time>
Example:

"2026-07-01T10:30:00.000Z"

updatedAt
string<date-time>
Example:

"2026-07-01T10:30:00.000Z"