Sign in
PaymentMethods

List Payment Methods

This endpoint retrieves a list of all payment methods.

get/customers/payment-methods

Query parameters

customer_idstring uuid

Filter payment methods that belong to the given customer ID

type'card' | 'direct_debit'

Filter payment methods by type (e.g., card, direct_debit)

processor'stripe' | 'adyen' | 'manual'

Filter payment methods by the processor that issued them. Most integrators don't need this filter — payment-method handling is abstracted at the order-payment layer.

status'pending' | 'active' | 'revoked'

Filter payment methods by status (e.g., active, revoked)

membership_payment_methodstring

Filter payment methods that are used for memberships

for_barcodeboolean

Filter payment methods that are associated with barcodes (wearable devices)

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The PaymentMethods were successfully retrieved

Example response

{
  "data": [
    {
      "payment_method_id": "pm_3K6a0RGysTOePye00nkob5Pi",
      "name": "My debit card",
      "status": "revoked",
      "cardholder_name": "Jane Doe",
      "card_brand": "amex",
      "card_country": "gb",
      "card_funding": "credit",
      "card_expiry": "08/22",
      "last_4": "1234",
      "processor": "stripe",
      "created_at": "2025-01-01T00:00:00+00:00",
      "updated_at": "2025-01-01T00:00:00+00:00",
      "revoked_at": "2025-01-01T00:00:00+00:00"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes