Skip to main content
GET
Get a direct-route transfer

What this endpoint does

Returns the authoritative lifecycle and linked references for one direct-route transfer.

When to use it

Use it after a webhook, when investigating a transfer, or when you need its current settlement state.

Before you call

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

Use the returned lifecycle and reason fields. A held, failed, or returned state is not settlement.

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>.

Path Parameters

id
string
required

Response

The transfer with its lifecycle timeline.

id
string
required

Unique identifier for this transfer.

Minimum string length: 1
counterpartyId
string
required

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

Minimum string length: 1
customerId
string
required

The customer this transfer is for.

Minimum string length: 1
status
enum<string>
required

Current lifecycle status. State advances asynchronously, so treat this as the source of truth.

Available options:
created,
validated,
screening,
fx_executed,
completed,
awaiting_deposit,
deposit_detected,
deposit_confirming,
deposit_cleared,
sweeping,
onforwarding,
payout_instructed,
payout_held,
payout_settled,
awaiting_payin,
payin_cleared,
disbursing,
sending,
send_confirming,
pooled,
on_hold,
frozen,
failed,
cancelled,
returned,
expired,
reversing,
reversed
sourceDepositInstructions
object
required
references
object
required
timeline
object[]
required

Ordered history of the states this transfer passed through, with timestamps.

createdAt
string<date-time>
required

When the transfer was created (ISO 8601).

updatedAt
string<date-time>
required

When the transfer was last updated (ISO 8601).

type
enum<string>
required
Available options:
offramp
source
object
required
destination
object
required
destinationAmount
string
required

Net AUD the customer receives as a decimal string; set once the conversion executes ("0" before).

Pattern: ^\d+(\.\d+)?$
destinationCurrency
enum<string>
required
Available options:
AUD
routeId
string

The payment route whose funding spawned this transfer.

Minimum string length: 1
quoteId
string

Reference to the live price struck at funding; absent until the conversion executes.

Minimum string length: 1
metadata
object