v1
latestOpenAPI 3.1.02026-07-2484125489.6 KBList all payment method events
Retrieve an ordered and paginated list of all payment method events in the authenticated environment.
Payment method events track important changes to payment methods such as creation, retention, redaction, and other lifecycle events. This endpoint allows you to retrieve these events with optional filtering and pagination.
Response Format
The response format varies by event type:
- AddPaymentMethod events are returned as transaction objects with embedded payment method data
- All other events are returned as payment_method_event objects
Query parameters
The order of the returned list. Default is asc, which returns the oldest records first. To list newer records first, use desc.
The token of the item to start from (e.g., the last token received in the previous list if iterating through records)
Filter events by event type (e.g., AddPaymentMethod, RetainPaymentMethod, RedactPaymentMethod, ReplacePaymentMethod, UpdatePaymentMethod)
The number of events to return. By default returns 20, maximum allowed is 100.
Whether to include gateway transactions alongside events. Default is false. When true, returns a unified timeline of events and transactions sorted by creation time.
Response
successful