Skip to main content
GET
List a customer’s payment routes

What this endpoint does

Lists standing payment routes owned by one customer.

When to use it

Use it on customer detail pages or before deciding whether another route is needed.

Before you call

Authenticate with route read access and pass a customer ID owned by the same tenant account.

Money and balance effect

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

States and completion

Route states indicate availability; individual funding and settlement states belong to 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>.

Path Parameters

customerId
string
required

Query Parameters

cursor
string
required
limit
string
required

Response

A cursor-paginated page of the customer's 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.