Class: Stripe::PaymentMethodConfiguration

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/payment_method_configuration.rb

Overview

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](stripe.com/docs/connect/charges):

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](dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API.

Related guides:

Defined Under Namespace

Classes: AcssDebit, Affirm, AfterpayClearpay, Alipay, Alma, AmazonPay, ApplePay, AuBecsDebit, BacsDebit, Bancontact, Billie, Blik, Boleto, Card, CartesBancaires, Cashapp, CustomerBalance, Eps, Fpx, Giropay, GooglePay, Grabpay, Ideal, Jcb, KakaoPay, Klarna, Konbini, KrCard, Link, Mobilepay, Multibanco, NaverPay, NzBankAccount, Oxxo, P24, PayByBank, Payco, Paynow, Paypal, Pix, Promptpay, RevolutPay, SamsungPay, Satispay, SepaDebit, Sofort, Swish, Twint, UsBankAccount, WechatPay, Zip

Constant Summary collapse

OBJECT_NAME = 
"payment_method_configuration"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#acss_debit ⇒ Object (readonly)

Attribute for field acss_debit



1610
1611
1612
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1610

def acss_debit
  @acss_debit
end

#active ⇒ Object (readonly)

Whether the configuration can be used for new payments.



1612
1613
1614
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1612

def active
  @active
end

#affirm ⇒ Object (readonly)

Attribute for field affirm



1614
1615
1616
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1614

def affirm
  @affirm
end

#afterpay_clearpay ⇒ Object (readonly)

Attribute for field afterpay_clearpay



1616
1617
1618
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1616

def afterpay_clearpay
  @afterpay_clearpay
end

#alipay ⇒ Object (readonly)

Attribute for field alipay



1618
1619
1620
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1618

def alipay
  @alipay
end

#alma ⇒ Object (readonly)

Attribute for field alma



1620
1621
1622
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1620

def alma
  @alma
end

#amazon_pay ⇒ Object (readonly)

Attribute for field amazon_pay



1622
1623
1624
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1622

def amazon_pay
  @amazon_pay
end

#apple_pay ⇒ Object (readonly)

Attribute for field apple_pay



1624
1625
1626
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1624

def apple_pay
  @apple_pay
end

#application ⇒ Object (readonly)

For child configs, the Connect application associated with the configuration.



1626
1627
1628
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1626

def application
  @application
end

#au_becs_debit ⇒ Object (readonly)

Attribute for field au_becs_debit



1628
1629
1630
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1628

def au_becs_debit
  @au_becs_debit
end

#bacs_debit ⇒ Object (readonly)

Attribute for field bacs_debit



1630
1631
1632
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1630

def bacs_debit
  @bacs_debit
end

#bancontact ⇒ Object (readonly)

Attribute for field bancontact



1632
1633
1634
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1632

def bancontact
  @bancontact
end

#billie ⇒ Object (readonly)

Attribute for field billie



1634
1635
1636
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1634

def billie
  @billie
end

#blik ⇒ Object (readonly)

Attribute for field blik



1636
1637
1638
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1636

def blik
  @blik
end

#boleto ⇒ Object (readonly)

Attribute for field boleto



1638
1639
1640
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1638

def boleto
  @boleto
end

#card ⇒ Object (readonly)

Attribute for field card



1640
1641
1642
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1640

def card
  @card
end

#cartes_bancaires ⇒ Object (readonly)

Attribute for field cartes_bancaires



1642
1643
1644
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1642

def cartes_bancaires
  @cartes_bancaires
end

#cashapp ⇒ Object (readonly)

Attribute for field cashapp



1644
1645
1646
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1644

def cashapp
  @cashapp
end

#customer_balance ⇒ Object (readonly)

Attribute for field customer_balance



1646
1647
1648
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1646

def customer_balance
  @customer_balance
end

#eps ⇒ Object (readonly)

Attribute for field eps



1648
1649
1650
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1648

def eps
  @eps
end

#fpx ⇒ Object (readonly)

Attribute for field fpx



1650
1651
1652
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1650

def fpx
  @fpx
end

#giropay ⇒ Object (readonly)

Attribute for field giropay



1652
1653
1654
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1652

def giropay
  @giropay
end

#google_pay ⇒ Object (readonly)

Attribute for field google_pay



1654
1655
1656
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1654

def google_pay
  @google_pay
end

#grabpay ⇒ Object (readonly)

Attribute for field grabpay



1656
1657
1658
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1656

def grabpay
  @grabpay
end

#id ⇒ Object (readonly)

Unique identifier for the object.



1658
1659
1660
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1658

def id
  @id
end

#ideal ⇒ Object (readonly)

Attribute for field ideal



1660
1661
1662
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1660

def ideal
  @ideal
end

#is_default ⇒ Object (readonly)

The default configuration is used whenever a payment method configuration is not specified.



1662
1663
1664
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1662

def is_default
  @is_default
end

#jcb ⇒ Object (readonly)

Attribute for field jcb



1664
1665
1666
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1664

def jcb
  @jcb
end

#kakao_pay ⇒ Object (readonly)

Attribute for field kakao_pay



1666
1667
1668
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1666

def kakao_pay
  @kakao_pay
end

#klarna ⇒ Object (readonly)

Attribute for field klarna



1668
1669
1670
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1668

def klarna
  @klarna
end

#konbini ⇒ Object (readonly)

Attribute for field konbini



1670
1671
1672
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1670

def konbini
  @konbini
end

#kr_card ⇒ Object (readonly)

Attribute for field kr_card



1672
1673
1674
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1672

def kr_card
  @kr_card
end

#link ⇒ Object (readonly)

Attribute for field link



1674
1675
1676
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1674

def link
  @link
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



1676
1677
1678
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1676

def livemode
  @livemode
end

#mobilepay ⇒ Object (readonly)

Attribute for field mobilepay



1678
1679
1680
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1678

def mobilepay
  @mobilepay
end

#multibanco ⇒ Object (readonly)

Attribute for field multibanco



1680
1681
1682
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1680

def multibanco
  @multibanco
end

#name ⇒ Object (readonly)

The configuration’s name.



1682
1683
1684
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1682

def name
  @name
end

#naver_pay ⇒ Object (readonly)

Attribute for field naver_pay



1684
1685
1686
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1684

def naver_pay
  @naver_pay
end

#nz_bank_account ⇒ Object (readonly)

Attribute for field nz_bank_account



1686
1687
1688
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1686

def 
  @nz_bank_account
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



1688
1689
1690
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1688

def object
  @object
end

#oxxo ⇒ Object (readonly)

Attribute for field oxxo



1690
1691
1692
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1690

def oxxo
  @oxxo
end

#p24 ⇒ Object (readonly)

Attribute for field p24



1692
1693
1694
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1692

def p24
  @p24
end

#parent ⇒ Object (readonly)

For child configs, the configuration’s parent configuration.



1694
1695
1696
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1694

def parent
  @parent
end

#pay_by_bank ⇒ Object (readonly)

Attribute for field pay_by_bank



1696
1697
1698
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1696

def pay_by_bank
  @pay_by_bank
end

#payco ⇒ Object (readonly)

Attribute for field payco



1698
1699
1700
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1698

def payco
  @payco
end

#paynow ⇒ Object (readonly)

Attribute for field paynow



1700
1701
1702
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1700

def paynow
  @paynow
end

#paypal ⇒ Object (readonly)

Attribute for field paypal



1702
1703
1704
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1702

def paypal
  @paypal
end

#pix ⇒ Object (readonly)

Attribute for field pix



1704
1705
1706
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1704

def pix
  @pix
end

#promptpay ⇒ Object (readonly)

Attribute for field promptpay



1706
1707
1708
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1706

def promptpay
  @promptpay
end

#revolut_pay ⇒ Object (readonly)

Attribute for field revolut_pay



1708
1709
1710
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1708

def revolut_pay
  @revolut_pay
end

#samsung_pay ⇒ Object (readonly)

Attribute for field samsung_pay



1710
1711
1712
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1710

def samsung_pay
  @samsung_pay
end

#satispay ⇒ Object (readonly)

Attribute for field satispay



1712
1713
1714
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1712

def satispay
  @satispay
end

#sepa_debit ⇒ Object (readonly)

Attribute for field sepa_debit



1714
1715
1716
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1714

def sepa_debit
  @sepa_debit
end

#sofort ⇒ Object (readonly)

Attribute for field sofort



1716
1717
1718
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1716

def sofort
  @sofort
end

#swish ⇒ Object (readonly)

Attribute for field swish



1718
1719
1720
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1718

def swish
  @swish
end

#twint ⇒ Object (readonly)

Attribute for field twint



1720
1721
1722
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1720

def twint
  @twint
end

#us_bank_account ⇒ Object (readonly)

Attribute for field us_bank_account



1722
1723
1724
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1722

def 
  @us_bank_account
end

#wechat_pay ⇒ Object (readonly)

Attribute for field wechat_pay



1724
1725
1726
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1724

def wechat_pay
  @wechat_pay
end

#zip ⇒ Object (readonly)

Attribute for field zip



1726
1727
1728
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1726

def zip
  @zip
end

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Creates a payment method configuration



1729
1730
1731
1732
1733
1734
1735
1736
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1729

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/payment_method_configurations",
    params: params,
    opts: opts
  )
