Documentation
OUR SOLUTION
COUNTRIES
CUSTOMERS
CONTACT US
Search…
Documentation
v2.1
dLocal Documentation
Solutions
Payins
Payouts
Direct Issuing
API DOCUMENTATION
Payins API Reference
Payouts API Reference
Environments
Security
Submit a payout
Get balance
Get Payout
Check status
Cancel payout
Release On hold payout
Currency exchange
Notification parameters
Payout Flows
API codes
Direct Issuing API Reference
Products
Smart Fields
GUIDES
API integration guide
PCI Compliance
Google Pay™
Shopify setup
Tienda Nube setup
Lightspeed setup
Reporting
Guides
Other
Dashboard Manual
Changelog
Status Page
Chinese 中文文档
Powered By
GitBook
Environments
Sandbox
There is a test environment available for integration development and testing, which simulates most of the requests and transaction types available in the platform. You can use this environment to ensure your requests are handled accordingly.
The base URL for development is:
https://sandbox.dlocal.com/api_curl/cashout_api
Please note that in the test environment, no transactions will actually be processed.
Mock Sending Payouts in Sandbox
To mock desired responses in sandbox, you need to specify the following inputs in the 'comments' field:
Step to Mock
Payout STATUS to Mock
'comment' Input
R
eceive a success when submitting the payout and a rejection after it was delivered
REJECTED
DELIVERED:8XX *You can select any 8XX error. E.g.: "comments": "DELIVERED:800"
R
eceive a success both when submitting the payout and when checking the status)
COMPLETED
E.g.: "comments": "DELIVERED:COMPLETED"
Production
After the testing phase is successful, you are ready to go live in the production environment.
The base URL for production is:
https://api.dlocal.com/api_curl/cashout_api
API DOCUMENTATION - Previous
Payouts API Reference
Next
Security
Last modified
2mo ago
Copy link
Contents
Sandbox
Production