Preview an AUD payout
Pay AUD
Preview an AUD payout
Calculates the effective payout fee, total AUD source debit, current eligibility, and any hold reason without creating an operation.
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 withtreasury: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 andcanProceed 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 uniqueIdempotency-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
Send the same Wayex API key as Authorization: Bearer <key>.
Headers
A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.
Required string length:
8 - 255Body
application/json
Minimum string length:
1Pattern:
^\d+(\.\d+)?$Available options:
AUD Minimum string length:
1Required string length:
1 - 255Minimum string length:
1Minimum string length:
1Minimum string length:
1Response
200 - application/json
Available options:
AUD, USDC, USDT Minimum string length:
1Available options:
ethereum, base, arbitrum, optimism, polygon, bsc, avalanche, solana, tron Minimum string length:
1
