Skip to main content
GET
Get tenant treasury settings

What this endpoint does

Returns this tenant account’s writable payout preferences — currently the payout remitter default that controls whose name appears on AUD payouts.

When to use it

Read it before showing a payout settings screen, or to confirm the current default before submitting payouts that rely on it.

Before you call

Authenticate with treasury:read. The setting is bound to the tenant account inferred from the API key.

Money and balance effect

This is a read-only request. It does not reserve, debit, credit, or settle money.

States and completion

The response is the current default. Individual payouts may still override the remitter per request, so a payout’s recorded remitter can differ from this default.

Safe retries

GET requests are read-only and may be retried with normal exponential backoff. Do not send an Idempotency-Key. Read Beneficiaries and payouts for the complete workflow.

Authorizations

Authorization
string
header
required

Send the same Wayex API key as Authorization: Bearer <key>.

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>