Skip to main content
GET
/
v1
/
payment_methods
List
curl --request GET \
  --url https://{defaultHost}/v1/payment_methods \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/payment_methods"
  },
  "data": [
    {
      "id": "7f66b225-6de2-46d3-802b-3b7f2f48de8a",
      "object": "payment_method",
      "external_payment_method_id": "pm_3_Ju1BB2fs4LLhxzSoekOTDo3",
      "live_mode": true,
      "processor_type": "stripe",
      "reusable": true,
      "supported_currencies": null,
      "type": "card",
      "bank_account": null,
      "card": "d16cdf30-b73c-4559-8bf3-9dd9779b4910",
      "customer": "4ffadac1-97f6-421b-b296-5a6cb0c157dd",
      "payment_instrument": null,
      "paypal_account": null,
      "created_at": 1767909729,
      "updated_at": 1767909729
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_ids[]
string[]

Only return objects that belong to the given customers.

ids[]
string[]

Only return objects with the given IDs.

limit
integer

A limit on the number of items to be returned, between 1 and 100.

live_mode
boolean

Only return objects that are live mode or test mode.

page
integer

The page of items you want returned.

reusable
boolean

Only return payment methods that are reusable or not.

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.