provider POST /v1/payment_methods
@utdk/stripe /v1/payment_methods
Shares a PaymentMethod
<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>

Try it

Authentication
Configure credentials for Stripe API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

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>

Input

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

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

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

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

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`.

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

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

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

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

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

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

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

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

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

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

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](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly.

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

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

If this is a `custom` PaymentMethod, this hash contains details about the Custom payment method.

The `Customer` to whom the original PaymentMethod is attached.

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

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

Specifies which fields in the response should be expanded.

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

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

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

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

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

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

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

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

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

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

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

Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.

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

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

If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.

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

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

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

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

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

The PaymentMethod to share.

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

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

If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.

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

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

Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.

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

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

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

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

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

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

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

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

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

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.

If this is a `upi` PaymentMethod, this hash contains details about the UPI payment method.

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

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

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.postpaymentmethods()