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 guideWhat it does
CollectionsGet paid by your customers
PayoutsSend money to a person or business
On-ramp / Off-rampLet your users buy or sell crypto
Pre-fundingPut your own money on your balance before paying out
SettlementsGet collected money into your bank account
POBO / COBOCollect or pay on behalf of your own customers
MCAHold and convert several currencies in one account
LiquidityPay 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.

orderTypeWhat it doesGuide
payinA customer pays youCollections
gamingA customer pays you through a wallet in their nameCustodial Wallet
payoutYou pay someonePayouts
onramp / offrampYour user buys / sells cryptoOn-ramp / Off-ramp
fiat_prefund / crypto_prefundYou add your own moneyPre-funding
swapYou convert money you holdMCA

→ Create Order · Get Order · List Orders

Four rules for every order

  • purposeCode is required. It says why money is moving. Purpose Codes
  • partnerId is your own unique reference for the order. Create it before the call and store it.
  • Put the amount in source or destination, not both. source = spend exactly this. destination = the receiver gets exactly this.
  • Act only on final statuses. A payment is done at fund_settled or asset_settled. Not before. Orders & Statuses

Did this page help you?