Get Aera's transaction, terminal estate and settlement reports into your own systems.
The Reporting API sends Aera's reports to your own systems, such as your finance system, ERP or data warehouse. You don't need to check for new reports: Aera sends a webhook when a report is ready, and you fetch the data as CSV.
How it works
- Aera tells you a report is ready. Aera sends the New report webhook to your URL. It has the report type and one
fileIdper batch. - Get an access token. Call Get access token for reporting.
- Get the data. Call Get report data once for each
fileId. You get the report as CSV.
Reports you can get
reportType | Report |
|---|---|
TRANSACTION | Daily transaction report |
TERMINAL_ESTATE | Terminal estate report |
SETTLEMENT | Settlement report |
SETTLEMENT_WITH_FEES | Settlement with fees report |
Before you start
| You need | Where |
|---|---|
| Reporting API credentials | Get access |
| A webhook URL registered with Aera | Get reports through the API |
| The test and production hosts | Environments |
| A way to check that webhooks come from Aera | Signatures and security |
| What response codes mean | Errors and response codes |
Setting up reports for the first time?Follow the guide, step by step: Get reports through the API.