List all payment method events

get

https://core.spreedly.com/v1/payment_methods/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 Params

order

string

The order of the returned list. Default is asc, which returns the oldest records first. To list newer records first, use desc.

since_token

string

The token of the item to start from (e.g., the last token received in the previous list if iterating through records)

event_type

string

Filter events by event type (e.g., AddPaymentMethod, RetainPaymentMethod, RedactPaymentMethod, ReplacePaymentMethod, UpdatePaymentMethod)

count

string

The number of events to return. By default returns 20, maximum allowed is 100.

include_transactions

boolean

Whether to include gateway transactions alongside events. Default is false. When true, returns a unified timeline of events and transactions sorted by creation time.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Basic

base64

Response

Choose an example:

List events

List events with transactions

application/json

200successful

401Unauthorized