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, CreateParams, CustomerBalance, Eps, Fpx, Giropay, GooglePay, Grabpay, Ideal, Jcb, Klarna, Konbini, Link, ListParams, Mobilepay, Multibanco, NzBankAccount, Oxxo, P24, PayByBank, Paynow, Paypal, Promptpay, RevolutPay, Satispay, SepaDebit, Sofort, Swish, Twint, UpdateParams, 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

#==, #[], #[]=, 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



2699
2700
2701
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2699

def acss_debit
  @acss_debit
end

#active ⇒ Object (readonly)

Whether the configuration can be used for new payments.



2701
2702
2703
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2701

def active
  @active
end

#affirm ⇒ Object (readonly)

Attribute for field affirm



2703
2704
2705
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2703

def affirm
  @affirm
end

#afterpay_clearpay ⇒ Object (readonly)

Attribute for field afterpay_clearpay



2705
2706
2707
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2705

def afterpay_clearpay
  @afterpay_clearpay
end

#alipay ⇒ Object (readonly)

Attribute for field alipay



2707
2708
2709
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2707

def alipay
  @alipay
end

#alma ⇒ Object (readonly)

Attribute for field alma



2709
2710
2711
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2709

def alma
  @alma
end

#amazon_pay ⇒ Object (readonly)

Attribute for field amazon_pay



2711
2712
2713
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2711

def amazon_pay
  @amazon_pay
end

#apple_pay ⇒ Object (readonly)

Attribute for field apple_pay



2713
2714
2715
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2713

def apple_pay
  @apple_pay
end

#application ⇒ Object (readonly)

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



2715
2716
2717
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2715

def application
  @application
end

#au_becs_debit ⇒ Object (readonly)

Attribute for field au_becs_debit



2717
2718
2719
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2717

def au_becs_debit
  @au_becs_debit
end

#bacs_debit ⇒ Object (readonly)

Attribute for field bacs_debit



2719
2720
2721
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2719

def bacs_debit
  @bacs_debit
end

#bancontact ⇒ Object (readonly)

Attribute for field bancontact



2721
2722
2723
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2721

def bancontact
  @bancontact
end

#billie ⇒ Object (readonly)

Attribute for field billie



2723
2724
2725
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2723

def billie
  @billie
end

#blik ⇒ Object (readonly)

Attribute for field blik



2725
2726
2727
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2725

def blik
  @blik
end

#boleto ⇒ Object (readonly)

Attribute for field boleto



2727
2728
2729
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2727

def boleto
  @boleto
end

#card ⇒ Object (readonly)

Attribute for field card



2729
2730
2731
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2729

def card
  @card
end

#cartes_bancaires ⇒ Object (readonly)

Attribute for field cartes_bancaires



2731
2732
2733
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2731

def cartes_bancaires
  @cartes_bancaires
end

#cashapp ⇒ Object (readonly)

Attribute for field cashapp



2733
2734
2735
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2733

def cashapp
  @cashapp
end

#customer_balance ⇒ Object (readonly)

Attribute for field customer_balance



2735
2736
2737
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2735

def customer_balance
  @customer_balance
end

#eps ⇒ Object (readonly)

Attribute for field eps



2737
2738
2739
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2737

def eps
  @eps
end

#fpx ⇒ Object (readonly)

Attribute for field fpx



2739
2740
2741
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2739

def fpx
  @fpx
end

#giropay ⇒ Object (readonly)

Attribute for field giropay



2741
2742
2743
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2741

def giropay
  @giropay
end

#google_pay ⇒ Object (readonly)

Attribute for field google_pay



2743
2744
2745
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2743

def google_pay
  @google_pay
end

#grabpay ⇒ Object (readonly)

Attribute for field grabpay



2745
2746
2747
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2745

def grabpay
  @grabpay
end

#id ⇒ Object (readonly)

Unique identifier for the object.



2747
2748
2749
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2747

def id
  @id
end

#ideal ⇒ Object (readonly)

Attribute for field ideal



