Sign in
Payment Methods

Find all Payment Methods

Retrieve a paginated list of Payment Methods

get/payment-methods

Query parameters

eqstring
nestring
likestring
instring[]
ninstring[]
containsstring
eqstring date-time
nestring date-time
gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time
instring[]
ninstring[]
containsstring date-time
eqstring date-time
nestring date-time
gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time
instring[]
ninstring[]
containsstring date-time
eqboolean
neboolean
containsboolean
eqstring
nestring
likestring
instring[]
ninstring[]
containsstring
eqstring
nestring
likestring
instring[]
ninstring[]
containsstring
eqstring
nestring
likestring
instring[]
ninstring[]
containsstring
eqstring
nestring
likestring
instring[]
ninstring[]
containsstring
eqstring
nestring
likestring
instring[]
ninstring[]
containsstring
sortDirection'ASC' | 'DESC' | 'asc' | 'desc'

Sort direction. Defaults to ASC.

sortBy'id' | 'createdAt' | 'updatedAt' | 'isDefault' | 'customer'

Field to sort by. Defaults to createdAt.

pagenumber

Page number for offset pagination. Defaults to 1.

pageSizenumber

Number of items per page for offset pagination. Defaults to 10.

limitnumber

Opts into cursor pagination and sets the page size. When provided, "page"/"pageSize" are ignored and the response returns a "nextCursor" instead of a total count.

cursorstring

Opaque cursor from a previous cursor-paginated response. Used together with "limit" to fetch the next page.

Response

OK

Example response

{
  "pagination": {
    "mode": "offset",
    "pageSize": 10,
    "hasPreviousPage": true,
    "page": 2,
    "itemCount": 11,
    "pageCount": 2
  },
  "data": [
    {
      "createdAt": "2024-02-18T12:00:00Z",
      "updatedAt": "2024-02-21T12:15:00Z",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "id": "pm_2QC7PqoUeOxQEWscJJt6B3PkvyL",
      "type": "card",
      "customer": "cus_2QC7PqoUeOxQEWscJJt6B3PkvyL",
      "card": {
        "brand": "amex",
        "lastFour": "1234",
        "bin": "123456",
        "expMonth": "12",
        "expYear": "2025",
        "cardholderName": "John Doe"
      },
      "applePay": {
        "displayName": "MasterCard 1234"
      }
    }
  ]
}

Changes