Skip to main content
GET
List direct-route transfers

What this endpoint does

Lists conversions automatically created when customers fund direct payment routes.

When to use it

Use it for transfer search, reconciliation, and monitoring across customers and routes. Narrow server-side with status (one value or a comma-separated list; an unknown value is rejected with 400) and hold_reason (matches the machine code on references.payoutHoldReason or references.lastCaseReason) instead of paging the whole list and filtering client-side.

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

The status field carries the enum values shown in the schema, not display copy. Broadly: awaiting_payin, awaiting_deposit, and the deposit_* states are waiting on funds; awaiting_client_action (client-gated routes only) is waiting on your progress or refund decision; states such as screening, fx_executed, sweeping, pooled, payout_instructed, sending, and refunding are in flight; on_hold, payout_held, and frozen are holds; completed, failed, cancelled, expired, and reversed are terminal. When a completed AUD payout is later returned by the receiving bank the transfer passes through returned and reversing and settles at reversed — treat returned and reversing as in-flight, not as an end state. A refunded client-gated payment takes the same path (refunding, returned, reversing, reversed). Treat only completed as settled — never infer settlement from creation alone.

Safe retries

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

Authorizations

Authorization
string
header
required

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

Query Parameters

customer_id
string
type
enum<string>
Available options:
onramp,
offramp
route_id
string
status
string

Filter by lifecycle status. One value or a comma-separated list (e.g. payout_held,on_hold); each must be a valid transfer status (400 otherwise).

hold_reason
string

Filter to transfers whose references.payoutHoldReason or references.lastCaseReason equals this machine code.

cursor
string
limit
number
Example:

25

sort
enum<string>
Available options:
-created_at,
created_at,
-updated_at,
updated_at
to
string<date-time>

Created at or before this instant (ISO 8601 with offset). Inclusive. 400 if malformed.

from
string<date-time>

Created at or after this instant (ISO 8601 with offset, e.g. 2026-09-01T00:00:00+10:00). Inclusive. 400 if malformed or later than to.

Response

A cursor-paginated page of transfers.

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.