Skip to main content
POST
Preview an AUD payout

What this endpoint does

Calculates the effective payout fee, total AUD source debit, current eligibility, and any hold reason without creating an operation.

When to use it

Call it after the user enters the payout and before showing the final review screen. Submit the same intent to the create endpoint only after confirmation.

Before you call

Use a secret API key with treasury:write. The saved beneficiary must be active. You may select an existing evidenceId; otherwise Wayex uses the beneficiary’s newest accepted, unexpired evidence when policy requires it.

Money and balance effect

Previewing does not reserve, debit, or send AUD. The returned source debit and canProceed value are advisory until the create request atomically rechecks policy and reserves funds.

States and completion

canProceed reports current static eligibility. A holdReason explains a current block or review path; the final create response remains authoritative under concurrent balance and provider changes.

Safe retries

Send a unique Idempotency-Key for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out. Read Beneficiaries and payouts for the complete workflow.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required

A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.

Required string length: 8 - 255

Body

application/json
beneficiaryId
string
required
Minimum string length: 1
amount
string
required
Pattern: ^\d+(\.\d+)?$
currency
enum<string>
required
Available options:
AUD
externalReference
string
required
Minimum string length: 1
purpose
string
required
Required string length: 1 - 255
walletProviderReference
string
Minimum string length: 1
downstreamMerchantReference
string
Minimum string length: 1
evidenceId
string
Minimum string length: 1

Response

200 - application/json
principal
object
required
fee
object
required
sourceDebit
object
required
asset
enum<string>
required
Available options:
AUD,
USDC,
USDT
configurationId
string
required
Minimum string length: 1
canProceed
boolean
required
network
enum<string>
Available options:
ethereum,
base,
arbitrum,
optimism,
polygon,
bsc,
avalanche,
solana,
tron
holdReason
string
Minimum string length: 1