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:

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:

Defined Under Namespace

Classes: AcssDebit, Affirm, AfterpayClearpay, Alipay, Alma, AmazonPay, ApplePay, AuBecsDebit, BacsDebit, Bancontact, Billie, Blik, Boleto, Card, CartesBancaires, Cashapp, Crypto, CustomerBalance, Eps, Fpx, Giropay, GooglePay, Grabpay, Ideal, Jcb, KakaoPay, Klarna, Konbini, KrCard, Link, MbWay, Mobilepay, Multibanco, NaverPay, NzBankAccount, Oxxo, P24, PayByBank, Payco, Paynow, Paypal, Payto, Pix, Promptpay, RevolutPay, SamsungPay, Satispay, SepaDebit, Sofort, Sunbit, Swish, Twint, Upi, 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?, field_encodings, #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



1765
1766
1767
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1765

def acss_debit
  @acss_debit
end

#active ⇒ Object (readonly)

Whether the configuration can be used for new payments.



1767
1768
1769
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1767

def active
  @active
end

#affirm ⇒ Object (readonly)

Attribute for field affirm



1769
1770
1771
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1769

def affirm
  @affirm
end

#afterpay_clearpay ⇒ Object (readonly)

Attribute for field afterpay_clearpay



1771
1772
1773
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1771

def afterpay_clearpay
  @afterpay_clearpay
end

#alipay ⇒ Object (readonly)

Attribute for field alipay



1773
1774
1775
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1773

def alipay
  @alipay
end

#alma ⇒ Object (readonly)

Attribute for field alma



1775
1776
1777
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1775

def alma
  @alma
end

#amazon_pay ⇒ Object (readonly)

Attribute for field amazon_pay



1777
1778
1779
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1777

def amazon_pay
  @amazon_pay
end

#apple_pay ⇒ Object (readonly)

Attribute for field apple_pay



1779
1780
1781
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1779

def apple_pay
  @apple_pay
end

#application ⇒ Object (readonly)

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



1781
1782
1783
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1781

def application
  @application
end

#au_becs_debit ⇒ Object (readonly)

Attribute for field au_becs_debit



1783
1784
1785
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1783

def au_becs_debit
  @au_becs_debit
end

#bacs_debit ⇒ Object (readonly)

Attribute for field bacs_debit



1785
1786
1787
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1785

def bacs_debit
  @bacs_debit
end

#bancontact ⇒ Object (readonly)

Attribute for field bancontact



1787
1788
1789
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1787

def bancontact
  @bancontact
end

#billie ⇒ Object (readonly)

Attribute for field billie



1789
1790
1791
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1789

def billie
  @billie
end

#blik ⇒ Object (readonly)

Attribute for field blik



1791
1792
1793
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1791

def blik
  @blik
end

#boleto ⇒ Object (readonly)

Attribute for field boleto



1793
1794
1795
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1793

def boleto
  @boleto
end

#card ⇒ Object (readonly)

Attribute for field card



1795
1796
1797
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1795

def card
  @card
end

#cartes_bancaires ⇒ Object (readonly)

Attribute for field cartes_bancaires



1797
1798
1799
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1797

def cartes_bancaires
  @cartes_bancaires
end

#cashapp ⇒ Object (readonly)

Attribute for field cashapp



1799
1800
1801
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1799

def cashapp
  @cashapp
end

#crypto ⇒ Object (readonly)

Attribute for field crypto



1801
1802
1803
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1801

def crypto
  @crypto
end

#customer_balance ⇒ Object (readonly)

Attribute for field customer_balance



1803
1804
1805
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1803

def customer_balance
  @customer_balance
end

#eps ⇒ Object (readonly)

Attribute for field eps



1805
1806
1807
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1805

def eps
  @eps
end

#fpx ⇒ Object (readonly)

Attribute for field fpx



1807
1808
1809
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1807

def fpx
  @fpx
end

#giropay ⇒ Object (readonly)

Attribute for field giropay



1809
1810
1811
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1809

def giropay
  @giropay
end

#google_pay ⇒ Object (readonly)

Attribute for field google_pay



1811
1812
1813
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1811

def google_pay
  @google_pay
end

#grabpay ⇒ Object (readonly)

Attribute for field grabpay



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

def grabpay
  @grabpay
end

#id ⇒ Object (readonly)

Unique identifier for the object.



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

def id
  @id
end

#ideal ⇒ Object (readonly)

Attribute for field ideal



1817
1818
1819
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1817

def ideal
  @ideal
end

#is_default ⇒ Object (readonly)

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



1819
1820
1821
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1819

def is_default
  @is_default
end

#jcb ⇒ Object (readonly)

Attribute for field jcb



1821
1822
1823
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1821

def jcb
  @jcb
end

#kakao_pay ⇒ Object (readonly)

Attribute for field kakao_pay



1823
1824
1825
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1823

def kakao_pay
  @kakao_pay
end

#klarna ⇒ Object (readonly)

Attribute for field klarna



1825
1826
1827
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1825

def klarna
  @klarna
end

#konbini ⇒ Object (readonly)

Attribute for field konbini



1827
1828
1829
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1827

def konbini
  @konbini
end

#kr_card ⇒ Object (readonly)

Attribute for field kr_card



