StripeAPI.Operations.PostPaymentMethods

POST /v1/payment_methods

<p>Creates a PaymentMethod object. Read the <a href="/docs/stripe-js/reference#stripe-create-payment-method">Stripe.js reference</a> to learn how to create PaymentMethods via Stripe.js.</p>

<p>Instead of creating a PaymentMethod directly, we recommend using the <a href="/docs/payments/accept-a-payment">PaymentIntents</a> API to accept a payment immediately or the <a href="/docs/payments/save-and-reuse">SetupIntent</a> API to collect payment method details ahead of a future payment.</p>

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Create a new PostPaymentMethodsRequestBody with all required fields.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.acss_debit in the specification.

If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.

Create a new PostPaymentMethodsRequestBodyAcssDebit' with all required fields.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.au_becs_debit in the specification.

If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.

Create a new PostPaymentMethodsRequestBodyAuBecsDebit' with all required fields.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.bacs_debit in the specification.

If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.

Create a new PostPaymentMethodsRequestBodyBacsDebit' with all required fields.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_details in the specification.

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

Create a new PostPaymentMethodsRequestBodyBillingDetails' with all required fields.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_details.properties.address.anyOf in the specification.

Create a new PostPaymentMethodsRequestBodyBillingDetails'Address'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_details.properties.address.anyOf in the specification.

Defines the oneOf schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_details.properties.email.anyOf in the specification.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.boleto in the specification.

If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.

Create a new PostPaymentMethodsRequestBodyBoleto' with all required fields.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.card.anyOf in the specification.

If this is a \`card\` PaymentMethod, this hash contains the user\'s card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format \`card: {token: \"tok_visa\"}\`. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Stripe.js instead of interacting with this API directly.

Create a new PostPaymentMethodsRequestBodyCard' with all required fields.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.eps in the specification.

If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.

Create a new PostPaymentMethodsRequestBodyEps' with all required fields.

Defines the enum schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.eps.properties.bank in the specification.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.fpx in the specification.

If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.

Create a new PostPaymentMethodsRequestBodyFpx' with all required fields.

Defines the enum schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.fpx.properties.bank in the specification.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.ideal in the specification.

If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.

Create a new PostPaymentMethodsRequestBodyIdeal' with all required fields.

Defines the enum schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.ideal.properties.bank in the specification.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.klarna in the specification.

If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.

Create a new PostPaymentMethodsRequestBodyKlarna' with all required fields.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.klarna.properties.dob in the specification.

Create a new PostPaymentMethodsRequestBodyKlarna'Dob' with all required fields.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.p24 in the specification.

If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.

Create a new PostPaymentMethodsRequestBodyP24' with all required fields.

Defines the enum schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.p24.properties.bank in the specification.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.radar_options in the specification.

Options to configure Radar. See Radar Session for more information.

Create a new PostPaymentMethodsRequestBodyRadarOptions' with all required fields.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.sepa_debit in the specification.

If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.

Create a new PostPaymentMethodsRequestBodySepaDebit' with all required fields.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.sofort in the specification.

If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.

Create a new PostPaymentMethodsRequestBodySofort' with all required fields.

Defines the enum schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.sofort.properties.country in the specification.

Defines the enum schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.type in the specification.

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.

Defines the object schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.us_bank_account in the specification.

If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.

Create a new PostPaymentMethodsRequestBodyUsBankAccount' with all required fields.

Defines the enum schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.us_bank_account.properties.account_holder_type in the specification.

Defines the enum schema located at paths./v1/payment_methods.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.us_bank_account.properties.account_type in the specification.

Represents a response of the operation postPaymentMethods.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostPaymentMethodsResponseError is used.