Skip to main content
POST
Deactivate a Treasury beneficiary

What this endpoint does

Deactivates a beneficiary for new payouts without deleting its identity or payout history.

When to use it

Use it when a recipient should no longer be selectable, such as after destination details change.

Before you call

Use a secret API key with treasury:write and pass an active beneficiary 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 blocks new payout use. Existing accepted or historical payouts keep their original beneficiary snapshot and continue through their real lifecycle.

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

Path Parameters

id
string
required

Response

200 - application/json
id
string
required
Minimum string length: 1
clientId
string
required
Minimum string length: 1
externalReference
string
required
Minimum string length: 1
destination
object
required
status
enum<string>
required
Available options:
active,
inactive
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
type
enum<string>
required
Available options:
individual
firstName
string
required
Minimum string length: 1
lastName
string
required
Minimum string length: 1
dateOfBirth
string
required
address
string
required
Minimum string length: 1
partyContext
object
deactivatedAt
string<date-time>