API Authentication
The OnePay Gateway API utilizes API keys for authentication of requests. API keys are required to access and interact with the API endpoints. Please ensure that you securely manage and protect your API keys, as they grant privileged access to the system. Avoid sharing your API keys with unauthorized individuals.
To authenticate your requests to the API, include the API key in the request headers as specified below. All API requests must be made securely over HTTPS. Requests made without proper authentication will not be processed.
The OnePay API key is provided by OnePay administrators specifically for your developer integration. It must be included in the request header to authenticate your API calls.
Sample API Key: d9694a00-adea-01cb-7a56-c43dd0ebf722
To request a sandbox API key for your development integration, contact [email protected].
Note that the API key is tied to a merchant terminal, and the setup of your merchant terminals will be discussed during the onboarding process.
HTTP Methods Usage
- POST: Use the POST method to create new resources within the collection. When processing transactions, the OnePay gateway expects POST requests from clients.
- GET: Use the GET method to retrieve resource representations or information without modifying them. For retrieving batch details, utilize GET requests.
Request Headers
| Property Name | Required | Type | Description |
|---|---|---|---|
| Content-Type | Yes | String | application/json |
| x-authorization | Yes | String | API Key |
API Endpoints
| Type | URL |
|---|---|
| Payment Transaction | https://api.onepay.com/transaction |
| Customer Management | https://api.onepay.com/customer |
| Tokenization | https://api.onepay.com/token |
| Automated Billing | https://api.onepay.com/billing/plan |
| Batch Reporting | https://api.onepay.com/batch/getBatchDetail |
For sandbox environment, use the following base URL: https://apisandbox.onepay.com
The provided API endpoints gives you access to various features of the OnePay Gateway API, allowing you to process payment transactions, manage customers, set up automated billing plans, retrieve batch details, and generate payment tokens.
If you have any questions or need assistance, reach out to our integration support team at [email protected]. Thank you for choosing OnePay as your payment gateway provider.