View Source Stripe.PaymentMethodConfiguration (stripity_stripe v3.2.0)

PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.

There are two types of PaymentMethodConfigurations. Which is used depends on the charge type:

Direct configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.

Child configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.

Child configurations have a parent that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are managed in the dashboard and are not available in this API.

Related guides:

Summary

Types

acss_debit()

Canadian pre-authorized debit payments, check this page for more details like country availability.

affirm()

Affirm 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 for more details like country availability.

afterpay_clearpay()

Afterpay gives your customers a way to pay for purchases in installments, check this page for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.

alipay()

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 for more details.

apple_pay()

Stripe users can accept 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 is the same as other card transactions. Check this page for more details.

apple_pay_later()

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()

Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this page for more details.

bacs_debit()

Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this page for more details.

bancontact()

Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. 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 for more details.

blik()

BLIK is a single use 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 for more details.

boleto()

Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this page for more details.

card()

Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.

cartes_bancaires()

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 for more details.

cashapp()

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 for more details.

display_preference()

Whether or not the payment method should be displayed.

eps()

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 for more details.

fpx()

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 for more details.

giropay()

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 for more details.

google_pay()

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 for more details.

grabpay()

GrabPay is a payment method developed by Grab. GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this page for more details.

ideal()

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 for more details.

jcb()

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 for more details.

klarna()

Klarna gives customers a range of 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 for more details.

konbini()

Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this page for more details.

link()

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.

oxxo()

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 for more details.

p24()

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 for more details.

paynow()

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 for more details.

paypal()

PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this page for more details.

promptpay()

PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this page for more details.

revolut_pay()

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.

sepa_debit()

The Single Euro Payments Area (SEPA) 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 for more details.

sofort()

Stripe users in Europe and the United States can use the Payment Intents API—a single integration path for creating payments using any supported method—to accept Sofort payments from customers. Check this page for more details.

t()

The payment_method_configuration type.

us_bank_account()

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 for more details.

wechat_pay()

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 for more details.

Functions

create(params \\ %{}, opts \\ [])

Creates a payment method configuration

list(params \\ %{}, opts \\ [])

List payment method configurations

retrieve(configuration, params \\ %{}, opts \\ [])

Retrieve payment method configuration

update(configuration, params \\ %{}, opts \\ [])

Update payment method configuration

Types

acss_debit()

@type acss_debit() :: %{optional(:display_preference) => display_preference()}

Canadian pre-authorized debit payments, check this page for more details like country availability.

affirm()

@type affirm() :: %{optional(:display_preference) => display_preference()}

afterpay_clearpay()

@type afterpay_clearpay() :: %{optional(:display_preference) => display_preference()}

alipay()

@type alipay() :: %{optional(:display_preference) => display_preference()}

apple_pay()

@type apple_pay() :: %{optional(:display_preference) => display_preference()}

apple_pay_later()

@type apple_pay_later() :: %{optional(:display_preference) => display_preference()}

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()

@type au_becs_debit() :: %{optional(:display_preference) => display_preference()}

Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this page for more details.

bacs_debit()

@type bacs_debit() :: %{optional(:display_preference) => display_preference()}

Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this page for more details.

bancontact()

@type bancontact() :: %{optional(:display_preference) => display_preference()}

blik()

@type blik() :: %{optional(:display_preference) => display_preference()}

boleto()

@type boleto() :: %{optional(:display_preference) => display_preference()}

Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this page for more details.

card()

@type card() :: %{optional(:display_preference) => display_preference()}

Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.

cartes_bancaires()

@type cartes_bancaires() :: %{optional(:display_preference) => display_preference()}

cashapp()

@type cashapp() :: %{optional(:display_preference) => display_preference()}

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 for more details.

display_preference()

@type display_preference() :: %{optional(:preference) => :none | :off | :on}

Whether or not the payment method should be displayed.

eps()

@type eps() :: %{optional(:display_preference) => display_preference()}

