Skip to main content
GET
Returns your withdrawal whitelist: approved wallet addresses (where funds may go) and approved IP entries (where a withdrawal may be requested from). Outbound money always goes to a whitelisted address — withdrawals, auto-withdrawal rules and mass payouts all check this list server-side — so this list is the gate for all egress (outbound money movement).
The example shows a merchant with no whitelist entries yet.

Authorization

Dashboard-only (JWT session). Roles: merchant_admin / merchant_member / super_admin, with team permission whitelist:view. No API-key scope reaches this endpoint — calling it with an API key fails with 401 {"error":"Invalid or expired token"} (the key is not a JWT). This endpoint takes no parameters — the whitelist scope is inferred from your dashboard session.

Response

Errors

See also

Both halves are enforced, on opposite conventions. Wallet entries decide where funds may go: a withdrawal destination must match a whitelisted (currency, address, tag) triple, and an empty wallet list means no withdrawals at all. IP entries decide from where a withdrawal may be requested, and an empty IP list means no restriction — it only becomes an allowlist once you add the first entry. See Add IP address.