Flow Guides
Eight ways money moves. Pick one; it shows the calls
Eight flow guides. Each one shows the calls to make, in order, with one request per step.
| Flow guide | What it does |
|---|---|
| Collections | Get paid by your customers |
| Payouts | Send money to a person or business |
| On-ramp / Off-ramp | Let your users buy or sell crypto |
| Pre-funding | Put your own money on your balance before paying out |
| Settlements | Get collected money into your bank account |
| POBO / COBO | Collect or pay on behalf of your own customers |
| MCA | Hold and convert several currencies in one account |
| Liquidity | Pay out before your funds arrive |
Not sure which you need? Find your business on the Use-Case Guides page.
One endpoint for everything
Every payment is created with POST /v3/orders. The orderType says what you are doing.
orderType | What it does | Guide |
|---|---|---|
payin | A customer pays you | Collections |
gaming | A customer pays you through a wallet in their name | Custodial Wallet |
payout | You pay someone | Payouts |
onramp / offramp | Your user buys / sells crypto | On-ramp / Off-ramp |
fiat_prefund / crypto_prefund | You add your own money | Pre-funding |
swap | You convert money you hold | MCA |
→ Create Order · Get Order · List Orders
Four rules for every order
purposeCodeis required. It says why money is moving. Purpose CodespartnerIdis your own unique reference for the order. Create it before the call and store it.- Put the amount in
sourceordestination, not both.source= spend exactly this.destination= the receiver gets exactly this. - Act only on final statuses. A payment is done at
fund_settledorasset_settled. Not before. Orders & Statuses
Updated 14 days ago
Did this page help you?