Three records, three purposes
Do not treat a funding instrument as proof that funds arrived, or a detected deposit as spendable.
Only the wallet’s
available amount can fund a new operation.
Before you fund
- Confirm you are using the login or API key for the intended tenant account.
- Read the effective rails, assets, and networks.
- Fetch the current instructions instead of storing a screenshot or retyping them.
- For stablecoin, match both the asset and network exactly.
Fund with AUD or stablecoin
- AUD
- Stablecoin
1
Get AUD instructions
List the account’s funding instruments. Provision an AUD instrument only when a suitable one
does not already exist. It returns the BSB, account number, account name, and any required
payment reference.
2
Send the payment
Pay the exact issued instructions from the approved source. Preserve your own payment
reference so your operations team can match it later.
3
Wait for the credit
Wayex detects and matches the pay-in, applies any configured inbound fee, then credits the
net amount when it is usable. Until then it remains pending or held.
Provision funding instructions
Creating instructions does not move money. Use one idempotency key for the logical provisioning request and keep it stable across retries.Gross, fee, and net credit
Incoming-funding records separate the amount received from the amount credited:Funding states
Pending money must remain visible as pending. If provider data is stale or unavailable, do not render
it as zero and do not submit work based on a guessed balance.
Read the balance safely
available, reserved, pending, and asOf. A later
write can still be rejected if another accepted operation reserves funds first.
Read incoming funding
Wayex creates pay-in and deposit records from provider activity. Clients neverPOST a pretend
incoming payment.
GET /v1/treasury/payins/{id} or GET /v1/treasury/deposits/{id} for the current reason, next
action, source references, gross/fee/net amounts, and linked movement. A stable deposit also shows the
transaction reference and whether required finality was reached.
Funding instruments have matching list, get, create, and deactivate operations. Deactivation stops
normal new use but preserves historical pay-ins, deposits, and wallet movements.
Webhooks and retries
Usetreasury.payin.updated and treasury.deposit.updated to trigger a fresh funding-resource read,
and use treasury.wallet.updated to refresh balances. Webhooks are at-least-once and unordered:
deduplicate by eventId, then fetch the current record rather than applying events as an ordered
ledger.
GET requests can be retried with backoff. For funding-instrument creation or deactivation, retry the
same payload with the same Idempotency-Key. Never create a second instrument merely because the
response was lost.
Read Operations and reconciliation before moving from test
funding to live-value operations.
