Overview
The sandbox base URL ishttps://api.sandbox.tracefinance.com. It runs the same state machines as production, so most requests follow the happy path by default: beneficiaries approve, payment instructions clear, and operations settle.
To exercise the other branches, the sandbox recognizes a set of deterministic magic values and triggers. Sending one forces a specific compliance or settlement outcome without waiting for a real upstream error, so you can develop and verify each path during homologation. The sections below list every trigger, grouped by the resource it acts on.
To build the webhook handler that receives the resulting events, see Test webhooks in sandbox.
Beneficiaries
A beneficiary you create auto-approves by default. Use the triggers below to force other outcomes.Force the pending state
Sendentity.address.addressLine2 containing no-auto (case-sensitive, substring match) to keep the beneficiary in its initial pending state. Use this to validate UI states, polling, and webhook delivery before the decision lands.
Force a rejection
Send any of the following values to receive a rejected beneficiary.Pix payment instructions
A Pix instruction either approves (auto-approves in sandbox, behind a real compliance review in production) or rejects after the review settles. Once approved, the customer’s withdrawal against the instruction either completes or fails on the rail. The triggers below let you exercise both terminal-failure paths from your integration without waiting for real upstream errors.Force a payment-instruction rejection
Use this trigger to develop and verify yourBENEFICIARY_PAYMENT_INSTRUCTION_REJECTED handler. Submit a POST /v1/beneficiaries request with the magic dict key on the Pix payment instruction:
201 Created with the new instruction in PENDING_REVIEW, the same shape as a normal submission. Shortly after, the BENEFICIARY_PAYMENT_INSTRUCTION_REJECTED webhook arrives with the rejection on the affected instruction:
Force a withdrawal failure
Use this trigger to develop and verify yourOPERATION_FAILED handler. Register a beneficiary with any normal dict key so the instruction approves cleanly, then submit a POST /v1/operations/withdrawals request using a quote whose sourceAmount cents select the simulated outcome:
Any other cents value settles the withdrawal normally. The trigger reads
sourceAmount on the outbound withdrawal only, so beneficiary registration is unaffected and an approved beneficiary stays usable across all six triggers.
Quote 500.04 BRL → 500.04 BRL (or any same-asset amount whose cents are .04), then submit the withdrawal against the approved instruction. The endpoint responds 201 Created with the operation in REQUESTED, the same shape as a normal withdrawal. Shortly after, the OPERATION_FAILED webhook arrives with the matching reason on currentState:
Crypto wallet instructions
Crypto wallets are screened against a real chain-analysis provider in both sandbox and production. There is no sandbox-only mock layer. To simulate a rejected beneficiary, send apaymentInstruction.address that the provider rejects in the real world: for example, an address with an invalid format or checksum, or a publicly known blocklisted address.
The same submission against production returns the same rejection.
Force a custody-attestation document rejection
A crypto beneficiary also submits a custody attestation document. Independently of wallet screening, you can reject the beneficiary through its document check by uploading the attestation with a filename that contains the lowercase wordreject, either inline on POST /v1/beneficiaries or via POST /v1/beneficiaries/{beneficiaryId}/documents.
Put
reject in the file’s name, not its extension, and keep the letters together; a space or symbol between them (rej ect) breaks the match. Any other filename follows the normal screening path.
Deposits
In sandbox, the deposit amount decides its QR code’s outcome:Crypto test tokens
The sandbox uses a fixed set of test tokens for crypto deposits, swaps, and withdrawals. These are mock ERC-20 contracts that Trace Finance controls. They mirror the shape of the real assets but hold no monetary value, so you can move them freely during homologation.Only the
ETHEREUM network is available in the sandbox today. Other networks are not yet supported for sandbox testing.Related
- Environments — sandbox and production base URLs
- Crypto assets and networks — production stablecoins, networks, and contract addresses
- Beneficiaries — what gets screened and what stays on your side
- Register a beneficiary — step-by-step procedure for submitting beneficiaries and payment instructions
- Deposit — end-to-end deposit with a PIX dynamic QR code
- Test webhooks in sandbox — develop and verify webhook handlers