For the complete documentation index, see llms.txt. This page is also available as Markdown.

Flow examples

End-to-end walkthroughs of the order shapes the API supports.

Every order has a deposit leg (what comes in) and a payout leg (what goes out). The pair you pick decides the flow. Each walkthrough below runs the same core calls — currencies, limits, KYC, quote, order, confirm — with the values for that pair filled in.

Flow
Deposit leg
Payout leg
Use it when

fiat

crypto

A user pays local currency and receives crypto in their own wallet.

crypto

fiat

A user sends crypto and receives local currency in their bank or mobile money account.

fiat

merchant_balance

A user pays local currency and you are credited in USD. Collections.

merchant_balance

fiat

You spend your USD balance to pay a user in local currency. Payouts and disbursements.

crypto

merchant_balance

A user sends crypto and you are credited in USD.

There is a sixth legal pair, merchant balance to crypto — spending your USD balance to send a user crypto. It works the same way as the others and has no walkthrough of its own yet; follow Merchant balance to Fiat and swap the payout leg for a crypto one.

Which pairs are legal is not guesswork: every entry from Get available currencies carries a pairs array listing the currency types it can be matched with.

Topping up or withdrawing your own balance with crypto is a different mechanism, not one of these order shapes — it runs on its own endpoints under Merchant balance. The difference is which flow the order belongs to: these six are the regular order flow, those are a separate merchant-balance-crypto flow with their own limits and their own approval step.

Before you follow one of these, read Integration guide for the call sequence and Transfer types explanation for what the user has to do once the order exists.