Transaction Search & Reporting

In addition to processing payments, the E-xact API allows for the querying of historical data and the generation of structured reports.

🚧

Important: User Credentials Required

The Search & Reporting endpoints DO NOT use your standard Gateway ID and Terminal Password.

To use these features, we recommend using a special Read Only API user generated from the Realtime Payment Manager (RPM) portal.

Why use a Read Only API User?

• API-Only: This user has no access to the RPM portal's web interface.
• Non-Expiring Token: Instead of a password that requires rotation, this user generates a token that doesn't expire, making it ideal for continuous API integrations.
• Restricted Access: It is restricted strictly to search and reporting functions.

Creating a Read Only API User

To set up your API user and generate your token:

1. Log into your RPM portal and navigate to the Users tab.
2. Select the option to create a new user and go to the Login tab.
3. In the Role dropdown menu, select Read Only API.
4. Enter a username in the Login field.
5. Click the Generate link next to the Token / Fingerprint (SHA-256) field to create your non-expiring token. (Note: Store this token securely; it acts as your password for API requests).
6. Record the keys now. Once saved you will only see the key digest—the original key cannot be revealed.
7. Click Create to save the user.

Once created, use this specific Login and Token to authenticate all your Transaction Search and Reporting API requests.

Searching Transactions

The /transaction/search endpoint allows you to filter your processing history by date, amount, status, or specific customer fields.

🚀

Try it Now: > View the Search API Reference & Interactive Console

Common Search Scenarios

Pagination

The API returns a maximum number of rows per request. Use the offset parameter to page through results.

• Request 1: offset=0 (Returns rows 0-49)
• Request 2: offset=50 (Returns rows 50-99)

Generating Reports

The /transaction/report endpoint provides aggregated views of your data, useful for bank reconciliation and accounting.

🚀

Try it Now: View the Reports API Reference & Interactive Console

💡

Developer Tip:

If you are building an automated reconciliation tool, we recommend using the closed_batches report via the API to automatically match Gateway totals with your bank deposits.