API reference
Test mode. Use your secret key on your server; live processing is currently disabled.
https://api.knoxapi.comSend 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_method_configurations
List payment method configurations
List payment method configurations
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
active | query | boolean | Whether the configuration is active. |
application | query | one of multiple schemas | The Connect application to filter by. |
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. |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
data required | array of payment_method_configuration | |
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_method_configurations
Create a payment method configuration
Creates a payment method configuration
Request parameters
| Field | Type | Description |
|---|---|---|
acss_debit | object | Canadian pre-authorized debit payments, check this [page](https://docs.stripe.com/payments/acss-debit) for more details like country availability. |
affirm | object | [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://docs.stripe.com/payments/affirm) for more details like country availability. |
afterpay_clearpay | object | Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://docs.stripe.com/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. |
alipay | object | Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://docs.stripe.com/payments/alipay) for more details. |
alma | object | Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments. |
amazon_pay | object | Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. |
apple_pay | object | Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://docs.stripe.com/apple-pay) for more details. |
apple_pay_later | object | Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks. |
au_becs_debit | object | Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://docs.stripe.com/payments/au-becs-debit) for more details. |
bacs_debit | object | Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://docs.stripe.com/payments/payment-methods/bacs-debit) for more details. |
bancontact | object | Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://docs.stripe.com/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://docs.stripe.com/payments/bancontact) for more details. |
billie | object | Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. |
bizum | object | To enable Bizum, buyers need a Spanish IBAN from a bank connected to Bizum. Within their banking app, they can enable Bizum and link their mobile number to their IBAN. |
blik | object | BLIK is a [single use](https://docs.stripe.com/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://docs.stripe.com/payments/blik) for more details. |
boleto | object | Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://docs.stripe.com/payments/boleto) for more details. |
card | object | Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks. |
cartes_bancaires | object | Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://docs.stripe.com/payments/cartes-bancaires) for more details. |
cashapp | object | Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://docs.stripe.com/payments/cash-app-pay) for more details. |
crypto | object | [Stablecoin payments](https://docs.stripe.com/payments/stablecoin-payments) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. |
customer_balance | object | Uses a customer’s [cash balance](https://docs.stripe.com/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://docs.stripe.com/payments/bank-transfers) for more details. |
eps | object | EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://docs.stripe.com/payments/eps) for more details. |
expand | array of string | Specifies which fields in the response should be expanded. |
fpx | object | Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://docs.stripe.com/payments/fpx) for more details. |
fr_meal_voucher_conecs | object | Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://docs.stripe.com/payments/meal-vouchers/fr-meal-vouchers) for more details. |
giropay | object | giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://docs.stripe.com/payments/giropay) for more details. |
google_pay | object | Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://docs.stripe.com/google-pay) for more details. |
grabpay | object | GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://docs.stripe.com/payments/grabpay) for more details. |
ideal | object | iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://docs.stripe.com/payments/ideal) for more details. |
jcb | object | JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. |
kakao_pay | object | Kakao Pay is a popular local wallet available in South Korea. |
klarna | object | Klarna gives customers a range of [payment options](https://docs.stripe.com/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://docs.stripe.com/payments/klarna) for more details. |
konbini | object | Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://docs.stripe.com/payments/konbini) for more details. |
kr_card | object | Korean cards let users pay using locally issued cards from South Korea. |
link | object | [Link](https://docs.stripe.com/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. |
mb_way | object | MB WAY is the most popular wallet in Portugal. After entering their phone number in your checkout, customers approve the payment directly in their MB WAY app. Check this [page](https://docs.stripe.com/payments/mb-way) for more details. |
mobilepay | object | MobilePay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://docs.stripe.com/payments/mobilepay) for more details. |
multibanco | object | Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method. |
name | string | Configuration name. |
naver_pay | object | Naver Pay is a popular local wallet available in South Korea. |
nz_bank_account | object | Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://docs.stripe.com/payments/nz-bank-account) for more details. |
oxxo | object | OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://docs.stripe.com/payments/oxxo) for more details. |
p24 | object | Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://docs.stripe.com/payments/p24) for more details. |
parent | string | Configuration's parent configuration. Specify to create a child configuration. |
pay_by_bank | object | Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments. |
payco | object | PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. |
paynow | object | PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://docs.stripe.com/payments/paynow) for more details. |
paypal | object | PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://docs.stripe.com/payments/paypal) for more details. |
payto | object | PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details. |
pix | object | Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details. |
promptpay | object | PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://docs.stripe.com/payments/promptpay) for more details. |
revolut_pay | object | Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. |
samsung_pay | object | Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. |
satispay | object | Satispay is a [single-use](/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. |
scalapay | object | Scalapay is a [single-use](/payments/payment-methods#usage) payment method that lets customers pay in 3 or 4 installments. Customers are redirected from your website or app, authorize the payment with Scalapay, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. |
sepa_debit | object | The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://docs.stripe.com/payments/sepa-debit) for more details. |
sofort | object | Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://docs.stripe.com/payments/sofort) for more details. |
sunbit | object | Sunbit is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers choose to pay in 3, 6, or 12 installments. Customers are redirected from your website or app, authorize the payment with Sunbit, then return to your website or app. You get [immediate notification](https://docs.stripe.com/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. |
swish | object | Swish is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://docs.stripe.com/payments/swish) for more details. |
twint | object | Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details. |
upi | object | Unified Payment Interface (UPI) is India's leading payment method with exponential growth since it launched in 2016. |
us_bank_account | object | Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://docs.stripe.com/payments/ach-direct-debit) for more details. |
wechat_pay | object | WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://docs.stripe.com/payments/wechat-pay) for more details. |
zip | object | Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://docs.stripe.com/payments/zip) for more details like country availability. |
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
acss_debit | payment_method_config_resource_payment_method_properties | |
active required | boolean | Whether the configuration can be used for new payments. |
affirm | payment_method_config_resource_payment_method_properties | |
afterpay_clearpay | payment_method_config_resource_payment_method_properties | |
alipay | payment_method_config_resource_payment_method_properties | |
alma | payment_method_config_resource_payment_method_properties | |
amazon_pay | payment_method_config_resource_payment_method_properties | |
apple_pay | payment_method_config_resource_payment_method_properties | |
application | string | For child configs, the Connect application associated with the configuration. |
au_becs_debit | payment_method_config_resource_payment_method_properties | |
bacs_debit | payment_method_config_resource_payment_method_properties | |
bancontact | payment_method_config_resource_payment_method_properties | |
billie | payment_method_config_resource_payment_method_properties | |
bizum | payment_method_config_resource_payment_method_properties | |
blik | payment_method_config_resource_payment_method_properties | |
boleto | payment_method_config_resource_payment_method_properties | |
card | payment_method_config_resource_payment_method_properties | |
cartes_bancaires | payment_method_config_resource_payment_method_properties | |
cashapp | payment_method_config_resource_payment_method_properties | |
crypto | payment_method_config_resource_payment_method_properties | |
customer_balance | payment_method_config_resource_payment_method_properties | |
eps | payment_method_config_resource_payment_method_properties | |
fpx | payment_method_config_resource_payment_method_properties | |
giropay | payment_method_config_resource_payment_method_properties | |
google_pay | payment_method_config_resource_payment_method_properties | |
grabpay | payment_method_config_resource_payment_method_properties | |
id required | string | Unique identifier for the object. |
ideal | payment_method_config_resource_payment_method_properties | |
is_default required | boolean | The default configuration is used whenever a payment method configuration is not specified. |
jcb | payment_method_config_resource_payment_method_properties | |
kakao_pay | payment_method_config_resource_payment_method_properties | |
klarna | payment_method_config_resource_payment_method_properties | |
konbini | payment_method_config_resource_payment_method_properties | |
kr_card | payment_method_config_resource_payment_method_properties | |
link | payment_method_config_resource_payment_method_properties | |
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_config_resource_payment_method_properties | |
mobilepay | payment_method_config_resource_payment_method_properties | |
multibanco | payment_method_config_resource_payment_method_properties | |
name required | string | The configuration's name. |
naver_pay | payment_method_config_resource_payment_method_properties | |
nz_bank_account | payment_method_config_resource_payment_method_properties | |
object required | string | String representing the object's type. Objects of the same type share the same value. |
oxxo | payment_method_config_resource_payment_method_properties | |
p24 | payment_method_config_resource_payment_method_properties | |
parent | string | For child configs, the configuration's parent configuration. |
pay_by_bank | payment_method_config_resource_payment_method_properties | |
payco | payment_method_config_resource_payment_method_properties | |
paynow | payment_method_config_resource_payment_method_properties | |
paypal | payment_method_config_resource_payment_method_properties | |
payto | payment_method_config_resource_payment_method_properties | |
pix | payment_method_config_resource_payment_method_properties | |
promptpay | payment_method_config_resource_payment_method_properties | |
revolut_pay | payment_method_config_resource_payment_method_properties | |
samsung_pay | payment_method_config_resource_payment_method_properties | |
satispay | payment_method_config_resource_payment_method_properties | |
scalapay | payment_method_config_resource_payment_method_properties | |
sepa_debit | payment_method_config_resource_payment_method_properties | |
sofort | payment_method_config_resource_payment_method_properties | |
sunbit | payment_method_config_resource_payment_method_properties | |
swish | payment_method_config_resource_payment_method_properties | |
twint | payment_method_config_resource_payment_method_properties | |
upi | payment_method_config_resource_payment_method_properties | |
us_bank_account | payment_method_config_resource_payment_method_properties | |
wechat_pay | payment_method_config_resource_payment_method_properties | |
zip | payment_method_config_resource_payment_method_properties |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
GET /v1/payment_method_configurations/{configuration}
Retrieve payment method configuration
Retrieve payment method configuration
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
configuration | path | string | |
expand | query | array of string | Specifies which fields in the response should be expanded. |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
acss_debit | payment_method_config_resource_payment_method_properties | |
active required | boolean | Whether the configuration can be used for new payments. |
affirm | payment_method_config_resource_payment_method_properties | |
afterpay_clearpay | payment_method_config_resource_payment_method_properties | |
alipay | payment_method_config_resource_payment_method_properties | |
alma | payment_method_config_resource_payment_method_properties | |
amazon_pay | payment_method_config_resource_payment_method_properties | |
apple_pay | payment_method_config_resource_payment_method_properties | |
application | string | For child configs, the Connect application associated with the configuration. |
au_becs_debit | payment_method_config_resource_payment_method_properties | |
bacs_debit | payment_method_config_resource_payment_method_properties | |
bancontact | payment_method_config_resource_payment_method_properties | |
billie | payment_method_config_resource_payment_method_properties | |
bizum | payment_method_config_resource_payment_method_properties | |
blik | payment_method_config_resource_payment_method_properties | |
boleto | payment_method_config_resource_payment_method_properties | |
card | payment_method_config_resource_payment_method_properties | |
cartes_bancaires | payment_method_config_resource_payment_method_properties | |
cashapp | payment_method_config_resource_payment_method_properties | |
crypto | payment_method_config_resource_payment_method_properties | |
customer_balance | payment_method_config_resource_payment_method_properties | |
eps | payment_method_config_resource_payment_method_properties | |
fpx | payment_method_config_resource_payment_method_properties | |
giropay | payment_method_config_resource_payment_method_properties | |
google_pay | payment_method_config_resource_payment_method_properties | |
grabpay | payment_method_config_resource_payment_method_properties | |
id required | string | Unique identifier for the object. |
ideal | payment_method_config_resource_payment_method_properties | |
is_default required | boolean | The default configuration is used whenever a payment method configuration is not specified. |
jcb | payment_method_config_resource_payment_method_properties | |
kakao_pay | payment_method_config_resource_payment_method_properties | |
klarna | payment_method_config_resource_payment_method_properties | |
konbini | payment_method_config_resource_payment_method_properties | |
kr_card | payment_method_config_resource_payment_method_properties | |
link | payment_method_config_resource_payment_method_properties | |
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_config_resource_payment_method_properties | |
mobilepay | payment_method_config_resource_payment_method_properties | |
multibanco | payment_method_config_resource_payment_method_properties | |
name required | string | The configuration's name. |
naver_pay | payment_method_config_resource_payment_method_properties | |
nz_bank_account | payment_method_config_resource_payment_method_properties | |
object required | string | String representing the object's type. Objects of the same type share the same value. |
oxxo | payment_method_config_resource_payment_method_properties | |
p24 | payment_method_config_resource_payment_method_properties | |
parent | string | For child configs, the configuration's parent configuration. |
pay_by_bank | payment_method_config_resource_payment_method_properties | |
payco | payment_method_config_resource_payment_method_properties | |
paynow | payment_method_config_resource_payment_method_properties | |
paypal | payment_method_config_resource_payment_method_properties | |
payto | payment_method_config_resource_payment_method_properties | |
pix | payment_method_config_resource_payment_method_properties | |
promptpay | payment_method_config_resource_payment_method_properties | |
revolut_pay | payment_method_config_resource_payment_method_properties | |
samsung_pay | payment_method_config_resource_payment_method_properties | |
satispay | payment_method_config_resource_payment_method_properties | |
scalapay | payment_method_config_resource_payment_method_properties | |
sepa_debit | payment_method_config_resource_payment_method_properties | |
sofort | payment_method_config_resource_payment_method_properties | |
sunbit | payment_method_config_resource_payment_method_properties | |
swish | payment_method_config_resource_payment_method_properties | |
twint | payment_method_config_resource_payment_method_properties | |
upi | payment_method_config_resource_payment_method_properties | |
us_bank_account | payment_method_config_resource_payment_method_properties | |
wechat_pay | payment_method_config_resource_payment_method_properties | |
zip | payment_method_config_resource_payment_method_properties |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
POST /v1/payment_method_configurations/{configuration}
Update payment method configuration
Update payment method configuration
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
configuration | path | string |
| Field | Type | Description |
|---|---|---|
acss_debit | object | Canadian pre-authorized debit payments, check this [page](https://docs.stripe.com/payments/acss-debit) for more details like country availability. |
active | boolean | Whether the configuration can be used for new payments. |
affirm | object | [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://docs.stripe.com/payments/affirm) for more details like country availability. |
afterpay_clearpay | object | Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://docs.stripe.com/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. |
alipay | object | Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://docs.stripe.com/payments/alipay) for more details. |
alma | object | Alma is a Buy Now, Pay Later payment method that offers customers the ability to pay in 2, 3, or 4 installments. |
amazon_pay | object | Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. |
apple_pay | object | Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://docs.stripe.com/apple-pay) for more details. |
apple_pay_later | object | Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks. |
au_becs_debit | object | Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://docs.stripe.com/payments/au-becs-debit) for more details. |
bacs_debit | object | Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://docs.stripe.com/payments/payment-methods/bacs-debit) for more details. |
bancontact | object | Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://docs.stripe.com/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://docs.stripe.com/payments/bancontact) for more details. |
billie | object | Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. |
bizum | object | To enable Bizum, buyers need a Spanish IBAN from a bank connected to Bizum. Within their banking app, they can enable Bizum and link their mobile number to their IBAN. |
blik | object | BLIK is a [single use](https://docs.stripe.com/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://docs.stripe.com/payments/blik) for more details. |
boleto | object | Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://docs.stripe.com/payments/boleto) for more details. |
card | object | Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks. |
cartes_bancaires | object | Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://docs.stripe.com/payments/cartes-bancaires) for more details. |
cashapp | object | Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://docs.stripe.com/payments/cash-app-pay) for more details. |
crypto | object | [Stablecoin payments](https://docs.stripe.com/payments/stablecoin-payments) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. |
customer_balance | object | Uses a customer’s [cash balance](https://docs.stripe.com/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://docs.stripe.com/payments/bank-transfers) for more details. |
eps | object | EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://docs.stripe.com/payments/eps) for more details. |
expand | array of string | Specifies which fields in the response should be expanded. |
fpx | object | Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://docs.stripe.com/payments/fpx) for more details. |
fr_meal_voucher_conecs | object | Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://docs.stripe.com/payments/meal-vouchers/fr-meal-vouchers) for more details. |
giropay | object | giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://docs.stripe.com/payments/giropay) for more details. |
google_pay | object | Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://docs.stripe.com/google-pay) for more details. |
grabpay | object | GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://docs.stripe.com/payments/grabpay) for more details. |
ideal | object | iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://docs.stripe.com/payments/ideal) for more details. |
jcb | object | JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. |
kakao_pay | object | Kakao Pay is a popular local wallet available in South Korea. |
klarna | object | Klarna gives customers a range of [payment options](https://docs.stripe.com/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://docs.stripe.com/payments/klarna) for more details. |
konbini | object | Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://docs.stripe.com/payments/konbini) for more details. |
kr_card | object | Korean cards let users pay using locally issued cards from South Korea. |
link | object | [Link](https://docs.stripe.com/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. |
mb_way | object | MB WAY is the most popular wallet in Portugal. After entering their phone number in your checkout, customers approve the payment directly in their MB WAY app. Check this [page](https://docs.stripe.com/payments/mb-way) for more details. |
mobilepay | object | MobilePay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://docs.stripe.com/payments/mobilepay) for more details. |
multibanco | object | Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using [Sources](https://stripe.com/docs/sources)—a single integration path for creating payments using any supported method. |
name | string | Configuration name. |
naver_pay | object | Naver Pay is a popular local wallet available in South Korea. |
nz_bank_account | object | Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://docs.stripe.com/payments/nz-bank-account) for more details. |
oxxo | object | OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://docs.stripe.com/payments/oxxo) for more details. |
p24 | object | Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://docs.stripe.com/payments/p24) for more details. |
pay_by_bank | object | Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments. |
payco | object | PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. |
paynow | object | PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://docs.stripe.com/payments/paynow) for more details. |
paypal | object | PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://docs.stripe.com/payments/paypal) for more details. |
payto | object | PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details. |
pix | object | Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details. |
promptpay | object | PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://docs.stripe.com/payments/promptpay) for more details. |
revolut_pay | object | Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. |
samsung_pay | object | Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. |
satispay | object | Satispay is a [single-use](/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. |
scalapay | object | Scalapay is a [single-use](/payments/payment-methods#usage) payment method that lets customers pay in 3 or 4 installments. Customers are redirected from your website or app, authorize the payment with Scalapay, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. |
sepa_debit | object | The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://docs.stripe.com/payments/sepa-debit) for more details. |
sofort | object | Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://docs.stripe.com/payments/sofort) for more details. |
sunbit | object | Sunbit is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers choose to pay in 3, 6, or 12 installments. Customers are redirected from your website or app, authorize the payment with Sunbit, then return to your website or app. You get [immediate notification](https://docs.stripe.com/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. |
swish | object | Swish is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://docs.stripe.com/payments/swish) for more details. |
twint | object | Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this [page](https://docs.stripe.com/payments/twint) for more details. |
upi | object | Unified Payment Interface (UPI) is India's leading payment method with exponential growth since it launched in 2016. |
us_bank_account | object | Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://docs.stripe.com/payments/ach-direct-debit) for more details. |
wechat_pay | object | WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://docs.stripe.com/payments/wechat-pay) for more details. |
zip | object | Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://docs.stripe.com/payments/zip) for more details like country availability. |
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
acss_debit | payment_method_config_resource_payment_method_properties | |
active required | boolean | Whether the configuration can be used for new payments. |
affirm | payment_method_config_resource_payment_method_properties | |
afterpay_clearpay | payment_method_config_resource_payment_method_properties | |
alipay | payment_method_config_resource_payment_method_properties | |
alma | payment_method_config_resource_payment_method_properties | |
amazon_pay | payment_method_config_resource_payment_method_properties | |
apple_pay | payment_method_config_resource_payment_method_properties | |
application | string | For child configs, the Connect application associated with the configuration. |
au_becs_debit | payment_method_config_resource_payment_method_properties | |
bacs_debit | payment_method_config_resource_payment_method_properties | |
bancontact | payment_method_config_resource_payment_method_properties | |
billie | payment_method_config_resource_payment_method_properties | |
bizum | payment_method_config_resource_payment_method_properties | |
blik | payment_method_config_resource_payment_method_properties | |
boleto | payment_method_config_resource_payment_method_properties | |
card | payment_method_config_resource_payment_method_properties | |
cartes_bancaires | payment_method_config_resource_payment_method_properties | |
cashapp | payment_method_config_resource_payment_method_properties | |
crypto | payment_method_config_resource_payment_method_properties | |
customer_balance | payment_method_config_resource_payment_method_properties | |
eps | payment_method_config_resource_payment_method_properties | |
fpx | payment_method_config_resource_payment_method_properties | |
giropay | payment_method_config_resource_payment_method_properties | |
google_pay | payment_method_config_resource_payment_method_properties | |
grabpay | payment_method_config_resource_payment_method_properties | |
id required | string | Unique identifier for the object. |
ideal | payment_method_config_resource_payment_method_properties | |
is_default required | boolean | The default configuration is used whenever a payment method configuration is not specified. |
jcb | payment_method_config_resource_payment_method_properties | |
kakao_pay | payment_method_config_resource_payment_method_properties | |
klarna | payment_method_config_resource_payment_method_properties | |
konbini | payment_method_config_resource_payment_method_properties | |
kr_card | payment_method_config_resource_payment_method_properties | |
link | payment_method_config_resource_payment_method_properties | |
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_config_resource_payment_method_properties | |
mobilepay | payment_method_config_resource_payment_method_properties | |
multibanco | payment_method_config_resource_payment_method_properties | |
name required | string | The configuration's name. |
naver_pay | payment_method_config_resource_payment_method_properties | |
nz_bank_account | payment_method_config_resource_payment_method_properties | |
object required | string | String representing the object's type. Objects of the same type share the same value. |
oxxo | payment_method_config_resource_payment_method_properties | |
p24 | payment_method_config_resource_payment_method_properties | |
parent | string | For child configs, the configuration's parent configuration. |
pay_by_bank | payment_method_config_resource_payment_method_properties | |
payco | payment_method_config_resource_payment_method_properties | |
paynow | payment_method_config_resource_payment_method_properties | |
paypal | payment_method_config_resource_payment_method_properties | |
payto | payment_method_config_resource_payment_method_properties | |
pix | payment_method_config_resource_payment_method_properties | |
promptpay | payment_method_config_resource_payment_method_properties | |
revolut_pay | payment_method_config_resource_payment_method_properties | |
samsung_pay | payment_method_config_resource_payment_method_properties | |
satispay | payment_method_config_resource_payment_method_properties | |
scalapay | payment_method_config_resource_payment_method_properties | |
sepa_debit | payment_method_config_resource_payment_method_properties | |
sofort | payment_method_config_resource_payment_method_properties | |
sunbit | payment_method_config_resource_payment_method_properties | |
swish | payment_method_config_resource_payment_method_properties | |
twint | payment_method_config_resource_payment_method_properties | |
upi | payment_method_config_resource_payment_method_properties | |
us_bank_account | payment_method_config_resource_payment_method_properties | |
wechat_pay | payment_method_config_resource_payment_method_properties | |
zip | payment_method_config_resource_payment_method_properties |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |