POST
Simulate PIX cash-in settlement

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.

Headers

X-Subaccount-Id
string<uuid>

Wallet-as-a-service: act on one of the caller's own sub-accounts (its ledger, parties and wallets) instead of the workspace itself. Only valid on balances/wallets/transactions/statement/crypto/pix/payment-links/rfq routes, only for a workspace-level caller (not a party-scoped key), and only for a sub-account the caller's workspace owns.

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
id
string<uuid>
required

Payment id.

Body

application/json

Sandbox only. Any body other than {"status":"failed"} settles the payment as completed.

status
enum<string>
default:completed
Available options:
completed,
failed
reason
string

Stored as failure_reason when status is failed.

tx_hash
string

Crypto send only; a mock hash is generated when omitted.

Response

OK

data
object
required

A payment intent / ledger-facing operation: a PIX cash-in or cash-out, a crypto send, or an RFQ settlement. Exact fields vary by kind.