fpx()

@type fpx() :: %{optional(:display_preference) => display_preference()}

giropay()

@type giropay() :: %{optional(:display_preference) => display_preference()}

google_pay()

@type google_pay() :: %{optional(:display_preference) => display_preference()}

grabpay()

@type grabpay() :: %{optional(:display_preference) => display_preference()}

GrabPay is a payment method developed by Grab. GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this page for more details.

ideal()

@type ideal() :: %{optional(:display_preference) => display_preference()}

jcb()

@type jcb() :: %{optional(:display_preference) => display_preference()}

klarna()

@type klarna() :: %{optional(:display_preference) => display_preference()}

konbini()

@type konbini() :: %{optional(:display_preference) => display_preference()}

Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this page for more details.

link()

@type link() :: %{optional(:display_preference) => display_preference()}

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.

oxxo()

@type oxxo() :: %{optional(:display_preference) => display_preference()}

p24()

@type p24() :: %{optional(:display_preference) => display_preference()}

paynow()

@type paynow() :: %{optional(:display_preference) => display_preference()}

paypal()

@type paypal() :: %{optional(:display_preference) => display_preference()}

PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this page for more details.

promptpay()

@type promptpay() :: %{optional(:display_preference) => display_preference()}

PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this page for more details.

revolut_pay()

@type revolut_pay() :: %{optional(:display_preference) => display_preference()}

sepa_debit()

@type sepa_debit() :: %{optional(:display_preference) => display_preference()}

sofort()

@type sofort() :: %{optional(:display_preference) => display_preference()}

t()

@type t() :: %Stripe.PaymentMethodConfiguration{
  acss_debit: term(),
  active: boolean(),
  affirm: term(),
  afterpay_clearpay: term(),
  alipay: term(),
  apple_pay: term(),
  application: binary() | nil,
  au_becs_debit: term(),
  bacs_debit: term(),
  bancontact: term(),
  blik: term(),
  boleto: term(),
  card: term(),
  cartes_bancaires: term(),
  cashapp: term(),
  eps: term(),
  fpx: term(),
  giropay: term(),
  google_pay: term(),
  grabpay: term(),
  id: binary(),
  ideal: term(),
  is_default: boolean(),
  jcb: term(),
  klarna: term(),
  konbini: term(),
  link: term(),
  livemode: boolean(),
  name: binary(),
  object: binary(),
  oxxo: term(),
  p24: term(),
  parent: binary() | nil,
  paynow: term(),
  paypal: term(),
  promptpay: term(),
  revolut_pay: term(),
  sepa_debit: term(),
  sofort: term(),
  us_bank_account: term(),
  wechat_pay: term()
}

The payment_method_configuration type.

acss_debit
active Whether the configuration can be used for new payments.
affirm
afterpay_clearpay
alipay
apple_pay
application For child configs, the Connect application associated with the configuration.
au_becs_debit
bacs_debit
bancontact
blik
boleto
card
cartes_bancaires
cashapp
eps
fpx
giropay
google_pay
grabpay
id Unique identifier for the object.
ideal
is_default The default configuration is used whenever a payment method configuration is not specified.
jcb
klarna
konbini
link
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
name The configuration's name.
object String representing the object's type. Objects of the same type share the same value.
oxxo
p24
parent For child configs, the configuration's parent configuration.
paynow
paypal
promptpay
revolut_pay
sepa_debit
sofort
us_bank_account
wechat_pay

us_bank_account()

@type us_bank_account() :: %{optional(:display_preference) => display_preference()}

wechat_pay()

@type wechat_pay() :: %{optional(:display_preference) => display_preference()}

Functions

create(params \\ %{}, opts \\ [])

