Testing environment
Simulate Pix Automático transactions and ensure a seamless integration.
The dLocal sandbox environment enables the simulation and testing of various Pix Automático workflows and scenarios, including enrollments with and without initial payments, recurring payments, and retrieval of enrollment details.
It is designed to help understand how the Pix Automático solution works, ensuring proper preparation for the official service launch.
According to the Central Bank’s schedule, the expected go-live date for Pix Automático is June 16, 2025.
Sandbox
A test environment is available for integration development and testing, simulating most of the requests and transaction types. Use this environment to ensure your requests are handled properly accordingly.
Please note that in the test environment no transactions will actually be processed.
Use cases
One-time user enrollment
Simulate the creation of a new enrollment with or without an initial payment
Operation | Status | Endpoint | Test scenarios | Example request |
---|---|---|---|---|
Enrollment with no initial payment | Available | /enrollments | Successful enrollment creation with no initial payment. - Manage fixed / variable amounts - Manage different frequencies - Manage with and without dates Failed enrollment creation (e.g., without CPF or CNPJ, invalid dates, invalid currency). | See example code |
Enrollment with an initial payment | Available | /payments | Successful enrollment creation with an initial payment. - Manage fixed / variable amounts - Manage different frequencies - Manage with and without dates - Payment amount <> subscription amount / range Failed enrollment creation with initial payment (e.g., without CPF, invalid dates, invalid currency). | See example code |
Enrollment information
Simulate retrieving enrollment information.
Operation | Status | Endpoint | Test scenarios | Example request |
---|---|---|---|---|
Get enrollment details | Available | /enrollments/{id} | Successfully get enrollment details with all data and different statuses (PENDING , ACTIVE , etc). Error simulation (e.g., invalid enrollment_id ). | See example code |
Recurring payments
Simulate the process of creating a new recurring payment.
In the description
body parameter of the payment request, you can include the error code to which you want the payment to result. For example, the description: 302
will result in the payment being rejected with the error “Insufficient Amount."
Operation | Status | Endpoint | Test scenarios | Example request |
---|---|---|---|---|
Recurring payments | Available | /payments | Successful recurring payment. Payment failed if enrollment is not valid Rejection simulation is based on the status code included in the description parameter in the request. | See example code |
Coming soon: retry and enrollment cancellation flows will be available.
Updated 9 days ago