Quick Start

This page helps you quickly access standard or enhanced reports with the Xplor Pay Reporting.

About Xplor Pay Reporting

The Xplor Pay Reporting lets you manage standard and enhanced reports related to merchants, transactions, pricing, disputes, and more.

Prerequisites

To leverage Xplor Pay Reporting, ensure the following prerequisites are met:

A sandbox URL for testing the integration.

API access key issued to you by Xplor Pay.

circle-info

Visit Let's Get Started - Xplor Payarrow-up-right to get a sandbox URL and an API access key.

An active Xplor Pay account.

1

Retrieve the Standard Report via Reporting API

To retrieve the standard report:

  1. Use the GET method.

  2. Send the request to the /data/api/v1.0/{categoryName}/{reportName} endpoint URL.

The following table describes the query parameters to include in the endpoint URL.

Name
Data type
Required?
Description

categoryName

String

Required

The category name of the report. Available category is standard.

reportName

String

Required

The name of the report. See Standard Reporting APIarrow-up-right for more information.

This endpoint returns a successful response, including merchant, transaction, or dispute details in JSON format according to the report type.

2

Download the Enhanced Report via Partner Portal

To download the enhanced report:

  1. Sign in with your Xplor Pay credentials.

  2. On the dashboard, select Reports.

  3. On the Reports page, find the report you want.

  4. Select Generate Report next to the report.

The report downloads in Excel or CSV format.

circle-info

Subscribe to the Xplor Pay Reporting to manage specific reports.

Last updated

Was this helpful?