Skip to main content
GET
TypeScript

Autorizaciones

Authorization
string
header
requerido

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

crypto_wallet:swap
crypto_wallet:manage
payout:transfer_funds
payout:withdraw_funds

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de ruta

id
string
requerido

Swap ID returned from POST /swaps.

Respuesta

swap status retrieved

account_id
string
requerido

Account that owns the swap: a business ID prefixed biz_, or the user ID for a personal account.

Ejemplo:

"biz_xxxxxxxxxxxxxx"

amount
string | null
requerido

The from_token amount the swap was created to spend, as a decimal string. A swap created with all reports the wallet balance it read. Null for a fiat pair.

Ejemplo:

"0.052341"

id
string
requerido

Swap ID.

Ejemplo:

"vault-swap-cwal_xxxxxxxxxxxxxx"

object
enum<string>
requerido
Opciones disponibles:
swap
Ejemplo:

"swap"

status
enum<string>
requerido

Current swap status. complete and failed are terminal.

Opciones disponibles:
queued,
working,
complete,
failed
Ejemplo:

"failed"

tx_hashes
string[]
requerido

On-chain transaction hashes produced by the swap.

user_id
string | null
requerido

User whose personal account owns the swap, prefixed user_. Null for a business account.

Ejemplo:

null

error
string | null

Latest error returned for a failed swap.

Ejemplo:

"Swap reverted: quoted price moved beyond the slippage tolerance"