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

Request body application/x-www-form-urlencoded

affirmobject

If this is an affirm PaymentMethod, this hash contains details about the Affirm payment method.

afterpay_clearpayobject

If this is an AfterpayClearpay PaymentMethod, this hash contains details about the AfterpayClearpay payment method.

alipayobject

If this is an Alipay PaymentMethod, this hash contains details about the Alipay payment method.

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.

almaobject

If this is an Alma PaymentMethod, this hash contains details about the Alma payment method.

amazon_payobject

If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.

bancontactobject

If this is a bancontact PaymentMethod, this hash contains details about the Bancontact payment method.

billieobject

If this is a billie PaymentMethod, this hash contains details about the Billie payment method.

bizumobject

If this is a bizum PaymentMethod, this hash contains details about the Bizum payment method.

blikobject

If this is a blik PaymentMethod, this hash contains details about the BLIK payment method.

cashappobject

If this is a cashapp PaymentMethod, this hash contains details about the Cash App Pay payment method.

cryptoobject

If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.

customerstring

The Customer to whom the original PaymentMethod is attached.

customer_balanceobject

If this is a customer_balance PaymentMethod, this hash contains details about the CustomerBalance payment method.

expandstring[]

Specifies which fields in the response should be expanded.

giropayobject

If this is a giropay PaymentMethod, this hash contains details about the Giropay payment method.

grabpayobject

If this is a grabpay PaymentMethod, this hash contains details about the GrabPay payment method.

interac_presentobject

If this is an interac_present PaymentMethod, this hash contains details about the Interac Present payment method.

kakao_payobject

If this is a kakao_pay PaymentMethod, this hash contains details about the Kakao Pay payment method.

konbiniobject

If this is a konbini PaymentMethod, this hash contains details about the Konbini payment method.

kr_cardobject

If this is a kr_card PaymentMethod, this hash contains details about the Korean Card payment method.

linkobject

If this is an Link PaymentMethod, this hash contains details about the Link payment method (Link is also known as Onelink in the UK).

mb_wayobject

If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.

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.

mobilepayobject

If this is a mobilepay PaymentMethod, this hash contains details about the MobilePay payment method.

multibancoobject

If this is a multibanco PaymentMethod, this hash contains details about the Multibanco payment method.

oxxoobject

If this is an oxxo PaymentMethod, this hash contains details about the OXXO payment method.

pay_by_bankobject

If this is a pay_by_bank PaymentMethod, this hash contains details about the PayByBank payment method.

paycoobject

If this is a payco PaymentMethod, this hash contains details about the PAYCO payment method.

payment_methodstring

The PaymentMethod to share.

paynowobject

If this is a paynow PaymentMethod, this hash contains details about the PayNow payment method.

paypalobject

If this is a paypal PaymentMethod, this hash contains details about the PayPal payment method.

paypayobject

If this is a paypay PaymentMethod, this hash contains details about the PayPay payment method.

pixobject

If this is a pix PaymentMethod, this hash contains details about the Pix payment method.

promptpayobject

If this is a promptpay PaymentMethod, this hash contains details about the PromptPay payment method.

revolut_payobject

If this is a revolut_pay PaymentMethod, this hash contains details about the Revolut Pay payment method.

samsung_payobject

If this is a samsung_pay PaymentMethod, this hash contains details about the SamsungPay payment method.

satispayobject

If this is a satispay PaymentMethod, this hash contains details about the Satispay payment method.

scalapayobject

If this is a Scalapay PaymentMethod, this hash contains details about the Scalapay payment method.

sequraobject

If this is a SeQura PaymentMethod, this hash contains details about the SeQura payment method.

sunbitobject

If this is a sunbit PaymentMethod, this hash contains details about the Sunbit payment method.

swishobject

If this is a swish PaymentMethod, this hash contains details about the Swish payment method.

twintobject

If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.

type'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | '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'

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_payobject

If this is an wechat_pay PaymentMethod, this hash contains details about the wechat_pay payment method.

zipobject

If this is a zip PaymentMethod, this hash contains details about the Zip payment method.

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

  • c113b1939b8fRevision changes
    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property //////////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status

Some revisions have not been checked yet.