end

.field_remappings ⇒ Object 



1814
1815
1816
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1814

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1758

def self.inner_class_types
  @inner_class_types = {
    acss_debit: AcssDebit,
    affirm: Affirm,
    afterpay_clearpay: AfterpayClearpay,
    alipay: Alipay,
    alma: Alma,
    amazon_pay: AmazonPay,
    apple_pay: ApplePay,
    au_becs_debit: AuBecsDebit,
    bacs_debit: BacsDebit,
    bancontact: Bancontact,
    billie: Billie,
    blik: Blik,
    boleto: Boleto,
    card: Card,
    cartes_bancaires: CartesBancaires,
    cashapp: Cashapp,
    customer_balance: CustomerBalance,
    eps: Eps,
    fpx: Fpx,
    giropay: Giropay,
    google_pay: GooglePay,
    grabpay: Grabpay,
    ideal: Ideal,
    jcb: Jcb,
    kakao_pay: KakaoPay,
    klarna: Klarna,
    konbini: Konbini,
    kr_card: KrCard,
    link: Link,
    mobilepay: Mobilepay,
    multibanco: Multibanco,
    naver_pay: NaverPay,
    nz_bank_account: NzBankAccount,
    oxxo: Oxxo,
    p24: P24,
    pay_by_bank: PayByBank,
    payco: Payco,
    paynow: Paynow,
    paypal: Paypal,
    pix: Pix,
    promptpay: Promptpay,
    revolut_pay: RevolutPay,
    samsung_pay: SamsungPay,
    satispay: Satispay,
    sepa_debit: SepaDebit,
    sofort: Sofort,
    swish: Swish,
    twint: Twint,
    us_bank_account: UsBankAccount,
    wechat_pay: WechatPay,
    zip: Zip,
  }
end

.list(params = {}, opts = {}) ⇒ Object

List payment method configurations



1739
1740
1741
1742
1743
1744
1745
1746
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1739

def self.list(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/payment_method_configurations",
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



25
26
27
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 25

def self.object_name
  "payment_method_configuration"
end

.update(configuration, params = {}, opts = {}) ⇒ Object

Update payment method configuration



1749
1750
1751
1752
1753
1754
1755
1756
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1749

def self.update(configuration, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/payment_method_configurations/%<configuration>s", { configuration: CGI.escape(configuration) }),
    params: params,
    opts: opts
  )
end