Payments

The payment operations report retrieves a list of payment operations that occurred within a defined timeframe and the status of that operation, filtered by the specified operation type - AUTHORIZATION CAPTURE REFUND VOID DISCARD

Report properties

Report Available forOperations performed within the latest 31 days
Report PeriodMax 31 Days
File formatCSV
Report levelMerchant

Request payload

FieldRequiredValuesDescription
operationTypeYesAUTHORIZATION CAPTURE REFUND VOID DISCARDThe type of payment charge operation to be included in the report.
startDateYesExample: "2025-01-01T00:00:00.000Z"The report cutoff start date in ISO 8601 date-time.
endDateYesExample: "2025-01-01T23:59:59.999Z"The report cutoff end date in ISO 8601 date-time.
webhooksUrlNohttps://your-webhooks-notification-url.comThe URL to which the report state changes will be notified along with the download URL

Generating a payment report

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

Sample request:

POST /v1/payment-reports HTTP/1.1
Host: api.sandbox.eu.ppro.com
Content-Type: application/json
Merchant-Id: <Your Merchant Id>
Authorization: Bearer *****

{
    "operationType" : "AUTHORIZATION",
    "startDate": "2025-10-27T00:00:00.000Z",
    "endDate": "2025-10-31T00:00:00.000Z",
    "webhooksUrl": "https://webhook.site/3e5ecbb7-1890-48e7-b908-92c394930932"
}

Sample response:

{
    "id": "report_2JQp13PZnTajblv4xGDZb",
    "status": "PENDING",
    "operationType": "CAPTURE",
    "startDate": "2025-10-27T00:00:00.000Z",
    "endDate": "2025-10-31T00:00:00.000Z",
    "createdAt": "2026-07-23T16:15:32.271Z",
    "updatedAt": "2026-07-23T16:15:32.271Z"
}

Downloading the payment report

The initial status is PENDING. After processing completes, the status changes to PROCESSED, and a downloadUrl becomes available. The downloadUrl is a pre-signed URL that provides temporary, authenticated access to securely download the generated report 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 report endpoint directly, for example: GET /v1/payment-reports/{reportId}.

Sample request:

GET /v1/payment-reports/report_Ro7FnjU0n9skrIu48oKwh HTTP/1.1
Host: api.sandbox.eu.ppro.com
Merchant-Id: <Your Merchant Id>
Authorization: Bearer *****

Report format

Coloum nameTypeDescription
OPERATION_IDstringUnique identifier for the payment operation.
OPERATION_TYPEstringType of operation performed.
AUTHORIZATION CAPTURE REFUND VOID DISCARD
OPERATION_STATUSstringStatus of the operation indicating if the operation succeeded or failed.
PAYMENT_CHARGE_IDstringIdentifier of the associated payment charge.
MERCHANT_IDstringIdentifier of the merchant linked to the payment charge.
MERCHANT_PAYMENT_OPERATION_REFERENCEstringOptional reference provided by the merchant for the operation.
PAYMENT_METHODstringPayment method used (e.g., PIX CARD WERO).
OPERATION_AMOUNTintegerAmount processed in this specific operation, in minor units.
PAYMENT_CHARGE_AMOUNTintegerAmount of the original payment charge, in minor units.
PAYMENT_CHARGE_CURRENCYstringCurrency code in ISO 4217 format.
PAYMENT_CHARGE_CREATED_ATstringTimestamp when the original charge was created in ISO 8601 format.
OPERATION_CREATED_ATstringTimestamp when the operation was executed in ISO 8601 format.

CSV example

OPERATION_ID,OPERATION_TYPE,OPERATION_STATUS,PAYMENT_CHARGE_ID,MERCHANT_ID,MERCHANT_PAYMENT_OPERATION_REFERENCE,PAYMENT_METHOD,OPERATION_AMOUNT,PAYMENT_CHARGE_AMOUNT,PAYMENT_CHARGE_CURRENCY,PAYMENT_CHARGE_CREATED_AT,OPERATION_CREATED_AT
capture_YXXU3dX4ucR45CVm4Ho6V,CAPTURE,CAPTURED,charge_VrbO1tLB2BJMcufJDDHc1,test-merchant,51175748e1c6,WERO,4999,4999,EUR,2025-04-02T13:15:07.525Z,2025-04-04T04:42:20.892Z


Did this page help you?