Skip to main content
PUT
Update tenant treasury settings

What this endpoint does

Sets the tenant-wide payout remitter default: wayex shows “Wayex” as the remitter on AUD payouts, while tenant shows your onboarded company name. The choice is constrained to those two values — it is never free text.

When to use it

Set it during onboarding, or whenever you want subsequent payouts to default to a different remitter. Each payout request can still override the default per payout.

Before you call

Use a secret API key with treasury:write. The onboarded company name used by the tenant option comes from your account profile and cannot be edited through this endpoint.

Money and balance effect

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

States and completion

The new default applies to payouts created after it is set; it does not change the remitter recorded on payouts already submitted.

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

Body

application/json
payoutRemitter
enum<string>
required
Available options:
wayex,
tenant

Response

200 - application/json
payoutRemitter
enum<string>
required
Available options:
wayex,
tenant
tenantRemitterName
string
required
Minimum string length: 1
poboEnabled
boolean
updatedAt
string<date-time>