ReportingUnifiedPaymentsFilters

Filters for the unified_payments export. All supplied filter groups apply together; multiple values within a group match any listed value.

timezone
Type: string
required

Required IANA time zone name, such as Europe/Sofia.
created
Type: object

Optional payment creation period, up to 366 days. Both bounds are required when this object is present. Requests without a period can be rejected if the export size cannot be estimated. This filters when payments were created, not when a refund or payout occurred.

Properties: 2
facets
Type: array of string

Payment attributes to match. For example, refunded and partially_refunded select payments with refunds; paid_out selects payments marked as paid out. These are payment records, not individual refund or payout objects.
statuses
Type: array of string

Payment statuses to include.
currencies
Type: array of string

Payment currency codes to include.
payment_methods
Type: array of string

Payment methods to include.
operations
Type: array of string

Match each payment's latest operation, not every operation in its history.