Skip to main content
GET
List payment routes

What this endpoint does

Lists standing customer payment routes for the current tenant account.

When to use it

Use it for route search, monitoring, or locating the route linked to a direct-route transfer.

Before you call

Authenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.

Money and balance effect

This is a read-only request. It does not reserve, debit, credit, or settle money.

States and completion

A route status describes whether it can receive funding. Funding events and their conversion states appear as transfers.

Safe retries

GET requests are read-only and may be retried with normal exponential backoff. Do not send an Idempotency-Key. Read Payment routes for the complete workflow.

Authorizations

Authorization
string
header
required

Send the same Wayex API key as Authorization: Bearer <key>.

Query Parameters

customer_id
string
required
counterparty_id
string

Admin keys only: scope results to the given client account (counterparty). Non-admin callers passing this parameter receive 403 — it is never silently ignored.

cursor
string
required
limit
string
required

Response

A cursor-paginated page of payment routes.

data
object[]
required

The page of results, newest first.

hasMore
boolean
required

Whether a further page exists after this one.

nextCursor
string | null
required

Opaque cursor to pass as cursor to fetch the next page, or null at the end.