Welcome to the Localpayment API documentation! This guide will help you get started with integrating our API into your platform, enabling you to process and manage online payments seamlessly.
Introduction
The Localpayment API allows you to process and manage any pay-in or pay-out transaction from your website, mobile application, or any other integration where you need to transact.
Our API follows REST principles, using resource-oriented URLs that return JSON-encoded responses and standard HTTP response codes. This makes it easy to understand and integrate with various programming languages and platforms.
Key Features
- Pay-ins and Pay-outs: Accept payments from customers (Pay-in) and send payments to beneficiaries (Pay-out) with various payment methods.
- Multiple Payment Methods: Support for a wide range of payment methods, including credit cards, debit cards, bank transfers, cash payments, and digital wallets.
- International Coverage: Process payments in multiple countries with support for various currencies.
- Security: Securely tokenize sensitive card data to ensure PCI DSS compliance and protect against fraud.
- Testing Environment: A dedicated Stage environment allows you to test your integration without affecting live data or interacting with real bank networks.
- Comprehensive Documentation: Detailed API documentation with examples and use cases to guide you through the integration process.
Integration Environments
Stage
Once you have signed the agreement with Localpayment, we will provide you with your Stage login credentials.
The Stage environment is a safe space for testing your integrations without affecting live data or interacting with real bank networks. It mirrors the Production environment settings, ensuring a smooth transition once your integration is complete.
API Stage URL base:
https://api.stage.localpayment.com
UI Stage URL base:
https://ui.stage.localpayment.com
Production
To access the Production environment and start processing live transactions, you must first complete the homologation, certification, and testing processes. This process ensures that your integration meets our security and functionality standards.
Once you have successfully completed the certification process, we will provide you with your Production credentials.
API Production URL base:
https://api.v3.localpayment.com
UI Production URL base:
https://ui.v3.localpayment.com
Next Steps
- Authentication: Before making any API requests, you need to generate an access token using your Stage or 2. Production credentials. Refer to the Authentication section for detailed instructions.
- Explore the API: Familiarize yourself with the different endpoints and functionalities offered by the Localpayment API. The documentation provides detailed descriptions, request and response examples, and error codes for each endpoint.
- Start Integrating: Begin integrating the Localpayment API into your platform using your preferred programming language. The documentation provides code samples and libraries to assist you with the integration process.
- Test Thoroughly: Test your integration in the Stage environment before going live. This will help you identify and resolve any issues before processing real transactions.
- Certification: Once your integration is complete, submit it for certification to ensure it meets our standards.
- Go Live: Once your integration is tested and approved, you can switch to the Production environment and start processing live payments.
Support
If you have any questions or require assistance during the integration process, please don't hesitate to contact our support team at [email protected]. We are here to help you every step of the way.