Payment Methods

PaymentMethod objects represent your customer’s payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

Related guides: Payment Methods and More Payment Scenarios.

Endpoints

POST/v1/payment_methods

POST/v1/payment_methods/:id

GET/v1/customers/:id/payment_methods/:id

GET/v1/payment_methods/:id

GET/v1/customers/:id/payment_methods

GET/v1/payment_methods

POST/v1/payment_methods/:id/attach

POST/v1/payment_methods/:id/detach

The PaymentMethod object

Attributes

idstring
Unique identifier for the object.

billing_detailsDictionary
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

customernullable stringExpandable
The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.

metadatanullable Dictionary
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

typeenum

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

Possible enum values

acss_debit

Pre-authorized debit payments are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).

affirm

Affirm is a buy now, pay later payment method in the US.

afterpay_clearpay

Afterpay / Clearpay is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.

alipay

Alipay is a digital wallet payment method used in China.

alma

Alma is a Buy Now, Pay Later payment method that lets customers pay in 2, 3, or 4 installments.

amazon_pay

Amazon Pay is a Wallet payment method that lets hundreds of millions of Amazon customers pay their way, every day.

au_becs_debit

BECS Direct Debit is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).

bacs_debit

Bacs Direct Debit is used to debit UK bank accounts.

bancontact

Bancontact is a bank redirect payment method used in Belgium.

blik

BLIK is a single-use payment method common in Poland.

Show 79 more

More attributes

objectstring

acss_debitnullable Dictionary

affirmnullable Dictionary

afterpay_clearpaynullable Dictionary

alipaynullable Dictionary

allow_redisplaynullable enum

almanullable Dictionary

amazon_paynullable Dictionary

au_becs_debitnullable Dictionary

bacs_debitnullable Dictionary

bancontactnullable Dictionary

bliknullable Dictionary

boletonullable Dictionary

cardnullable Dictionary

card_presentnullable Dictionary

cashappnullable Dictionary

createdtimestamp

customer_balancenullable Dictionary

epsnullable Dictionary

fpxnullable Dictionary

giropaynullable Dictionary

grabpaynullable Dictionary

idealnullable Dictionary

interac_presentnullable DictionaryPreview feature

kakao_paynullable Dictionary

klarnanullable Dictionary

konbininullable Dictionary

kr_cardnullable Dictionary

linknullable Dictionary

livemodeboolean

mobilepaynullable Dictionary

multibanconullable Dictionary

naver_paynullable Dictionary

nz_bank_accountnullable DictionaryPreview feature

oxxonullable Dictionary

p24nullable Dictionary

pay_by_banknullable DictionaryPreview feature

payconullable Dictionary

paynownullable Dictionary

paypalnullable Dictionary

pixnullable Dictionary

promptpaynullable Dictionary

radar_optionsnullable Dictionary

revolut_paynullable Dictionary

samsung_paynullable Dictionary

sepa_debitnullable Dictionary

sofortnullable Dictionary

swishnullable Dictionary

twintnullable Dictionary

us_bank_accountnullable Dictionary

wechat_paynullable Dictionary

zipnullable Dictionary

The PaymentMethod object

{
  "id": "pm_1Q0PsIJvEtkwdCNYMSaVuRz6",
  "object": "payment_method",
  "allow_redisplay": "unspecified",
  "billing_details": {
    "address": {
      "city": null,
      "country": null,
      "line1": null,
      "line2": null,
      "postal_code": null,
      "state": null
    },
    "email": null,
    "name": "John Doe",
    "phone": null
  },
  "created": 1726673582,
  "customer": null,
  "livemode": false,
  "metadata": {},
  "type": "us_bank_account",
  "us_bank_account": {
    "account_holder_type": "individual",
    "account_type": "checking",
    "bank_name": "STRIPE TEST BANK",
    "financial_connections_account": null,
    "fingerprint": "LstWJFsCK7P349Bg",
    "last4": "6789",
    "networks": {
      "preferred": "ach",
      "supported": [
        "ach"
      ]
    },
    "routing_number": "110000000",
    "status_details": {}
  }
}

Create a PaymentMethod

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

Parameters

typeenumRequired

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

Possible enum values

acss_debit

Pre-authorized debit payments are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).

affirm

Affirm is a buy now, pay later payment method in the US.

afterpay_clearpay

Afterpay / Clearpay is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.

alipay

Alipay is a digital wallet payment method used in China.

