The PaymentMethod object

Attributes

idstring
Unique identifier for the object.

billing_detailsobject
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 object
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 75 more

More attributes

objectstring

acss_debitnullable object

affirmnullable object

afterpay_clearpaynullable object

alipaynullable object

allow_redisplaynullable enum

almanullable object

amazon_paynullable object

au_becs_debitnullable object

bacs_debitnullable object

bancontactnullable object

bliknullable object

boletonullable object

cardnullable object

card_presentnullable object

cashappnullable object

createdtimestamp

customer_balancenullable object

epsnullable object

fpxnullable object

giropaynullable object

grabpaynullable object

idealnullable object

interac_presentnullable objectPreview feature

kakao_paynullable object

klarnanullable object

konbininullable object

kr_cardnullable object

linknullable object

livemodeboolean

mobilepaynullable object

multibanconullable object

naver_paynullable object

oxxonullable object

p24nullable object

payconullable object

paynownullable object

paypalnullable object

pixnullable object

promptpaynullable object

radar_optionsnullable object

revolut_paynullable object

samsung_paynullable object

sepa_debitnullable object

sofortnullable object

swishnullable object

twintnullable object

us_bank_accountnullable object

wechat_paynullable object

zipnullable object

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 74 more

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

metadataobject
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_debitobject

affirmobject

afterpay_clearpayobject

alipayobject

allow_redisplayenum

almaobject

amazon_payobject

au_becs_debitobject

bacs_debitobject

bancontactobject

blikobject

boletoobject

cardobject

cashappobject

customer_balanceobject

epsobject

fpxobject

giropayobject

grabpayobject

idealobject

interac_presentobjectPreview feature

kakao_payobject

klarnaobject

konbiniobject

kr_cardobject

linkobject

mobilepayobject

multibancoobject

naver_payobject

oxxoobject

p24object

paycoobject

paynowobject

paypalobject

pixobject

promptpayobject

radar_optionsobject

revolut_payobject

samsung_payobject

sepa_debitobject

sofortobject

swishobject

twintobject

us_bank_accountobject

wechat_payobject

zipobject

Returns

Returns a PaymentMethod object.

POST /v1/payment_methods

Server-side language

const stripe = require('stripe')('sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc');
const paymentMethod = await stripe.paymentMethods.create({
  type: 'us_bank_account',
  us_bank_account: {
    account_holder_type: 'individual',
    account_number: '000123456789',
    routing_number: '110000000',
  },
  billing_details: {
    name: 'John Doe',
  },
});

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_detailsobject
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

metadataobject
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

cardobject

linkobject

naver_payobject

us_bank_accountobject

Returns

Returns a PaymentMethod object.

POST /v1/payment_methods/:id

Server-side language

const stripe = require('stripe')('sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc');
const paymentMethod = await stripe.paymentMethods.update(
  'pm_1Q0PsIJvEtkwdCNYMSaVuRz6',
  {
    metadata: {
      order_id: '6735',
    },
  }
);

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

const stripe = require('stripe')('sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc');
const paymentMethod = await stripe.customers.retrievePaymentMethod(
  '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"
}

Retrieve a PaymentMethod

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

Parameters

No parameters.

Returns

Returns a PaymentMethod object.

GET /v1/payment_methods/:id

Server-side language

const stripe = require('stripe')('sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc');
const paymentMethod = await stripe.paymentMethods.retrieve(
  'pm_1Q0PsIJvEtkwdCNYMSaVuRz6'
);

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": {}
  }
}

The PaymentMethod object

Attributes

idstring

billing_detailsobject

customernullable stringExpandable

metadatanullable object

typeenum

More attributesExpand all

objectstring

acss_debitnullable object

affirmnullable object

afterpay_clearpaynullable object

alipaynullable object

allow_redisplaynullable enum

almanullable object

amazon_paynullable object

au_becs_debitnullable object

bacs_debitnullable object

bancontactnullable object

bliknullable object

boletonullable object

cardnullable object

card_presentnullable object

cashappnullable object

createdtimestamp

customer_balancenullable object

epsnullable object

fpxnullable object

giropaynullable object

grabpaynullable object

idealnullable object

interac_presentnullable objectPreview feature

kakao_paynullable object

klarnanullable object

konbininullable object

kr_cardnullable object

linknullable object

livemodeboolean

mobilepaynullable object

multibanconullable object

naver_paynullable object

oxxonullable object

p24nullable object

payconullable object

paynownullable object

paypalnullable object

pixnullable object

promptpaynullable object

radar_optionsnullable object

revolut_paynullable object

samsung_paynullable object

sepa_debitnullable object

sofortnullable object

swishnullable object

twintnullable object

us_bank_accountnullable object

wechat_paynullable object

zipnullable object

Create a PaymentMethod

Parameters

typeenumRequired

billing_detailsobject

metadataobject

More parametersExpand all

acss_debitobject

affirmobject

afterpay_clearpayobject

alipayobject

allow_redisplayenum

almaobject

amazon_payobject

au_becs_debitobject

bacs_debitobject

bancontactobject

blikobject

boletoobject

cardobject

cashappobject

customer_balanceobject

epsobject

More attributes

More parameters

More parameters