Payment operations

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

Reporting range31 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

Example:

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

Report format

Coloumn 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,51175748-e1c6-4bd5-a45e-b4e8ed536da7,PIX,4999,4999,BRL,2025-04-02T13:15:07.525Z,2025-04-04T04:42:20.892Z