Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

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.

    billie

    Billie is a payment method.

    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

  • billienullable 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 dictionary

  • 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

  • satispaynullable 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.

    billie

    Billie is a payment method.

    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

  • billiedictionary

  • 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_accountdictionary

  • oxxodictionary

  • p24dictionary

  • pay_by_bankdictionaryPreview feature

  • paycodictionary

  • paynowdictionary

  • paypaldictionary

  • pixdictionary

  • promptpaydictionary

  • radar_optionsdictionary

  • revolut_paydictionary

  • samsung_paydictionary

  • satispaydictionary

  • sepa_debitdictionary

  • sofortdictionary

  • swishdictionary

  • twintdictionary

  • us_bank_accountdictionary

  • wechat_paydictionary

  • zipdictionary

Returns

Returns a PaymentMethod object.

POST /v1/payment_methods
import stripe
stripe.api_key = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2"
stripe.PaymentMethod.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_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

  • pay_by_bankdictionaryPreview feature

  • us_bank_accountdictionary

Returns

Returns a PaymentMethod object.

POST /v1/payment_methods/:id
import stripe
stripe.api_key = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2"
stripe.PaymentMethod.modify(
  "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
import stripe
stripe.api_key = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2"
stripe.Customer.retrieve_payment_method(
  "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
import stripe
stripe.api_key = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2"
stripe.PaymentMethod.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": {}
  }
}