Reports are designed to support your business operations and provide valuable insights into your payments and performance.

Available reports

Generate a report

To generate a report, send a POST request to /v1/payment-reports with the appropriate payload parameters for the desired report.

Request:

{
  "operationType": "CAPTURE",
  "startDate": "2025-04-04T00:00:00.000Z",
  "endDate": "2025-04-04T23:59:59.999Z",
  "webhooksUrl": "https://your-webhooks-notification-url.com"
}

Response:

{
    "id": "report_WcJcFBw77BfGezmxJM9i5",
    "status": "PENDING",
    "operationType": "CAPTURE",
    "startDate": "2025-04-04T00:00:00.000Z",
    "endDate": "2025-04-04T23:59:59.999Z",
    "createdAt": "2025-10-21T16:37:41.128Z",
    "createdAt": "2025-10-21T16:37:43.128Z"
}

Download a report

The initial status is PENDING. After a short processing period, the status transitions to PROCESSED, and a downloadUrl is provided. This URL is a pre-signed link that grants temporary, authenticated access to securely download the generated report file from storage.

📘

Note

Download links remain valid for 2 hours after the report is generated. Once the link expires, a REPORT_EXPIRED webhook is dispatched, and the report status is updated to EXPIRED.

You can retrieve the downloadUrl in one of two ways:

• From the REPORT_PROCESSED webhook payload, if you’ve configured a webhooksUrl (either dynamically in the request or via a static setting).
• By querying the /v1/payment-reports/{report-id} endpoint directly.

Request

GET /v1/payment-reports/{report-id}

Response

{
    "id": "report_WcJcFBw77BfGezmxJM9i5",
    "status": "PROCESSED",
    "operationType": "CAPTURE",
    "startDate": "2025-04-04T00:00:00.000Z",
    "endDate": "2025-04-04T23:59:59.999Z",
    "contentLength": 228293,
    "downloadUrl": "https://ppro-512254277680-payment-reports-prod.s3.eu-central-1.amazonaws.com/report_WcJcFBw77BfGezmxJM9i5",
    "createdAt": "2025-10-21T16:37:41.128Z",
    "updatedAt": "2025-10-21T16:37:43.747Z"
}