v3

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0162167359.9 KB
Balance

Get payout quote

Get quote for payout to contact. Auto-detects payment channel (IBAN/onchain/internal).

post/api/v1/balance/payout/quote

Headers

x-api-keystring nullable

Request body

contactIdstring uuid required
amountnumber required
swapType'EXACT_INPUT' | 'EXACT_OUTPUT' | 'FLEX_INPUT' | 'ANY_INPUT'

Type of swap quote.

Response

Successful Response

quoteIdstring required
providerstring nullable
paymentChannelstring required
fromAmountnumber required
fromCurrencystring required
toAmountnumber required
depositMemostring nullable
toCurrencystring required
feeAmountnumber nullable
feeCurrencystring nullable
ratenumber nullable
expiresAtstring date-time nullable
maskedIbanstring nullable
depositAddressstring nullable
recipientAddressstring nullable
originChainIdstring nullable
destinationChainIdstring nullable
transactionRequestobject nullable