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, Blik, Boleto, Card, CartesBancaires, Cashapp, CreateParams, CustomerBalance, Eps, Fpx, Giropay, GooglePay, Gopay, Grabpay, IdBankTransfer, Ideal, Jcb, Klarna, Konbini, Link, ListParams, Mobilepay, Multibanco, Oxxo, P24, Paynow, Paypal, Payto, Promptpay, Qris, RetrieveParams, RevolutPay, SepaDebit, Shopeepay, 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



3005
3006
3007
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3005

def acss_debit
  @acss_debit
end

#active ⇒ Object (readonly)

Whether the configuration can be used for new payments.



3008
3009
3010
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3008

def active
  @active
end

#affirm ⇒ Object (readonly)

Attribute for field affirm



3011
3012
3013
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3011

def affirm
  @affirm
end

#afterpay_clearpay ⇒ Object (readonly)

Attribute for field afterpay_clearpay



3014
3015
3016
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3014

def afterpay_clearpay
  @afterpay_clearpay
end

#alipay ⇒ Object (readonly)

Attribute for field alipay



3017
3018
3019
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3017

def alipay
  @alipay
end

#alma ⇒ Object (readonly)

Attribute for field alma



3020
3021
3022
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3020

def alma
  @alma
end

#amazon_pay ⇒ Object (readonly)

Attribute for field amazon_pay



3023
3024
3025
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3023

def amazon_pay
  @amazon_pay
end

#apple_pay ⇒ Object (readonly)

Attribute for field apple_pay



3026
3027
3028
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3026

def apple_pay
  @apple_pay
end

#application ⇒ Object (readonly)

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



3029
3030
3031
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3029

def application
  @application
end

#au_becs_debit ⇒ Object (readonly)

Attribute for field au_becs_debit



3032
3033
3034
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3032

def au_becs_debit
  @au_becs_debit
end

#bacs_debit ⇒ Object (readonly)

Attribute for field bacs_debit



3035
3036
3037
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3035

def bacs_debit
  @bacs_debit
end

#bancontact ⇒ Object (readonly)

Attribute for field bancontact



3038
3039
3040
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3038

def bancontact
  @bancontact
end

#blik ⇒ Object (readonly)

Attribute for field blik



3041
3042
3043
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3041

def blik
  @blik
end

#boleto ⇒ Object (readonly)

Attribute for field boleto



3044
3045
3046
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3044

def boleto
  @boleto
end

#card ⇒ Object (readonly)

Attribute for field card



3047
3048
3049
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3047

def card
  @card
end

#cartes_bancaires ⇒ Object (readonly)

Attribute for field cartes_bancaires



3050
3051
3052
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3050

def cartes_bancaires
  @cartes_bancaires
end

#cashapp ⇒ Object (readonly)

Attribute for field cashapp



3053
3054
3055
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3053

def cashapp
  @cashapp
end

#customer_balance ⇒ Object (readonly)

Attribute for field customer_balance



3056
3057
3058
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3056

def customer_balance
  @customer_balance
end

#eps ⇒ Object (readonly)

Attribute for field eps



3059
3060
3061
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3059

def eps
  @eps
end

#fpx ⇒ Object (readonly)

Attribute for field fpx



3062
3063
3064
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3062

def fpx
  @fpx
end

#giropay ⇒ Object (readonly)

Attribute for field giropay



3065
3066
3067
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3065

def giropay
  @giropay
end

#google_pay ⇒ Object (readonly)

Attribute for field google_pay



3068
3069
3070
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3068

def google_pay
  @google_pay
end

#gopay ⇒ Object (readonly)

Attribute for field gopay



3071
3072
3073
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3071

def gopay
  @gopay
end

#grabpay ⇒ Object (readonly)

Attribute for field grabpay



3074
3075
3076
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3074

def grabpay
  @grabpay
end

#id ⇒ Object (readonly)

Unique identifier for the object.



3077
3078
3079
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3077

def id
  @id
end

#id_bank_transfer ⇒ Object (readonly)

Attribute for field id_bank_transfer



3080
3081
3082
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3080

def id_bank_transfer
  @id_bank_transfer
