Skip to main content
GET
Get a payment route

What this endpoint does

Returns configuration and current status for one standing payment route.

When to use it

Use it to display route detail, validate its state, or follow a route reference from a transfer.

Before you call

Authenticate with route read access and pass a route 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

The route status does not describe an individual funding. Read the linked transfer for conversion and settlement state.

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

id
string
required

Response

The payment route.

id
string
required
Minimum string length: 1
counterpartyId
string
required

The client account (counterparty) this route belongs to. For API callers this is always your own account id.

Minimum string length: 1
customerId
string
required
Minimum string length: 1
direction
enum<string>
required
Available options:
aud_to_stablecoin
destination
object
required
status
enum<string>
required
Available options:
active,
inactive
instructions
object
required
createdAt
string<date-time>
required
limits
object