Skip to main content
POST
Deactivate Treasury funding instructions

What this endpoint does

Deactivates a reusable funding instrument without deleting its historical funding links.

When to use it

Use it when instructions must no longer be shown or used for new funding.

Before you call

Use a secret API key with treasury:write and pass an active funding-instrument ID owned by this tenant account.

Money and balance effect

This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.

States and completion

Deactivation prevents normal new use but does not erase incoming funding or wallet movements already linked to the instrument.

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

Path Parameters

id
string
required

Response

200 - 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>