List payment charges

get

https://api.sandbox.eu.ppro.com/v1/payment-charges

Returns all payment charges that match the given search criteria.

Query Params

merchantPaymentChargeReference

string

Filters the results to the payment charge with the given merchant-defined reference.

agreementId

string

Filters the results to the payment charges linked to the given payment agreement.

page

string

The opaque cursor used to fetch the next page of results. Use the nextPage value returned in a previous response. Omit to fetch the first page.

sortDirection

string

enum

Chronological sort direction of the results. ASC returns the oldest results first, DESC returns the newest results first. Absent or empty values default to ASC. Values are case-sensitive (uppercase only).

Allowed:

Headers

Merchant-Id

string

required

The merchant identifier.

Request-Reference

string

Unique request reference to facilitate debugging.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

409Duplicate request received with the same idempotency key.

504Call to the upstream dependency timed out.