Get a direct-route transfer
Returns the authoritative lifecycle and linked references for one 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 anIdempotency-Key.
Read Activity and history for the complete workflow.Authorizations
Send the same Wayex API key as Authorization: Bearer <key>.
Path Parameters
Response
The transfer with its lifecycle timeline.
- Option 1
- Option 2
Unique identifier for this transfer.
1The client account (counterparty) this transfer belongs to. For API callers this is always your own account id.
1The customer this transfer is for.
1Current lifecycle status. State advances asynchronously, so treat this as the source of truth.
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 - Option 1
- Option 2
Ordered history of the states this transfer passed through, with timestamps.
When the transfer was created (ISO 8601).
When the transfer was last updated (ISO 8601).
offramp - Option 1
- Option 2
Net AUD the customer receives as a decimal string; set once the conversion executes ("0" before).
^\d+(\.\d+)?$AUD The payment route whose funding spawned this transfer.
1Reference to the live price struck at funding; absent until the conversion executes.
1
