POST
Quote a PIX cash-out fee

Authorizations

Authorization
string
header
required

Authorization: Bearer cl_test_sk_... (sandbox) or Bearer cl_live_sk_... (live). A live key additionally needs production enabled by the workspace owner. Using a live key against the sandbox path revokes it on sight (leak signal); a sandbox key on live is refused and logged, but not revoked.

X-Workspace-Id
string
header
required

The workspace (tenant) UUID. Always required, including on session-authenticated dashboard calls.

Path Parameters

env
enum<string>
required

test is also accepted on the wire as an alias of sandbox; the key prefix must match (cl_test_sk_ for sandbox/test, cl_live_sk_ for live).

Available options:
sandbox,
live

Body

application/json

Both fields are optional digit amounts; omit either to get a 0 for it.

amount_minor

The amount a withdrawal would send.

Pattern: ^[0-9]{1,16}$
budget_minor

The most the customer can debit; used to compute max_minor.

Pattern: ^[0-9]{1,16}$

Response

OK

data
object
required

What a PIX withdrawal costs before sending — the same schedule the actual payout holds.