The Data Ingestion API is a REST API that's responsible for importing data from your payment processors, then manipulating and storing the information in Pagos' database. This guide outlines the process to integrate with the Data Ingestion API:
- Authenticating with the API
- Running a health check
- Sending data to Pagos
Authenticating
The Pagos platform uses API Keys to authenticate requests to all our services. To access the API, you must authenticate via Bearer Authentication (e.g. for a cross-origin request). When you make any API request, pass an Authorization header in the following format:
"Authorization: Bearer <api key>”.
All API requests must be made over HTTPS; calls made over plain HTTP will fail. API requests without authentication will also fail.
Run A Health Check
You can confirm that you’re able to successfully reach our host by running a health check on POST: /healthcheck.
Sending Data
You can directly submit transaction information to our systems by making an HTTPS request to the transaction resource of the Pagos APIs. The request will be in type application/json.
Submit your payments data on POST:
Best Practices:
- Ensure data objects are well-structured and valid.
- Handle API rate limits and retries in your application.