end

#ideal ⇒ Object (readonly)

Attribute for field ideal



3083
3084
3085
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3083

def ideal
  @ideal
end

#is_default ⇒ Object (readonly)

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



3086
3087
3088
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3086

def is_default
  @is_default
end

#jcb ⇒ Object (readonly)

Attribute for field jcb



3089
3090
3091
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3089

def jcb
  @jcb
end

#klarna ⇒ Object (readonly)

Attribute for field klarna



3092
3093
3094
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3092

def klarna
  @klarna
end

#konbini ⇒ Object (readonly)

Attribute for field konbini



3095
3096
3097
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3095

def konbini
  @konbini
end

#link ⇒ Object (readonly)

Attribute for field link



3098
3099
3100
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3098

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.



3101
3102
3103
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3101

def livemode
  @livemode
end

#mobilepay ⇒ Object (readonly)

Attribute for field mobilepay



3104
3105
3106
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3104

def mobilepay
  @mobilepay
end

#multibanco ⇒ Object (readonly)

Attribute for field multibanco



3107
3108
3109
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3107

def multibanco
  @multibanco
end

#name ⇒ Object (readonly)

The configuration’s name.



3110
3111
3112
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3110

def name
  @name
end

#object ⇒ Object (readonly)

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



3113
3114
3115
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3113

def object
  @object
end

#oxxo ⇒ Object (readonly)

Attribute for field oxxo



3116
3117
3118
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3116

def oxxo
  @oxxo
end

#p24 ⇒ Object (readonly)

Attribute for field p24



3119
3120
3121
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3119

def p24
  @p24
end

#parent ⇒ Object (readonly)

For child configs, the configuration’s parent configuration.



3122
3123
3124
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3122

def parent
  @parent
end

#paynow ⇒ Object (readonly)

Attribute for field paynow



3125
3126
3127
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3125

def paynow
  @paynow
end

#paypal ⇒ Object (readonly)

Attribute for field paypal



3128
3129
3130
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3128

def paypal
  @paypal
end

#payto ⇒ Object (readonly)

Attribute for field payto



3131
3132
3133
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3131

def payto
  @payto
end

#promptpay ⇒ Object (readonly)

Attribute for field promptpay



3134
3135
3136
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3134

def promptpay
  @promptpay
end

#qris ⇒ Object (readonly)

Attribute for field qris



3137
3138
3139
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3137

def qris
  @qris
end

#revolut_pay ⇒ Object (readonly)

Attribute for field revolut_pay



3140
3141
3142
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3140

def revolut_pay
  @revolut_pay
end

#sepa_debit ⇒ Object (readonly)

Attribute for field sepa_debit



3143
3144
3145
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3143

def sepa_debit
  @sepa_debit
end

#shopeepay ⇒ Object (readonly)

Attribute for field shopeepay



3146
3147
3148
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3146

def shopeepay
  @shopeepay
end

#sofort ⇒ Object (readonly)

Attribute for field sofort



3149
3150
3151
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3149

def sofort
  @sofort
end

#swish ⇒ Object (readonly)

Attribute for field swish



3152
3153
3154
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3152

def swish
  @swish
end

#twint ⇒ Object (readonly)

Attribute for field twint



3155
3156
3157
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3155

def twint
  @twint
end

#us_bank_account ⇒ Object (readonly)

Attribute for field us_bank_account



3158
3159
3160
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3158

def 
  @us_bank_account
end

#wechat_pay ⇒ Object (readonly)

Attribute for field wechat_pay



3161
3162
3163
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3161

def wechat_pay
  @wechat_pay
end

#zip ⇒ Object (readonly)

Attribute for field zip



3164
3165
3166
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3164

def zip
  @zip
end

Class Method Details

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

Creates a payment method configuration



3167
3168
3169
3170
3171
3172
3173
3174
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3167

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



3177
3178
3179
3180
3181
3182
3183
3184
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3177

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(id, params = {}, opts = {}) ⇒ Object

Update payment method configuration



3187
3188
3189
3190
3191
3192
3193
3194
 
# File 'lib/stripe/resources/payment_method_configuration.rb', line 3187

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