API reference

Test mode. Use your secret key on your server; live processing is currently disabled.

https://api.knoxapi.com

Send form-encoded requests with Authorization: Bearer sk_test_....

Complete OpenAPI specification · Integration guide

Operations and schemas are based on the pinned Stripe OpenAPI specification (MIT). Nested object definitions and enums are available in the complete specification.

GET /v1/payment_methods

List PaymentMethods

Returns a list of all PaymentMethods.

Request parameters

Parameter	Location	Type	Description
`allow_redisplay`	query	string	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.
`customer`	query	string	The ID of the customer whose PaymentMethods will be retrieved.
`customer_account`	query	string	The ID of the Account whose PaymentMethods will be retrieved.
`ending_before`	query	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
`expand`	query	array of string	Specifies which fields in the response should be expanded.
`limit`	query	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
`starting_after`	query	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
`type`	query	string	Filters the list by the object `type` field. Unfiltered, the list returns all payment method types except `custom`. If your integration expects only one type of payment method in the response, specify that type value in the request to reduce your payload.

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`data` required	array of payment_method
`has_more` required	boolean	True if this list has another page of items after this one that can be fetched.
`object` required	string	String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
`url` required	string	The URL where this list can be accessed.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/payment_methods

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.

Request parameters

Field	Type	Description
`acss_debit`	object	If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
`affirm`	object	If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
`afterpay_clearpay`	object	If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
`alipay`	object	If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
`allow_redisplay`	string	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`.
`alma`	object	If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
`amazon_pay`	object	If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
`au_becs_debit`	object	If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
`bacs_debit`	object	If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
`bancontact`	object	If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
`billie`	object	If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method.
`billing_details`	object	Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
`bizum`	object	If this is a `bizum` PaymentMethod, this hash contains details about the Bizum payment method.
`blik`	object	If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
`boleto`	object	If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
`card`	one of multiple schemas	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.
`cashapp`	object	If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
`crypto`	object	If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.
`custom`	object	If this is a `custom` PaymentMethod, this hash contains details about the Custom payment method.
`customer`	string	The `Customer` to whom the original PaymentMethod is attached.
`customer_balance`	object	If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
`eps`	object	If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
`expand`	array of string	Specifies which fields in the response should be expanded.
`fpx`	object	If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
`giropay`	object	If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
`grabpay`	object	If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
`ideal`	object	If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
`interac_present`	object	If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
`kakao_pay`	object	If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
`klarna`	object	If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
`konbini`	object	If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
`kr_card`	object	If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
`link`	object	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_way`	object	If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
`metadata`	object	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`.
`mobilepay`	object	If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.
`multibanco`	object	If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.
`naver_pay`	object	If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
`nz_bank_account`	object	If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
`oxxo`	object	If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
`p24`	object	If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
`pay_by_bank`	object	If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method.
`payco`	object	If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
`payment_method`	string	The PaymentMethod to share.
`paynow`	object	If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
`paypal`	object	If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
`payto`	object	If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
`pix`	object	If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
`promptpay`	object	If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
`radar_options`	object	Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.
`revolut_pay`	object	If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
`samsung_pay`	object	If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
`satispay`	object	If this is a `satispay` PaymentMethod, this hash contains details about the Satispay payment method.
`scalapay`	object	If this is a Scalapay PaymentMethod, this hash contains details about the Scalapay payment method.
`sepa_debit`	object	If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
`sofort`	object	If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
`sunbit`	object	If this is a `sunbit` PaymentMethod, this hash contains details about the Sunbit payment method.
`swish`	object	If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
`twint`	object	If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
`type`	string	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.
`upi`	object	If this is a `upi` PaymentMethod, this hash contains details about the UPI payment method.
`us_bank_account`	object	If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
`wechat_pay`	object	If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
`zip`	object	If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.

Responses

HTTP 200: Successful response.

Field	Type	Description
`acss_debit`	payment_method_acss_debit
`affirm`	payment_method_affirm
`afterpay_clearpay`	payment_method_afterpay_clearpay
`alipay`	payment_flows_private_payment_methods_alipay
`allow_redisplay`	string	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”.
`alma`	payment_method_alma
`amazon_pay`	payment_method_amazon_pay
`au_becs_debit`	payment_method_au_becs_debit
`bacs_debit`	payment_method_bacs_debit
`bancontact`	payment_method_bancontact
`billie`	payment_method_billie
`billing_details` required	billing_details
`bizum`	payment_method_bizum
`blik`	payment_method_blik
`boleto`	payment_method_boleto
`card`	payment_method_card
`card_present`	payment_method_card_present
`cashapp`	payment_method_cashapp
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`crypto`	payment_method_crypto
`custom`	payment_method_custom
`customer`	one of multiple schemas	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.
`customer_account`	string
`customer_balance`	payment_method_customer_balance
`eps`	payment_method_eps
`fpx`	payment_method_fpx
`giropay`	payment_method_giropay
`grabpay`	payment_method_grabpay
`id` required	string	Unique identifier for the object.
`ideal`	payment_method_ideal
`interac_present`	payment_method_interac_present
`kakao_pay`	payment_method_kakao_pay
`klarna`	payment_method_klarna
`konbini`	payment_method_konbini
`kr_card`	payment_method_kr_card
`link`	payment_method_link
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`mb_way`	payment_method_mb_way
`metadata`	object	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.
`mobilepay`	payment_method_mobilepay
`multibanco`	payment_method_multibanco
`naver_pay`	payment_method_naver_pay
`nz_bank_account`	payment_method_nz_bank_account
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`oxxo`	payment_method_oxxo
`p24`	payment_method_p24
`pay_by_bank`	payment_method_pay_by_bank
`payco`	payment_method_payco
`paynow`	payment_method_paynow
`paypal`	payment_method_paypal
`payto`	payment_method_payto
`pix`	payment_method_pix
`promptpay`	payment_method_promptpay
`radar_options`	radar_radar_options
`revolut_pay`	payment_method_revolut_pay
`samsung_pay`	payment_method_samsung_pay
`satispay`	payment_method_satispay
`scalapay`	payment_method_scalapay
`sepa_debit`	payment_method_sepa_debit
`sofort`	payment_method_sofort
`sunbit`	payment_method_sunbit
`swish`	payment_method_swish
`twint`	payment_method_twint
`type` required	string	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.
`upi`	payment_method_upi
`us_bank_account`	payment_method_us_bank_account
`wechat_pay`	payment_method_wechat_pay
`zip`	payment_method_zip

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

GET /v1/payment_methods/{payment_method}

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

Request parameters

Parameter	Location	Type	Description
`expand`	query	array of string	Specifies which fields in the response should be expanded.
`payment_method`	path	string

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`acss_debit`	payment_method_acss_debit
`affirm`	payment_method_affirm
`afterpay_clearpay`	payment_method_afterpay_clearpay
`alipay`	payment_flows_private_payment_methods_alipay
`allow_redisplay`	string	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”.
`alma`	payment_method_alma
`amazon_pay`	payment_method_amazon_pay
`au_becs_debit`	payment_method_au_becs_debit
`bacs_debit`	payment_method_bacs_debit
`bancontact`	payment_method_bancontact
`billie`	payment_method_billie
`billing_details` required	billing_details
`bizum`	payment_method_bizum
`blik`	payment_method_blik
`boleto`	payment_method_boleto
`card`	payment_method_card
`card_present`	payment_method_card_present
`cashapp`	payment_method_cashapp
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`crypto`	payment_method_crypto
`custom`	payment_method_custom
`customer`	one of multiple schemas	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.
`customer_account`	string
`customer_balance`	payment_method_customer_balance
`eps`	payment_method_eps
`fpx`	payment_method_fpx
`giropay`	payment_method_giropay
`grabpay`	payment_method_grabpay
`id` required	string	Unique identifier for the object.
`ideal`	payment_method_ideal
`interac_present`	payment_method_interac_present
`kakao_pay`	payment_method_kakao_pay
`klarna`	payment_method_klarna
`konbini`	payment_method_konbini
`kr_card`	payment_method_kr_card
`link`	payment_method_link
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`mb_way`	payment_method_mb_way
`metadata`	object	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.
`mobilepay`	payment_method_mobilepay
`multibanco`	payment_method_multibanco
`naver_pay`	payment_method_naver_pay
`nz_bank_account`	payment_method_nz_bank_account
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`oxxo`	payment_method_oxxo
`p24`	payment_method_p24
`pay_by_bank`	payment_method_pay_by_bank
`payco`	payment_method_payco
`paynow`	payment_method_paynow
`paypal`	payment_method_paypal
`payto`	payment_method_payto
`pix`	payment_method_pix
`promptpay`	payment_method_promptpay
`radar_options`	radar_radar_options
`revolut_pay`	payment_method_revolut_pay
`samsung_pay`	payment_method_samsung_pay
`satispay`	payment_method_satispay
`scalapay`	payment_method_scalapay
`sepa_debit`	payment_method_sepa_debit
`sofort`	payment_method_sofort
`sunbit`	payment_method_sunbit
`swish`	payment_method_swish
`twint`	payment_method_twint
`type` required	string	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.
`upi`	payment_method_upi
`us_bank_account`	payment_method_us_bank_account
`wechat_pay`	payment_method_wechat_pay
`zip`	payment_method_zip

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/payment_methods/{payment_method}

Update a PaymentMethod

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.

Request parameters

Parameter	Location	Type	Description
`payment_method`	path	string

Field	Type	Description
`allow_redisplay`	string	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`.
`billing_details`	object	Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
`card`	object	If this is a `card` PaymentMethod, this hash contains the user's card details.
`expand`	array of string	Specifies which fields in the response should be expanded.
`metadata`	one of multiple schemas	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`.
`payto`	object	If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
`us_bank_account`	object	If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.

Responses

HTTP 200: Successful response.

Field	Type	Description
`acss_debit`	payment_method_acss_debit
`affirm`	payment_method_affirm
`afterpay_clearpay`	payment_method_afterpay_clearpay
`alipay`	payment_flows_private_payment_methods_alipay
`allow_redisplay`	string	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”.
`alma`	payment_method_alma
`amazon_pay`	payment_method_amazon_pay
`au_becs_debit`	payment_method_au_becs_debit
`bacs_debit`	payment_method_bacs_debit
`bancontact`	payment_method_bancontact
`billie`	payment_method_billie
`billing_details` required	billing_details
`bizum`	payment_method_bizum
`blik`	payment_method_blik
`boleto`	payment_method_boleto
`card`	payment_method_card
`card_present`	payment_method_card_present
`cashapp`	payment_method_cashapp
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`crypto`	payment_method_crypto
`custom`	payment_method_custom
`customer`	one of multiple schemas	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.
`customer_account`	string
`customer_balance`	payment_method_customer_balance
`eps`	payment_method_eps
`fpx`	payment_method_fpx
`giropay`	payment_method_giropay
`grabpay`	payment_method_grabpay
`id` required	string	Unique identifier for the object.
`ideal`	payment_method_ideal
`interac_present`	payment_method_interac_present
`kakao_pay`	payment_method_kakao_pay
`klarna`	payment_method_klarna
`konbini`	payment_method_konbini
`kr_card`	payment_method_kr_card
`link`	payment_method_link
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`mb_way`	payment_method_mb_way
`metadata`	object	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.
`mobilepay`	payment_method_mobilepay
`multibanco`	payment_method_multibanco
`naver_pay`	payment_method_naver_pay
`nz_bank_account`	payment_method_nz_bank_account
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`oxxo`	payment_method_oxxo
`p24`	payment_method_p24
`pay_by_bank`	payment_method_pay_by_bank
`payco`	payment_method_payco
`paynow`	payment_method_paynow
`paypal`	payment_method_paypal
`payto`	payment_method_payto
`pix`	payment_method_pix
`promptpay`	payment_method_promptpay
`radar_options`	radar_radar_options
`revolut_pay`	payment_method_revolut_pay
`samsung_pay`	payment_method_samsung_pay
`satispay`	payment_method_satispay
`scalapay`	payment_method_scalapay
`sepa_debit`	payment_method_sepa_debit
`sofort`	payment_method_sofort
`sunbit`	payment_method_sunbit
`swish`	payment_method_swish
`twint`	payment_method_twint
`type` required	string	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.
`upi`	payment_method_upi
`us_bank_account`	payment_method_us_bank_account
`wechat_pay`	payment_method_wechat_pay
`zip`	payment_method_zip

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/payment_methods/{payment_method}/attach

Attach a PaymentMethod to a Customer

Attaches a PaymentMethod object to a Customer. To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See Optimizing cards for future payments for more information about setting up future payments. To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

Request parameters

Parameter	Location	Type	Description
`payment_method`	path	string

Field	Type	Description
`customer`	string	The ID of the customer to which to attach the PaymentMethod.
`customer_account`	string	The ID of the Account representing the customer to which to attach the PaymentMethod.
`expand`	array of string	Specifies which fields in the response should be expanded.

Responses

HTTP 200: Successful response.

Field	Type	Description
`acss_debit`	payment_method_acss_debit
`affirm`	payment_method_affirm
`afterpay_clearpay`	payment_method_afterpay_clearpay
`alipay`	payment_flows_private_payment_methods_alipay
`allow_redisplay`	string	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”.
`alma`	payment_method_alma
`amazon_pay`	payment_method_amazon_pay
`au_becs_debit`	payment_method_au_becs_debit
`bacs_debit`	payment_method_bacs_debit
`bancontact`	payment_method_bancontact
`billie`	payment_method_billie
`billing_details` required	billing_details
`bizum`	payment_method_bizum
`blik`	payment_method_blik
`boleto`	payment_method_boleto
`card`	payment_method_card
`card_present`	payment_method_card_present
`cashapp`	payment_method_cashapp
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`crypto`	payment_method_crypto
`custom`	payment_method_custom
`customer`	one of multiple schemas	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.
`customer_account`	string
`customer_balance`	payment_method_customer_balance
`eps`	payment_method_eps
`fpx`	payment_method_fpx
`giropay`	payment_method_giropay
`grabpay`	payment_method_grabpay
`id` required	string	Unique identifier for the object.
`ideal`	payment_method_ideal
`interac_present`	payment_method_interac_present
`kakao_pay`	payment_method_kakao_pay
`klarna`	payment_method_klarna
`konbini`	payment_method_konbini
`kr_card`	payment_method_kr_card
`link`	payment_method_link
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`mb_way`	payment_method_mb_way
`metadata`	object	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.
`mobilepay`	payment_method_mobilepay
`multibanco`	payment_method_multibanco
`naver_pay`	payment_method_naver_pay
`nz_bank_account`	payment_method_nz_bank_account
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`oxxo`	payment_method_oxxo
`p24`	payment_method_p24
`pay_by_bank`	payment_method_pay_by_bank
`payco`	payment_method_payco
`paynow`	payment_method_paynow
`paypal`	payment_method_paypal
`payto`	payment_method_payto
`pix`	payment_method_pix
`promptpay`	payment_method_promptpay
`radar_options`	radar_radar_options
`revolut_pay`	payment_method_revolut_pay
`samsung_pay`	payment_method_samsung_pay
`satispay`	payment_method_satispay
`scalapay`	payment_method_scalapay
`sepa_debit`	payment_method_sepa_debit
`sofort`	payment_method_sofort
`sunbit`	payment_method_sunbit
`swish`	payment_method_swish
`twint`	payment_method_twint
`type` required	string	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.
`upi`	payment_method_upi
`us_bank_account`	payment_method_us_bank_account
`wechat_pay`	payment_method_wechat_pay
`zip`	payment_method_zip

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/payment_methods/{payment_method}/detach

Detach a PaymentMethod from a Customer

Detaches a PaymentMethod object from a Customer. Detachment is permanent and irreversible — once detached, a PaymentMethod can no longer be used for payments or re-attached to a Customer.

Request parameters

Parameter	Location	Type	Description
`payment_method`	path	string

Field	Type	Description
`expand`	array of string	Specifies which fields in the response should be expanded.

Responses

HTTP 200: Successful response.

Field	Type	Description
`acss_debit`	payment_method_acss_debit
`affirm`	payment_method_affirm
`afterpay_clearpay`	payment_method_afterpay_clearpay
`alipay`	payment_flows_private_payment_methods_alipay
`allow_redisplay`	string	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”.
`alma`	payment_method_alma
`amazon_pay`	payment_method_amazon_pay
`au_becs_debit`	payment_method_au_becs_debit
`bacs_debit`	payment_method_bacs_debit
`bancontact`	payment_method_bancontact
`billie`	payment_method_billie
`billing_details` required	billing_details
`bizum`	payment_method_bizum
`blik`	payment_method_blik
`boleto`	payment_method_boleto
`card`	payment_method_card
`card_present`	payment_method_card_present
`cashapp`	payment_method_cashapp
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`crypto`	payment_method_crypto
`custom`	payment_method_custom
`customer`	one of multiple schemas	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.
`customer_account`	string
`customer_balance`	payment_method_customer_balance
`eps`	payment_method_eps
`fpx`	payment_method_fpx
`giropay`	payment_method_giropay
`grabpay`	payment_method_grabpay
`id` required	string	Unique identifier for the object.
`ideal`	payment_method_ideal
`interac_present`	payment_method_interac_present
`kakao_pay`	payment_method_kakao_pay
`klarna`	payment_method_klarna
`konbini`	payment_method_konbini
`kr_card`	payment_method_kr_card
`link`	payment_method_link
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`mb_way`	payment_method_mb_way
`metadata`	object	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.
`mobilepay`	payment_method_mobilepay
`multibanco`	payment_method_multibanco
`naver_pay`	payment_method_naver_pay
`nz_bank_account`	payment_method_nz_bank_account
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`oxxo`	payment_method_oxxo
`p24`	payment_method_p24
`pay_by_bank`	payment_method_pay_by_bank
`payco`	payment_method_payco
`paynow`	payment_method_paynow
`paypal`	payment_method_paypal
`payto`	payment_method_payto
`pix`	payment_method_pix
`promptpay`	payment_method_promptpay
`radar_options`	radar_radar_options
`revolut_pay`	payment_method_revolut_pay
`samsung_pay`	payment_method_samsung_pay
`satispay`	payment_method_satispay
`scalapay`	payment_method_scalapay
`sepa_debit`	payment_method_sepa_debit
`sofort`	payment_method_sofort
`sunbit`	payment_method_sunbit
`swish`	payment_method_swish
`twint`	payment_method_twint
`type` required	string	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.
`upi`	payment_method_upi
`us_bank_account`	payment_method_us_bank_account
`wechat_pay`	payment_method_wechat_pay
`zip`	payment_method_zip

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors