Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Swaps

Create Swap

Swaps one token for another from the account's wallet, or converts between currencies to pay off a negative balance. Crypto swaps finish in the background — check the swap for its status.

post/swaps

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring required

Business or user account ID (biz_* / user_*).

amountstring nullable

Source token amount. Required for crypto swaps. Optional for fiat pairs: the portion of the negative to_token balance to repay, which must not exceed the debt; omit to repay the full debt.

from_tokenstring required

Source token contract address or ticker symbol, such as "USDT".

slippage_bpsinteger nullable

Maximum slippage tolerance in basis points.

to_tokenstring required

Destination token contract address or ticker symbol, such as "XAUT".

Response

swap created

account_idstring required

Account ID that owns the wallet used for the swap.

amount_innumber nullable

Fiat pairs only: amount of the funding currency converted. Null while a stablecoin repayment is processing.

amount_outnumber nullable

Fiat pairs only: amount credited in the repaid currency. Null while a stablecoin repayment is processing.

amount_out_expectedstring

Expected destination token amount.

amount_out_minstring

Minimum destination amount after slippage.

idstring

Swap ID. Poll GET /swaps/:id for status.

object'swap' required
ratestring

Quoted exchange rate used to create the swap.

status'queued' | 'working' | 'complete' | 'failed' required

Swap status. Crypto swaps start queued; fiat conversions return complete, or working while a stablecoin repayment settles.

to_chainstring

Destination chain for the swap.