Introduction
Welcome to the Payment Gateway API documentation.
This documentation provides comprehensive information for integrating with the payment gateway, including how to initiate payin and payout transactions, handle notifications, manage supported payment methods, and interpret API response codes.
Overview
The Payment Gateway API enables merchants to process payments and payouts across multiple countries and payment methods. The API is designed to be secure, flexible, and easy to integrate into your application or platform.
Authentication & Headers
All API requests require authentication using HTTP headers. The following headers must be included in every request:
| Header | Description |
|---|---|
| x-api-key | Merchant ID |
| x-api-token | Merchant credential/token |
| x-provider | Payment provider identifier |
- x-api-key: Your unique merchant identifier (ID) provided during onboarding.
- x-api-token: Your merchant credential or token for secure authentication.
- x-provider: The identifier for the payment provider to be used for the transaction. (The actual provider value will be supplied to you; do not share or expose provider details.)
What You'll Find in This Documentation
- Endpoints: Details on how to create payin and payout transactions, including required and optional parameters.
- Payment Methods: Supported payment methods and their parameters for each country.
- Status & Error Codes: Comprehensive lists of possible statuses and error codes for both payin and payout operations.
- Notifications: How to handle and verify asynchronous notifications for transaction status updates.
- Test Data: Example payloads for testing in sandbox environments.
- Bank Codes: Reference tables for bank codes by country.
Getting Started
To begin, ensure you have your merchant credentials and provider information. Review the endpoints section to understand how to initiate transactions, and refer to the test data section for sandbox testing examples.
If you have any questions or require support, please contact your integration manager or support team.