Overview
SportsPay provides three ways to access reporting data — two API-based query calls and one single-sign-on hand-off to PaymentsHQ. Pick based on what you're trying to do.
| Goal | Use |
|---|---|
| Reconcile merchant deposits against your platform's records (deposit totals, dates, and the transactions inside each deposit) | Deposit Query |
| Search transaction history by filters — date range, amount, card, customer, reference — for specific transaction lookups or batch settlement reports | Transaction Query |
| Give a merchant admin direct access to PaymentsHQ from inside your platform, without requiring them to log in separately | Mirror Reporting |
All three are available on every integration method — Direct with Embedded Tokenization, Customized Checkout, and Embedded Components.
API-Based Queries
Deposit Query and Transaction Query both use TYPE=Q and return structured data your platform can store or render however it likes. They're the right choice when:
- You're building a reconciliation job that runs on a schedule.
- You're displaying payment history inside your own UI.
- You need programmatic access to rollups, filters, or historical data.
See Deposit Query and Transaction Query for the specific calls.
Hand-Off to PaymentsHQ
Mirror Reporting generates a one-time redirect URL that authenticates a merchant admin into PaymentsHQ. It's the right choice when:
- You want to offer merchants the full PaymentsHQ UI without rebuilding it.
- You want a "View in PaymentsHQ" button in your platform that opens the same merchant's reporting without a separate login.
See Mirror Reporting for the redirect flow and URL requirements.
Getting Better Reporting Results
The quality of your reporting depends on how well your transactions are tagged when they're submitted. Using INV, REF, DESC, PROGRAM, PLAYER, and ACCOUNT consistently makes deposit and transaction queries much easier to reconcile. See Transaction Tagging and Reporting Fields.
API Reference
For per-call field reference, see:
Errors
For error codes returned by query calls, see Error Codes.
Updated 13 days ago