2749
2750
2751
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2749

def ideal
  @ideal
end

#is_default ⇒ Object (readonly)

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



2751
2752
2753
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2751

def is_default
  @is_default
end

#jcb ⇒ Object (readonly)

Attribute for field jcb



2753
2754
2755
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2753

def jcb
  @jcb
end

#klarna ⇒ Object (readonly)

Attribute for field klarna



2755
2756
2757
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2755

def klarna
  @klarna
end

#konbini ⇒ Object (readonly)

Attribute for field konbini



2757
2758
2759
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2757

def konbini
  @konbini
end

#link ⇒ Object (readonly)

Attribute for field link



2759
2760
2761
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2759

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.



2761
2762
2763
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2761

def livemode
  @livemode
end

#mobilepay ⇒ Object (readonly)

Attribute for field mobilepay



2763
2764
2765
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2763

def mobilepay
  @mobilepay
end

#multibanco ⇒ Object (readonly)

Attribute for field multibanco



2765
2766
2767
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2765

def multibanco
  @multibanco
end

#name ⇒ Object (readonly)

The configuration’s name.



2767
2768
2769
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2767

def name
  @name
end

#nz_bank_account ⇒ Object (readonly)

Attribute for field nz_bank_account



2769
2770
2771
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2769

def 
  @nz_bank_account
end

#object ⇒ Object (readonly)

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



2771
2772
2773
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2771

def object
  @object
end

#oxxo ⇒ Object (readonly)

Attribute for field oxxo



2773
2774
2775
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2773

def oxxo
  @oxxo
end

#p24 ⇒ Object (readonly)

Attribute for field p24



2775
2776
2777
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2775

def p24
  @p24
end

#parent ⇒ Object (readonly)

For child configs, the configuration’s parent configuration.



2777
2778
2779
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2777

def parent
  @parent
end

#pay_by_bank ⇒ Object (readonly)

Attribute for field pay_by_bank



2779
2780
2781
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2779

def pay_by_bank
  @pay_by_bank
end

#paynow ⇒ Object (readonly)

Attribute for field paynow



2781
2782
2783
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2781

def paynow
  @paynow
end

#paypal ⇒ Object (readonly)

Attribute for field paypal



2783
2784
2785
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2783

def paypal
  @paypal
end

#promptpay ⇒ Object (readonly)

Attribute for field promptpay



2785
2786
2787
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2785

def promptpay
  @promptpay
end

#revolut_pay ⇒ Object (readonly)

Attribute for field revolut_pay



2787
2788
2789
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2787

def revolut_pay
  @revolut_pay
end

#satispay ⇒ Object (readonly)

Attribute for field satispay



2789
2790
2791
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2789

def satispay
  @satispay
end

#sepa_debit ⇒ Object (readonly)

Attribute for field sepa_debit



2791
2792
2793
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2791

def sepa_debit
  @sepa_debit
end

#sofort ⇒ Object (readonly)

Attribute for field sofort



2793
2794
2795
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2793

def sofort
  @sofort
end

#swish ⇒ Object (readonly)

Attribute for field swish



2795
2796
2797
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2795

def swish
  @swish
end

#twint ⇒ Object (readonly)

Attribute for field twint



2797
2798
2799
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2797

def twint
  @twint
end

#us_bank_account ⇒ Object (readonly)

Attribute for field us_bank_account



2799
2800
2801
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2799

def 
  @us_bank_account
end

#wechat_pay ⇒ Object (readonly)

Attribute for field wechat_pay



2801
2802
2803
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2801

def wechat_pay
  @wechat_pay
end

#zip ⇒ Object (readonly)

Attribute for field zip



2803
2804
2805
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2803

def zip
  @zip
end

Class Method Details

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

Creates a payment method configuration



2806
2807
2808
2809
2810
2811
2812
2813
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2806

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

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

List payment method configurations



2816
2817
2818
2819
2820
2821
2822
2823
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2816

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



2826
2827
2828
2829
2830
2831
2832
2833
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 2826

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