Skip to main content
GET
Get a Treasury beneficiary

What this endpoint does

Returns one saved AUD beneficiary and its current eligibility details for this tenant account.

When to use it

Use it before payout review, after an evidence change, or when investigating a beneficiary reference.

Before you call

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

Only an active eligible beneficiary can receive a new payout. Inactive records remain readable for historical operations.

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
externalReference
string
required
Minimum string length: 1
destination
object
required
status
enum<string>
required
Available options:
active,
inactive
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
type
enum<string>
required
Available options:
individual
firstName
string
required
Minimum string length: 1
lastName
string
required
Minimum string length: 1
dateOfBirth
string
required
address
string
required
Minimum string length: 1
partyContext
object
deactivatedAt
string<date-time>