1829
1830
1831
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1829

def kr_card
  @kr_card
end

#link ⇒ Object (readonly)

Attribute for field link



1831
1832
1833
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1831

def link
  @link
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.



1833
1834
1835
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1833

def livemode
  @livemode
end

#mb_way ⇒ Object (readonly)

Attribute for field mb_way



1835
1836
1837
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1835

def mb_way
  @mb_way
end

#mobilepay ⇒ Object (readonly)

Attribute for field mobilepay



1837
1838
1839
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1837

def mobilepay
  @mobilepay
end

#multibanco ⇒ Object (readonly)

Attribute for field multibanco



1839
1840
1841
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1839

def multibanco
  @multibanco
end

#name ⇒ Object (readonly)

The configuration's name.



1841
1842
1843
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1841

def name
  @name
end

#naver_pay ⇒ Object (readonly)

Attribute for field naver_pay



1843
1844
1845
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1843

def naver_pay
  @naver_pay
end

#nz_bank_account ⇒ Object (readonly)

Attribute for field nz_bank_account



1845
1846
1847
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1845

def 
  @nz_bank_account
end

#object ⇒ Object (readonly)

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



1847
1848
1849
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1847

def object
  @object
end

#oxxo ⇒ Object (readonly)

Attribute for field oxxo



1849
1850
1851
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1849

def oxxo
  @oxxo
end

#p24 ⇒ Object (readonly)

Attribute for field p24



1851
1852
1853
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1851

def p24
  @p24
end

#parent ⇒ Object (readonly)

For child configs, the configuration's parent configuration.



1853
1854
1855
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1853

def parent
  @parent
end

#pay_by_bank ⇒ Object (readonly)

Attribute for field pay_by_bank



1855
1856
1857
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1855

def pay_by_bank
  @pay_by_bank
end

#payco ⇒ Object (readonly)

Attribute for field payco



1857
1858
1859
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1857

def payco
  @payco
end

#paynow ⇒ Object (readonly)

Attribute for field paynow



1859
1860
1861
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1859

def paynow
  @paynow
end

#paypal ⇒ Object (readonly)

Attribute for field paypal



1861
1862
1863
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1861

def paypal
  @paypal
end

#payto ⇒ Object (readonly)

Attribute for field payto



1863
1864
1865
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1863

def payto
  @payto
end

#pix ⇒ Object (readonly)

Attribute for field pix



1865
1866
1867
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1865

def pix
  @pix
end

#promptpay ⇒ Object (readonly)

Attribute for field promptpay



1867
1868
1869
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1867

def promptpay
  @promptpay
end

#revolut_pay ⇒ Object (readonly)

Attribute for field revolut_pay



1869
1870
1871
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1869

def revolut_pay
  @revolut_pay
end

#samsung_pay ⇒ Object (readonly)

Attribute for field samsung_pay



1871
1872
1873
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1871

def samsung_pay
  @samsung_pay
end

#satispay ⇒ Object (readonly)

Attribute for field satispay



1873
1874
1875
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1873

def satispay
  @satispay
end

#sepa_debit ⇒ Object (readonly)

Attribute for field sepa_debit



1875
1876
1877
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1875

def sepa_debit
  @sepa_debit
end

#sofort ⇒ Object (readonly)

Attribute for field sofort



1877
1878
1879
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1877

def sofort
  @sofort
end

#sunbit ⇒ Object (readonly)

Attribute for field sunbit



1879
1880
1881
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1879

def sunbit
  @sunbit
end

#swish ⇒ Object (readonly)

Attribute for field swish



1881
1882
1883
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1881

def swish
  @swish
end

#twint ⇒ Object (readonly)

Attribute for field twint



1883
1884
1885
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1883

def twint
  @twint
end

#upi ⇒ Object (readonly)

Attribute for field upi



1885
1886
1887
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1885

def upi
  @upi
end

#us_bank_account ⇒ Object (readonly)

Attribute for field us_bank_account



1887
1888
1889
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1887

def 
  @us_bank_account
end

#wechat_pay ⇒ Object (readonly)

Attribute for field wechat_pay



1889
1890
1891
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1889

def wechat_pay
  @wechat_pay
end

#zip ⇒ Object (readonly)

Attribute for field zip



1891
1892
1893
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1891

def zip
  @zip
end

Class Method Details

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

Creates a payment method configuration



1894
1895
1896
1897
1898
1899
1900
1901
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1894

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

.field_remappings ⇒ Object 



1984
1985
1986
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1984

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1923

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,
    crypto: Crypto,
    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,
    mb_way: MbWay,
    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,
    payto: Payto,
    pix: Pix,
    promptpay: Promptpay,
    revolut_pay: RevolutPay,
    samsung_pay: SamsungPay,
    satispay: Satispay,
    sepa_debit: SepaDebit,
    sofort: Sofort,
    sunbit: Sunbit,
    swish: Swish,
    twint: Twint,
    upi: Upi,
    us_bank_account: UsBankAccount,
    wechat_pay: WechatPay,
    zip: Zip,
  }
end

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

List payment method configurations



1904
1905
1906
1907
1908
1909
1910
1911
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1904

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



1914
1915
1916
1917
1918
1919
1920
1921
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 1914

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