Tools and guides for a smooth integration experience.
dLocal offers comprehensive API documentation for developers, including quick-start guides, API references, SDKs, and integration best practices. This resource helps fintech professionals efficiently integrate dLocal's payment API, enabling secure and reliable transaction processing within their applications.
Beginning your integration with the dLocal API is designed to be straightforward. Our quick-start guide walks you through the essential initial steps, ensuring you can access and begin utilizing our powerful payment API without unnecessary delays. The first step involves creating a developer account and obtaining your unique API keys, which are crucial for authenticating all your requests.
Once you have your API keys, you can proceed to make your initial test requests. We provide a sandbox environment that mirrors our production API, allowing you to experiment and validate your integration logic without affecting live transactions. This environment is critical for understanding response structures and error handling before deploying to a live setting. You'll find detailed instructions on how to configure your development environment to interact with our sandbox.
Our documentation includes example code snippets in popular programming languages, demonstrating how to construct basic API calls for common operations like creating a payment or checking transaction status. These examples serve as a practical foundation, helping you understand the expected request formats and how to parse API responses effectively. This quick start ensures you can rapidly move from setup to functional testing.
The dLocal API reference provides a comprehensive catalog of all available endpoints, detailing the specific functionalities offered by our payment gateway API. Each endpoint is meticulously documented, outlining its purpose, the HTTP methods it supports (e.g., GET, POST), and the expected request body parameters. This ensures developers have a precise understanding of how to interact with each part of our system.
This section is your go-to resource for understanding the full capabilities of the dLocal payment gateway API. It covers everything from initiating payments and managing refunds to retrieving transaction history and customer data, providing the granular detail needed for precise integration.
To significantly accelerate your integration process, dLocal provides official Software Development Kits (SDKs) for several popular programming languages. These SDKs encapsulate the complexities of HTTP requests, authentication, and response parsing, allowing you to interact with the dLocal API using native language constructs. This approach reduces development time and minimizes potential integration errors.
Our documentation includes detailed guides on how to install and configure each SDK, along with practical examples demonstrating common use cases. Whether you are working with Python, Java, Node.js, or another language, you will find resources tailored to your development environment. These SDKs are maintained by dLocal and kept up-to-date with the latest API versions and features.
"Using an SDK streamlines API integration by abstracting away low-level network details, letting developers focus on their application's core logic."
In addition to official SDKs, we also highlight community-contributed libraries where available. While not officially supported by dLocal, these can sometimes offer alternative approaches or support for less common languages. We encourage developers to explore these resources, always verifying their compatibility and security before deployment. Utilizing an SDK is often the fastest path to a functional payment API integration.
Our dLocal integration guides delve into specific scenarios and provide in-depth instructions for common use cases. These guides move beyond basic API calls, focusing on how to construct a robust and secure payment solution within your application. Topics covered include detailed explanations of different payment flows, such as single-step and multi-step payments, and how to handle various payment methods supported by dLocal.
These guides also outline best practices for optimizing your dLocal API integration, including strategies for idempotency to prevent duplicate transactions and recommendations for asynchronous processing of webhook notifications to maintain application responsiveness. Following these guidelines will result in a more reliable and efficient payment system.
Effective error handling is critical for any production-ready application integrating with a payment API. The dLocal API returns specific error codes and messages to help you diagnose and resolve issues quickly. Our documentation provides a comprehensive reference of these error codes, categorizing them by type (e.g., validation errors, authentication errors, processing errors) and offering detailed explanations for each.
For each error code, we suggest potential causes and recommended actions to take. This includes guidance on distinguishing between transient errors that can be retried and permanent errors that require user intervention or a change in your request logic. Understanding this distinction is key to building resilient payment flows that minimize disruption for your users.
Our troubleshooting tips extend to common integration pitfalls, such as incorrect data formatting, invalid API keys, or network connectivity issues. We provide debugging strategies, including how to use request IDs for tracing specific transactions in our logs and how to interpret webhook delivery failures. This section aims to equip developers with the knowledge to independently resolve most integration challenges, ensuring a smooth and reliable payment experience for their customers. For general API troubleshooting, Wikipedia's API page offers a good starting point.
dLocal webhooks provide a powerful mechanism for receiving real-time, asynchronous notifications about important events related to your transactions. Instead of constantly polling our API for updates, you can configure your application to listen for these events, such as a payment status change from 'pending' to 'approved' or 'failed', a refund completion, or a chargeback notification. This event-driven approach keeps your application synchronized with the payment platform efficiently.
The documentation details how to set up and verify webhook endpoints in your system. We explain the structure of webhook payloads, including the event types you can subscribe to and the data contained within each notification. Crucially, we provide guidance on implementing signature verification for incoming webhooks to ensure their authenticity and prevent malicious actors from sending fake notifications to your system.
By leveraging dLocal webhooks, you can build responsive applications that react immediately to transaction outcomes. This is essential for updating order statuses, triggering fulfillment processes, or notifying customers without delay. Proper implementation of webhooks is a cornerstone of a modern, efficient fintech developer resource integration, reducing server load and improving overall user experience.
| Feature | dLocal API | Typical Payment Gateway API | Traditional Integration |
|---|---|---|---|
| Integration Complexity | Low-to-Medium (SDKs available) | Medium (requires custom code) | High (manual data exchange) |
| Real-time Updates | Yes (Webhooks) | Often (Webhooks/Polling) | No (Batch Processing) |
| Supported Payment Methods | Extensive local & international | Varies greatly | Limited, country-specific |
| Developer Resources | Comprehensive docs, SDKs, examples | Documentation, basic examples | Minimal, often custom support |
| Security Features | Signature verification, tokenization | SSL, data encryption | Manual security protocols |
dLocal