Stripe.Resources.PaymentMethodConfiguration (tiger_stripe v0.3.0)

Copy Markdown View Source

PaymentMethodConfigResourcePaymentMethodConfiguration

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

t()

Types

acss_debit()

@type acss_debit() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => acss_debit_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

acss_debit_display_preference()

@type acss_debit_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

affirm()

@type affirm() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => affirm_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

affirm_display_preference()

@type affirm_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

afterpay_clearpay()

@type afterpay_clearpay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => afterpay_clearpay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

afterpay_clearpay_display_preference()

@type afterpay_clearpay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

alipay()

@type alipay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => alipay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

alipay_display_preference()

@type alipay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

alma()

@type alma() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => alma_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

alma_display_preference()

@type alma_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

amazon_pay()

@type amazon_pay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => amazon_pay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

amazon_pay_display_preference()

@type amazon_pay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

apple_pay()

@type apple_pay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => apple_pay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

apple_pay_display_preference()

@type apple_pay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

au_becs_debit()

@type au_becs_debit() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => au_becs_debit_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

au_becs_debit_display_preference()

@type au_becs_debit_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

bacs_debit()

@type bacs_debit() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => bacs_debit_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

bacs_debit_display_preference()

@type bacs_debit_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

bancontact()

@type bancontact() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => bancontact_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

bancontact_display_preference()

@type bancontact_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

billie()

@type billie() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => billie_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

billie_display_preference()

@type billie_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

blik()

@type blik() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => blik_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

blik_display_preference()

@type blik_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

boleto()

@type boleto() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => boleto_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

boleto_display_preference()

@type boleto_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

card()

@type card() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => card_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

card_display_preference()

@type card_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

cartes_bancaires()

@type cartes_bancaires() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => cartes_bancaires_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

cartes_bancaires_display_preference()

@type cartes_bancaires_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

cashapp()

@type cashapp() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => cashapp_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

cashapp_display_preference()

@type cashapp_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

crypto()

@type crypto() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => crypto_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

crypto_display_preference()

@type crypto_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

customer_balance()

@type customer_balance() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => customer_balance_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

customer_balance_display_preference()

@type customer_balance_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

eps()

@type eps() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => eps_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

eps_display_preference()

@type eps_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

fpx()

@type fpx() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => fpx_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

fpx_display_preference()

@type fpx_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

giropay()

@type giropay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => giropay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

giropay_display_preference()

@type giropay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

google_pay()

@type google_pay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => google_pay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

google_pay_display_preference()

@type google_pay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

grabpay()

@type grabpay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => grabpay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

grabpay_display_preference()

@type grabpay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

ideal()

@type ideal() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => ideal_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

ideal_display_preference()

@type ideal_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

jcb()

@type jcb() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => jcb_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

jcb_display_preference()

@type jcb_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

kakao_pay()

@type kakao_pay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => kakao_pay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

kakao_pay_display_preference()

@type kakao_pay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

klarna()

@type klarna() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => klarna_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

klarna_display_preference()

@type klarna_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

konbini()

@type konbini() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => konbini_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

konbini_display_preference()

@type konbini_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

kr_card()

@type kr_card() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => kr_card_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

kr_card_display_preference()

@type kr_card_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

link()

@type link() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => link_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

mb_way()

@type mb_way() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => mb_way_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

mb_way_display_preference()

@type mb_way_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

mobilepay()

@type mobilepay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => mobilepay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

mobilepay_display_preference()

@type mobilepay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

multibanco()

@type multibanco() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => multibanco_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

multibanco_display_preference()

@type multibanco_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

naver_pay()

@type naver_pay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => naver_pay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

naver_pay_display_preference()

@type naver_pay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

nz_bank_account()

@type nz_bank_account() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => nz_bank_account_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

nz_bank_account_display_preference()

@type nz_bank_account_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

oxxo()

@type oxxo() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => oxxo_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

oxxo_display_preference()

@type oxxo_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

p24()

@type p24() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => p24_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

p24_display_preference()

@type p24_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

pay_by_bank()

@type pay_by_bank() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => pay_by_bank_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

pay_by_bank_display_preference()

@type pay_by_bank_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

payco()

@type payco() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => payco_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

payco_display_preference()

@type payco_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

paynow()

@type paynow() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => paynow_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

paynow_display_preference()

@type paynow_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

paypal()

@type paypal() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => paypal_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

paypal_display_preference()

@type paypal_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

payto()

@type payto() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => payto_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

payto_display_preference()

@type payto_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

pix()

@type pix() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => pix_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

pix_display_preference()

@type pix_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

promptpay()

@type promptpay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => promptpay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

promptpay_display_preference()

@type promptpay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

revolut_pay()

@type revolut_pay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => revolut_pay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

revolut_pay_display_preference()

@type revolut_pay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

samsung_pay()

@type samsung_pay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => samsung_pay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

samsung_pay_display_preference()

@type samsung_pay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

satispay()

@type satispay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => satispay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

satispay_display_preference()

@type satispay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

sepa_debit()

@type sepa_debit() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => sepa_debit_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

sepa_debit_display_preference()

@type sepa_debit_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

sofort()

@type sofort() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => sofort_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

sofort_display_preference()

@type sofort_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

swish()

@type swish() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => swish_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

swish_display_preference()

@type swish_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

t()