@spec create(
  params :: %{
    optional(:fpx) => fpx(),
    optional(:name) => binary(),
    optional(:affirm) => affirm(),
    optional(:acss_debit) => acss_debit(),
    optional(:bacs_debit) => bacs_debit(),
    optional(:alipay) => alipay(),
    optional(:giropay) => giropay(),
    optional(:ideal) => ideal(),
    optional(:revolut_pay) => revolut_pay(),
    optional(:expand) => [binary()],
    optional(:card) => card(),
    optional(:link) => link(),
    optional(:promptpay) => promptpay(),
    optional(:cashapp) => cashapp(),
    optional(:oxxo) => oxxo(),
    optional(:us_bank_account) => us_bank_account(),
    optional(:paypal) => paypal(),
    optional(:boleto) => boleto(),
    optional(:jcb) => jcb(),
    optional(:konbini) => konbini(),
    optional(:blik) => blik(),
    optional(:wechat_pay) => wechat_pay(),
    optional(:sofort) => sofort(),
    optional(:apple_pay) => apple_pay(),
    optional(:p24) => p24(),
    optional(:google_pay) => google_pay(),
    optional(:afterpay_clearpay) => afterpay_clearpay(),
    optional(:cartes_bancaires) => cartes_bancaires(),
    optional(:grabpay) => grabpay(),
    optional(:apple_pay_later) => apple_pay_later(),
    optional(:parent) => binary(),
    optional(:bancontact) => bancontact(),
    optional(:au_becs_debit) => au_becs_debit(),
    optional(:sepa_debit) => sepa_debit(),
    optional(:klarna) => klarna(),
    optional(:paynow) => paynow(),
    optional(:eps) => eps()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates a payment method configuration

Details

Method: post
Path: /v1/payment_method_configurations

list(params \\ %{}, opts \\ [])

@spec list(
  params :: %{
    optional(:application) => binary() | binary(),
    optional(:expand) => [binary()]
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

List payment method configurations

Details

Method: get
Path: /v1/payment_method_configurations

retrieve(configuration, params \\ %{}, opts \\ [])

@spec retrieve(
  configuration :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieve payment method configuration

Details

Method: get
Path: /v1/payment_method_configurations/{configuration}

update(configuration, params \\ %{}, opts \\ [])

@spec update(
  configuration :: binary(),
  params :: %{
    optional(:fpx) => fpx(),
    optional(:name) => binary(),
    optional(:affirm) => affirm(),
    optional(:acss_debit) => acss_debit(),
    optional(:bacs_debit) => bacs_debit(),
    optional(:alipay) => alipay(),
    optional(:giropay) => giropay(),
    optional(:ideal) => ideal(),
    optional(:revolut_pay) => revolut_pay(),
    optional(:expand) => [binary()],
    optional(:card) => card(),
    optional(:active) => boolean(),
    optional(:link) => link(),
    optional(:promptpay) => promptpay(),
    optional(:cashapp) => cashapp(),
    optional(:oxxo) => oxxo(),
    optional(:us_bank_account) => us_bank_account(),
    optional(:paypal) => paypal(),
    optional(:boleto) => boleto(),
    optional(:jcb) => jcb(),
    optional(:konbini) => konbini(),
    optional(:blik) => blik(),
    optional(:wechat_pay) => wechat_pay(),
    optional(:sofort) => sofort(),
    optional(:apple_pay) => apple_pay(),
    optional(:p24) => p24(),
    optional(:google_pay) => google_pay(),
    optional(:afterpay_clearpay) => afterpay_clearpay(),
    optional(:cartes_bancaires) => cartes_bancaires(),
    optional(:grabpay) => grabpay(),
    optional(:apple_pay_later) => apple_pay_later(),
    optional(:bancontact) => bancontact(),
    optional(:au_becs_debit) => au_becs_debit(),
    optional(:sepa_debit) => sepa_debit(),
    optional(:klarna) => klarna(),
    optional(:paynow) => paynow(),
    optional(:eps) => eps()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Update payment method configuration

Details

Method: post
Path: /v1/payment_method_configurations/{configuration}