alma

Alma is a Buy Now, Pay Later payment method that lets customers pay in 2, 3, or 4 installments.

amazon_pay

Amazon Pay is a Wallet payment method that lets hundreds of millions of Amazon customers pay their way, every day.

au_becs_debit

BECS Direct Debit is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).

bacs_debit

Bacs Direct Debit is used to debit UK bank accounts.

bancontact

Bancontact is a bank redirect payment method used in Belgium.

blik

BLIK is a single-use payment method common in Poland.

Show 78 more

billing_detailsDictionary
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

metadataDictionary
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

acss_debitDictionary

affirmDictionary

afterpay_clearpayDictionary

alipayDictionary

allow_redisplayenum

almaDictionary

amazon_payDictionary

au_becs_debitDictionary

bacs_debitDictionary

bancontactDictionary

blikDictionary

boletoDictionary

cardDictionary

cashappDictionary

customer_balanceDictionary

epsDictionary

fpxDictionary

giropayDictionary

grabpayDictionary

idealDictionary

interac_presentDictionaryPreview feature

kakao_payDictionary

klarnaDictionary

konbiniDictionary

kr_cardDictionary

linkDictionary

mobilepayDictionary

multibancoDictionary

naver_payDictionary

nz_bank_accountDictionaryPreview feature

oxxoDictionary

p24Dictionary

pay_by_bankDictionaryPreview feature

paycoDictionary

paynowDictionary

paypalDictionary

pixDictionary

promptpayDictionary

radar_optionsDictionary

revolut_payDictionary

samsung_payDictionary

sepa_debitDictionary

sofortDictionary

swishDictionary

twintDictionary

us_bank_accountDictionary

wechat_payDictionary

zipDictionary

Returns

Returns a PaymentMethod object.

POST /v1/payment_methods

Server-side language

StripeConfiguration.ApiKey = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2";
var options = new PaymentMethodCreateOptions
{
    Type = "us_bank_account",
    UsBankAccount = new PaymentMethodUsBankAccountOptions
    {
        AccountHolderType = "individual",
        AccountNumber = "000123456789",
        RoutingNumber = "110000000",
    },
    BillingDetails = new PaymentMethodBillingDetailsOptions { Name = "John Doe" },
};
var service = new PaymentMethodService();
service.Create(options);

Response

{
  "id": "pm_1Q0PsIJvEtkwdCNYMSaVuRz6",
  "object": "payment_method",
  "allow_redisplay": "unspecified",
  "billing_details": {
    "address": {
      "city": null,
      "country": null,
      "line1": null,
      "line2": null,
      "postal_code": null,
      "state": null
    },
    "email": null,
    "name": "John Doe",
    "phone": null
  },
  "created": 1726673582,
  "customer": null,
  "livemode": false,
  "metadata": {},
  "type": "us_bank_account",
  "us_bank_account": {
    "account_holder_type": "individual",
    "account_type": "checking",
    "bank_name": "STRIPE TEST BANK",
    "financial_connections_account": null,
    "fingerprint": "LstWJFsCK7P349Bg",
    "last4": "6789",
    "networks": {
      "preferred": "ach",
      "supported": [
        "ach"
      ]
    },
    "routing_number": "110000000",
    "status_details": {}
  }
}

Update a PaymentMethod

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

Parameters

billing_detailsDictionary
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

metadataDictionary
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

allow_redisplayenum

cardDictionary

linkDictionary

naver_payDictionary

pay_by_bankDictionaryPreview feature

us_bank_accountDictionary

Returns

Returns a PaymentMethod object.

POST /v1/payment_methods/:id

Server-side language

StripeConfiguration.ApiKey = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2";
var options = new PaymentMethodUpdateOptions
{
    Metadata = new Dictionary<string, string> { { "order_id", "6735" } },
};
var service = new PaymentMethodService();
service.Update("pm_1Q0PsIJvEtkwdCNYMSaVuRz6", options);

Response

