Skip to main content
GET
Get an AUD payout

What this endpoint does

Returns the authoritative amount, fee, reservation, beneficiary, references, and lifecycle for one AUD payout.

When to use it

Use it after a webhook, timeout, hold, return, or support question to determine the current payout outcome.

Before you call

Authenticate with treasury:read and pass a payout 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

Read the status, reason, reservation state, and next action together. Never infer settlement from accepted or submitted.

Safe retries

GET requests are read-only and may be retried with normal exponential backoff. Do not send an Idempotency-Key. Read Beneficiaries and payouts 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

200 - application/json
id
string
required
Minimum string length: 1
clientId
string
required
Minimum string length: 1
beneficiaryId
string
required
Minimum string length: 1
amount
object
required
fee
object
required
sourceDebit
object
required
status
enum<string>
required
Available options:
accepted,
held,
submitted,
settled,
failed,
returned
configurationId
string
required
Minimum string length: 1
externalReference
string
required
Minimum string length: 1
purpose
string
required
Required string length: 1 - 255
reservation
object
required
nextAction
enum<string>
required
Available options:
none,
wait_for_settlement,
contact_support,
retry_new_request,
review_balance
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
walletProviderReference
string
Minimum string length: 1
downstreamMerchantReference
string
Minimum string length: 1
evidenceId
string
Minimum string length: 1
providerReference
string
Minimum string length: 1
statusReason
string
Minimum string length: 1