v2

latestOpenAPI 3.1.02026-08-0513206146.6 KB
Routes

List Routes

<Callout intent="warning"> The endpoints exposed here are currently in **Beta**! As we continue to build our initial offering, these endpoints may implement breaking changes. Be sure to check back for our change log regularly as a precaution. </Callout>

Return every route on the authenticated organization. Each route includes the full instructions block so callers can resolve memos and mint/redeem addresses without an additional retrieve.

Narrow the list with fromCurrency, toCurrency, toChain, and toAccountId; every filter you send must hold (see Filtering list endpoints). toChain matches on-chain destinations only, so a redeem-to-fiat route never matches it.

get/v0/routes

Query parameters

cursorstring

Opaque pagination cursor. Pass the nextCursor from the previous response; omit to fetch the first page.

limitinteger

Page size. Defaults to 50; capped at 200.

fromCurrency'ausd' | 'stablecoin' | 'usd'

Return only routes with this source currency. The stablecoin wildcard matches routes stored against the wildcard; it does not expand to the individual stablecoins it covers.

Return only routes with this source currency. The stablecoin wildcard matches routes stored against the wildcard; it does not expand to the individual stablecoins it covers.

toAccountIdstring uuid

Return only routes pointing at this registered account. A well-formed id belonging to another organization, or to nothing, returns an empty page rather than an error.

toChainV0RoutesGetParametersToChainSchemaItems[]

Return only routes landing on any of these chains, comma-separated. Fiat and wire destinations carry no chain and are never matched by this filter.

toCurrency'ausd' | 'usd' | 'usdc'

Return only routes with this destination currency.

Return only routes with this destination currency.

Headers

Authorizationstring required

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

See Authentication for more details.

Response

OK

nextCursorstring nullable required

Opaque cursor for the next page. Pass back verbatim as the cursor query param to fetch the next page; null when no more results.