Report API access
This page describes who can access the Report API and how. For details on fetching payment data, see the API guide.
Merchants​
ePayment and recurring payment merchants​
Merchants with the Payment Integration or Recurring Payments products can use the Report API with their standard sales unit API keys, which grant access to that single Merchant Serial Number (MSN).
For authentication instructions, see the Quick start.
Donations​
Organizations with the Donations product can use the Report API with their merchant level API keys — the same keys used to authenticate with the Donations API.
For authentication instructions, see the Donations API guide.
VM number​
The Report API cannot be used directly with VM number sales units. If you are a VM number merchant looking to get settlement reports via API, you can designate an accounting partner — they can then use the Report API to retrieve your accounting information on your behalf.
You can also download settlement reports from the business portal.
Partners​
Only accounting partners using accounting keys can access the Report API. Other partner types do not have access.
Accounting partners​
Accounting partners use accounting keys to access this API. The accounting keys give the accounting partner access to all sales units where the merchant has given access to the accounting partner. The accounting keys only give access to the Report API. Accounting partners are not allowed to use the merchant's own API keys.
For authentication instructions, see the Quick start.
Give access to an accounting partner​
Merchants must log in to the business portal to grant an accounting partner access to their sales unit data. This is required because the data may include information regulated under GDPR, and explicit consent is needed before it can be shared.
A merchant can grant access to any number of accounting partners per sales unit, and must specify which ledgers each partner can access. The business portal shows all configured accounting partners for each sales unit:
