Skip to main content
POST
Create Treasury funding instructions

What this endpoint does

Provisions reusable AUD funding instructions or a stablecoin deposit address for this tenant account. An AUD instrument returns a BSB and account number and, by default, an email payId to pay into as well — set includePayId to false to skip the PayID.

When to use it

Create one when the account does not already have suitable instructions for the required asset, rail, or network.

Before you call

Use a secret API key with treasury:write. The requested rail, asset, and network must be enabled for this tenant account. includePayId applies to AUD instruments only and defaults to true.

Money and balance effect

Provisioning instructions does not credit the wallet. The balance changes only after Wayex detects, validates, and credits incoming funds.

States and completion

Creation confirms the instrument was issued. A newly issued AUD account or PayID can take a few minutes to become active for NPP; when the response carries an activationMessage, show it and wait for activation before relying on the PayID. Track incoming funds separately and wait for the wallet credit before spending them.

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 Funding and balances 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
type
enum<string>
required
Available options:
aud_account
accountName
string
required
Minimum string length: 1
includePayId
boolean
default:true

Response

201 - application/json
id
string
required
Minimum string length: 1
clientId
string
required
Minimum string length: 1
providerReference
string
required
Minimum string length: 1
status
enum<string>
required
Available options:
active,
inactive
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
type
enum<string>
required
Available options:
aud_account
asset
enum<string>
required
Available options:
AUD
accountName
string
required
Minimum string length: 1
bsb
string
required
Pattern: ^\d{6}$
accountNumber
string
required
Pattern: ^\d{1,9}$
deactivatedAt
string<date-time>
payId
string
Minimum string length: 1
activationMessage
string
Minimum string length: 1