@type t() :: %Stripe.Resources.PaymentMethodConfiguration{
  acss_debit: acss_debit() | nil,
  active: boolean(),
  affirm: affirm() | nil,
  afterpay_clearpay: afterpay_clearpay() | nil,
  alipay: alipay() | nil,
  alma: alma() | nil,
  amazon_pay: amazon_pay() | nil,
  apple_pay: apple_pay() | nil,
  application: String.t(),
  au_becs_debit: au_becs_debit() | nil,
  bacs_debit: bacs_debit() | nil,
  bancontact: bancontact() | nil,
  billie: billie() | nil,
  blik: blik() | nil,
  boleto: boleto() | nil,
  card: card() | nil,
  cartes_bancaires: cartes_bancaires() | nil,
  cashapp: cashapp() | nil,
  crypto: crypto() | nil,
  customer_balance: customer_balance() | nil,
  eps: eps() | nil,
  fpx: fpx() | nil,
  giropay: giropay() | nil,
  google_pay: google_pay() | nil,
  grabpay: grabpay() | nil,
  id: String.t(),
  ideal: ideal() | nil,
  is_default: boolean(),
  jcb: jcb() | nil,
  kakao_pay: kakao_pay() | nil,
  klarna: klarna() | nil,
  konbini: konbini() | nil,
  kr_card: kr_card() | nil,
  link: link() | nil,
  livemode: boolean(),
  mb_way: mb_way() | nil,
  mobilepay: mobilepay() | nil,
  multibanco: multibanco() | nil,
  name: String.t(),
  naver_pay: naver_pay() | nil,
  nz_bank_account: nz_bank_account() | nil,
  object: String.t(),
  oxxo: oxxo() | nil,
  p24: p24() | nil,
  parent: String.t(),
  pay_by_bank: pay_by_bank() | nil,
  payco: payco() | nil,
  paynow: paynow() | nil,
  paypal: paypal() | nil,
  payto: payto() | nil,
  pix: pix() | nil,
  promptpay: promptpay() | nil,
  revolut_pay: revolut_pay() | nil,
  samsung_pay: samsung_pay() | nil,
  satispay: satispay() | nil,
  sepa_debit: sepa_debit() | nil,
  sofort: sofort() | nil,
  swish: swish() | nil,
  twint: twint() | nil,
  us_bank_account: us_bank_account() | nil,
  wechat_pay: wechat_pay() | nil,
  zip: zip() | nil
}
  • acss_debit - Expandable.
  • active - Whether the configuration can be used for new payments.
  • affirm - Expandable.
  • afterpay_clearpay - Expandable.
  • alipay - Expandable.
  • alma - Expandable.
  • amazon_pay - Expandable.
  • apple_pay - Expandable.
  • application - For child configs, the Connect application associated with the configuration. Max length: 5000. Nullable.
  • au_becs_debit - Expandable.
  • bacs_debit - Expandable.
  • bancontact - Expandable.
  • billie - Expandable.
  • blik - Expandable.
  • boleto - Expandable.
  • card - Expandable.
  • cartes_bancaires - Expandable.
  • cashapp - Expandable.
  • crypto - Expandable.
  • customer_balance - Expandable.
  • eps - Expandable.
  • fpx - Expandable.
  • giropay - Expandable.
  • google_pay - Expandable.
  • grabpay - Expandable.
  • id - Unique identifier for the object. Max length: 5000.
  • ideal - Expandable.
  • is_default - The default configuration is used whenever a payment method configuration is not specified.
  • jcb - Expandable.
  • kakao_pay - Expandable.
  • klarna - Expandable.
  • konbini - Expandable.
  • kr_card - Expandable.
  • link - Expandable.
  • livemode - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • mb_way - Expandable.
  • mobilepay - Expandable.
  • multibanco - Expandable.
  • name - The configuration's name. Max length: 5000.
  • naver_pay - Expandable.
  • nz_bank_account - Expandable.
  • object - String representing the object's type. Objects of the same type share the same value. Possible values: payment_method_configuration.
  • oxxo - Expandable.
  • p24 - Expandable.
  • parent - For child configs, the configuration's parent configuration. Max length: 5000. Nullable.
  • pay_by_bank - Expandable.
  • payco - Expandable.
  • paynow - Expandable.
  • paypal - Expandable.
  • payto - Expandable.
  • pix - Expandable.
  • promptpay - Expandable.
  • revolut_pay - Expandable.
  • samsung_pay - Expandable.
  • satispay - Expandable.
  • sepa_debit - Expandable.
  • sofort - Expandable.
  • swish - Expandable.
  • twint - Expandable.
  • us_bank_account - Expandable.
  • wechat_pay - Expandable.
  • zip - Expandable.

twint()

@type twint() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => twint_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

twint_display_preference()

@type twint_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

us_bank_account()

@type us_bank_account() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => us_bank_account_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

us_bank_account_display_preference()

@type us_bank_account_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

wechat_pay()

@type wechat_pay() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => wechat_pay_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

wechat_pay_display_preference()

@type wechat_pay_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

zip()

@type zip() :: %{
  optional(:available) => boolean() | nil,
  optional(:display_preference) => zip_display_preference() | nil,
  optional(String.t()) => term()
}
  • available - Whether this payment method may be offered at checkout. True if display_preference is on and the payment method's capability is active.
  • display_preference

zip_display_preference()

@type zip_display_preference() :: %{
  optional(:overridable) => boolean() | nil,
  optional(:preference) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}
  • overridable - For child configs, whether or not the account's preference will be observed. If false, the parent configuration's default is used. Nullable.
  • preference - The account's display preference. Possible values: none, off, on.
  • value - The effective display preference value. Possible values: off, on.

Functions

expandable_fields()

object_name()