Test features in the Sandbox

The Sandbox lets you validate the API's main flows without moving real money.

Some features have specific testing procedures, such as manual confirmation of operations, event simulation, or settings exclusive to this environment.

Before you start

Before testing a feature:

1. Create and configure your Sandbox account.
2. Generate an API key for this environment.
3. Confirm that the feature is available for testing.
4. Configure the necessary Webhooks.
5. Use only data intended for validation testing.

See What can and cannot be tested to learn about the Sandbox's coverage and limitations.

Validation flow

A test journey usually follows these steps:

Configure the Sandbox
        ↓
Create the test resources
        ↓
Run the operation
        ↓
Simulate the event
        ↓
Receive the Webhook
        ↓
Validate processing
        ↓
Validate the flow

In addition to the request response, also validate:

• status changes;
• Webhook events;
• error scenarios;
• retries and reprocessing;
• your application's behavior after each event.

Choose the flow you want to test

Financial transactions

• Test transfers
• Simulate bill payments
• Test Pix QR Code payments

Credit card

• Test credit card payments

Subscriptions

• Generate new charges from a subscription

Security

• Test critical actions

Troubleshooting

• 404 error when paying a Pix QR Code without a registered key

Test calls through the documentation

You can also run requests directly from the API reference using a Sandbox key.

This feature can help you:

• validate parameters and payloads;
• check the response format;
• reproduce errors;
• test an endpoint before implementing it in the application.

See how to test calls in the documentation.

Differences from Production

Keep in mind that:

• some operations are simulated manually;
• certain validations may be simplified;
• some features depend on specific settings;
• external integrations may behave differently;
• a feature available in the Sandbox may require enablement in Production.

Validation checklist

Before considering a flow validated, confirm that:

• success scenarios have been tested;
• the main errors have been handled;
• Webhooks have been received and processed;
• processing is idempotent;
• logs make it possible to identify failures;
• the differences between Sandbox and Production have been taken into account;
• no credentials or fictitious information will be carried over to Production.

Next steps

• See what can be tested
• Add balance to the Sandbox account
• Set up your Sandbox account
• Test calls in the API reference