Skip to navigation

Create a Route

Create a persistent source → destination route. The response includes reusable settlement instructions — a wire memo for fiat sources, or one mint or redeem address per supported chain for blockchain sources — that the caller uses to initiate transfers. A single set of instructions is valid indefinitely; every inbound transfer matching them triggers a separate settlement to the route’s destination.

The route topology is determined by from.currency, to.currency, and the destination to.chain. to.accountId references a registered account from GET /v0/accounts.

No US dollars move in the sandbox. Fiat routes return fake wire instructions so you can build fiat flows. Never send a real wire to them. To test a mint, simulate the wire with POST /v0/sandbox/wires.

Supported topologies

from.currencyto.currency (+ to.chain)Behavior
usdausd on a chainMint from simulated USD. Never send a real wire.
ausdusd (bank account)Redeem to simulated USD. No payout is sent.
ctkausd on a chainMint with stablecoins: send ctk to the mint address, receive AUSD at the destination.
ausdctk on a chainRedeem to tokens: send AUSD to the redeem address, receive ctk.

Authentication

AuthorizationBearer

Session JWT from POST /v0/auth/token, sent as Authorization: Bearer <sessionJwt>.

See Authentication for more details.

Request

This endpoint expects an object.
fromobjectRequired
toobjectRequired
namestringOptional<=200 characters

Response

The route already existed, so nothing was created and the stored route is returned.
idstringformat: "uuid"

Deterministic route UUID; same canonical inputs always derive the same id.

createdAtdatetime
directionenum
Which of the four flows this route is.
Allowed values:
toobject
instructionslist of objects

Next-step instructions. Mint-fiat: one wire instruction with memo + beneficiary. On-chain directions: one deposit address per supported chain, alphabetical by chain.

namestring or nullOptional

User-set label, or null when unset.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error