{
  "id": "pm_1Q0PsIJvEtkwdCNYMSaVuRz6",
  "object": "payment_method",
  "allow_redisplay": "unspecified",
  "billing_details": {
    "address": {
      "city": null,
      "country": null,
      "line1": null,
      "line2": null,
      "postal_code": null,
      "state": null
    },
    "email": null,
    "name": "John Doe",
    "phone": null
  },
  "created": 1726673582,
  "customer": null,
  "livemode": false,
  "metadata": {
    "order_id": "6735"
  },
  "type": "us_bank_account",
  "us_bank_account": {
    "account_holder_type": "individual",
    "account_type": "checking",
    "bank_name": "STRIPE TEST BANK",
    "financial_connections_account": null,
    "fingerprint": "LstWJFsCK7P349Bg",
    "last4": "6789",
    "networks": {
      "preferred": "ach",
      "supported": [
        "ach"
      ]
    },
    "routing_number": "110000000",
    "status_details": {}
  }
}

Retrieve a Customer's PaymentMethod

Retrieves a PaymentMethod object for a given Customer.

Parameters

No parameters.

Returns

Returns a PaymentMethod object.

GET /v1/customers/:id/payment_methods/:id

Server-side language

StripeConfiguration.ApiKey = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2";
var service = new CustomerPaymentMethodService();
service.Get("cus_9s6XKzkNRiz8i3", "pm_1NVChw2eZvKYlo2CHxiM5E2E");

Response

{
  "id": "pm_1NVChw2eZvKYlo2CHxiM5E2E",
  "object": "payment_method",
  "billing_details": {
    "address": {
      "city": null,
      "country": null,
      "line1": null,
      "line2": null,
      "postal_code": null,
      "state": null
    },
    "email": null,
    "name": null,
    "phone": null
  },
  "card": {
    "brand": "visa",
    "checks": {
      "address_line1_check": null,
      "address_postal_code_check": null,
      "cvc_check": "pass"
    },
    "country": "US",
    "exp_month": 12,
    "exp_year": 2034,
    "fingerprint": "Xt5EWLLDS7FJjR1c",
    "funding": "credit",
    "generated_from": null,
    "last4": "4242",
    "networks": {
      "available": [
        "visa"
      ],
      "preferred": null
    },
    "three_d_secure_usage": {
      "supported": true
    },
    "wallet": null
  },
  "created": 1689682128,
  "customer": "cus_9s6XKzkNRiz8i3",
  "livemode": false,
  "metadata": {},
  "redaction": null,
  "type": "card"
}

Payment Methods

The PaymentMethod object

Attributes

idstring

billing_detailsDictionary

customernullable stringExpandable

metadatanullable Dictionary

typeenum

More attributesExpand all

objectstring

acss_debitnullable Dictionary

affirmnullable Dictionary

afterpay_clearpaynullable Dictionary

alipaynullable Dictionary

allow_redisplaynullable enum

almanullable Dictionary

amazon_paynullable Dictionary

au_becs_debitnullable Dictionary

bacs_debitnullable Dictionary

bancontactnullable Dictionary

bliknullable Dictionary

boletonullable Dictionary

cardnullable Dictionary

card_presentnullable Dictionary

cashappnullable Dictionary

createdtimestamp

customer_balancenullable Dictionary

epsnullable Dictionary

fpxnullable Dictionary

giropaynullable Dictionary

grabpaynullable Dictionary

idealnullable Dictionary

interac_presentnullable DictionaryPreview feature

kakao_paynullable Dictionary

klarnanullable Dictionary

konbininullable Dictionary

kr_cardnullable Dictionary

linknullable Dictionary

livemodeboolean

mobilepaynullable Dictionary

multibanconullable Dictionary

naver_paynullable Dictionary

nz_bank_accountnullable DictionaryPreview feature

oxxonullable Dictionary

p24nullable Dictionary

pay_by_banknullable DictionaryPreview feature

payconullable Dictionary

paynownullable Dictionary

paypalnullable Dictionary

pixnullable Dictionary

promptpaynullable Dictionary

radar_optionsnullable Dictionary

revolut_paynullable Dictionary

samsung_paynullable Dictionary

sepa_debitnullable Dictionary

sofortnullable Dictionary

swishnullable Dictionary

twintnullable Dictionary

us_bank_accountnullable Dictionary

wechat_paynullable Dictionary

zipnullable Dictionary

Create a PaymentMethod

Parameters

typeenumRequired

billing_detailsDictionary

metadataDictionary

More parametersExpand all

acss_debitDictionary

affirmDictionary

afterpay_clearpayDictionary

alipayDictionary

allow_redisplayenum

almaDictionary

amazon_payDictionary

au_becs_debitDictionary

bacs_debitDictionary

bancontactDictionary

blikDictionary

boletoDictionary

cardDictionary

More attributes

More parameters

More parameters