Create a PaymentMethod

Changed on

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.

post/v1/payment_methods

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/payment_methods
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Response

Successful response.

affirmPaymentMethodAffirm
afterpay_clearpayPaymentMethodAfterpayClearpay
alipayPaymentFlowsPrivatePaymentMethodsAlipay
allow_redisplay'always' | 'limited' | 'unspecified'

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. The field defaults to “unspecified”.

almaPaymentMethodAlma
amazon_payPaymentMethodAmazonPay
bancontactPaymentMethodBancontact
billiePaymentMethodBillie
createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

cryptoPaymentMethodCrypto
customer_accountstring nullable
customer_balancePaymentMethodCustomerBalance
giropayPaymentMethodGiropay
grabpayPaymentMethodGrabpay
idstring required

Unique identifier for the object.

kakao_payPaymentMethodKakaoPay
konbiniPaymentMethodKonbini
livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

mb_wayPaymentMethodMbWay
metadataobject nullable

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.

mobilepayPaymentMethodMobilepay
multibancoPaymentMethodMultibanco
object'payment_method' required

String representing the object's type. Objects of the same type share the same value.

oxxoPaymentMethodOxxo
pay_by_bankPaymentMethodPayByBank
paycoPaymentMethodPayco
paynowPaymentMethodPaynow
paypayPaymentMethodPaypay
promptpayPaymentMethodPromptpay
revolut_payPaymentMethodRevolutPay
samsung_payPaymentMethodSamsungPay
satispayPaymentMethodSatispay
scalapayPaymentMethodScalapay
sequraPaymentMethodSequra
sunbitPaymentMethodSunbit
swishPaymentMethodSwish
twintPaymentMethodTwint
type'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sequra' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip' required

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.

wechat_payPaymentMethodWechatPay
zipPaymentMethodZip

Changes

  • e24a26de4188Revision changes
    • breaking

      removed the enum value bnp_paribas of the request property /

    • breaking

      removed the enum value citibank of the request property /

    • breaking

      removed the enum value mbsb_bank of the request property /

    • breaking

      removed the required property ////////////////// from the response with the status

    • breaking

      removed the required property //////////////// from the response with the status

    • breaking

      removed the required property //////////////// from the response with the status

    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ///////////// from the response with the status

    • breaking

      removed the required property /////////// from the response with the status

    • breaking

      removed the required property /////////// from the response with the status

    • breaking

      removed the required property ////////////////// from the response with the status

    • breaking

      removed the required property //////////////// from the response with the status

    • breaking

      removed the required property //////////////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.