GET /v1/customers/{customer}/payment_methods

Returns a list of PaymentMethods for a given Customer

Servers

Path parameters

Name Type Required Description
customer String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Query parameters

Name Type Required Description
limit Integer No

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

starting_after String No

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

expand[] Array No

Specifies which fields in the response should be expanded.

allow_redisplay String No

This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.

Possible values:

  • "limited"
  • "unspecified"
  • "always"
type String No

An optional filter on the list, based on the object type field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.

Possible values:

  • "p24"
  • "pay_by_bank"
  • "blik"
  • "crypto"
  • "amazon_pay"
  • "boleto"
  • "bacs_debit"
  • "giropay"
  • "eps"
  • "card"
  • "paynow"
  • "pix"
  • "fpx"
  • "promptpay"
  • "zip"
  • "alipay"
  • "naver_pay"
  • "revolut_pay"
  • "billie"
  • "klarna"
  • "bancontact"
  • "kr_card"
  • "swish"
  • "paypal"
  • "samsung_pay"
  • "sofort"
  • "nz_bank_account"
  • "au_becs_debit"
  • "kakao_pay"
  • "konbini"
  • "acss_debit"
  • "link"
  • "alma"
  • "satispay"
  • "payco"
  • "sepa_debit"
  • "us_bank_account"
  • "oxxo"
  • "cashapp"
  • "affirm"
  • "twint"
  • "afterpay_clearpay"
  • "customer_balance"
  • "grabpay"
  • "multibanco"
  • "ideal"
  • "wechat_pay"
  • "mobilepay"
ending_before String No

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.