API Reference
  1. OmiCloud Merchant API
  2. Discovery

List executable routes

get
https://sandbox-api.omicloud.io/v1/routes

Everything that can actually be executed for your account right now,
with per-route limits. Call this before rendering an amount field so
you can validate against limits.min / limits.max client-side.

Filters narrow the result; with no filters you get every route.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

deposit — money in from the end user. payout — money out to the end user.

Allowed:
string

Settlement currency code, e.g. USDT.

string

Blockchain network, e.g. TRX. Crypto routes only.

string
enum

Coarse payment family. paymentMethod is the specific rail inside it.

Allowed:
string
length between 2 and 2

ISO 3166-1 alpha-2 country of the end user.

string

Restrict to one gateway id.

Headers
string
^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Dated API version, e.g. 2026-09-01. Omit to use the version your API
key is pinned to. Only one version exists today; send the header
anyway so upgrades are a one-line change.

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
omi_live_… or omi_test_…
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?