Class PaymentMethodConfiguration
- All Implemented Interfaces:
HasId
,StripeActiveObject
,StripeObjectInterface
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: - Payment Method Configurations API - Multiple configurations on dynamic payment methods - Multiple configurations for your Connect accounts
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.static class
The effective display preference value.Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
Field Summary
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON, INTERNAL_GSON
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
static PaymentMethodConfiguration
Creates a payment method configuration.static PaymentMethodConfiguration
create
(PaymentMethodConfigurationCreateParams params, RequestOptions options) Creates a payment method configuration.static PaymentMethodConfiguration
Creates a payment method configuration.static PaymentMethodConfiguration
create
(Map<String, Object> params, RequestOptions options) Creates a payment method configuration.boolean
Whether the configuration can be used for new payments.For child configs, the Connect application associated with the configuration.getBlik()
getCard()
getEps()
getFpx()
getId()
Unique identifier for the object.getIdeal()
The default configuration is used whenever a payment method configuration is not specified.getJcb()
getLink()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.getName()
The configuration's name.String representing the object's type.getOxxo()
getP24()
For child configs, the configuration's parent configuration.getSwish()
getTwint()
getZip()
int
hashCode()
List payment method configurations.list
(PaymentMethodConfigurationListParams params, RequestOptions options) List payment method configurations.List payment method configurations.list
(Map<String, Object> params, RequestOptions options) List payment method configurations.static PaymentMethodConfiguration
Retrieve payment method configuration.static PaymentMethodConfiguration
retrieve
(String configuration, RequestOptions options) Retrieve payment method configuration.static PaymentMethodConfiguration
retrieve
(String configuration, PaymentMethodConfigurationRetrieveParams params, RequestOptions options) Retrieve payment method configuration.static PaymentMethodConfiguration
Retrieve payment method configuration.void
setAcssDebit
(PaymentMethodConfiguration.AcssDebit acssDebit) void
Whether the configuration can be used for new payments.void
void
setAfterpayClearpay
(PaymentMethodConfiguration.AfterpayClearpay afterpayClearpay) void
void
setAmazonPay
(PaymentMethodConfiguration.AmazonPay amazonPay) void
void
setApplication
(String application) For child configs, the Connect application associated with the configuration.void
setAuBecsDebit
(PaymentMethodConfiguration.AuBecsDebit auBecsDebit) void
setBacsDebit
(PaymentMethodConfiguration.BacsDebit bacsDebit) void
setBancontact
(PaymentMethodConfiguration.Bancontact bancontact) void
void
void
void
setCartesBancaires
(PaymentMethodConfiguration.CartesBancaires cartesBancaires) void
void
setCustomerBalance
(PaymentMethodConfiguration.CustomerBalance customerBalance) void
void
void
void
setGooglePay
(PaymentMethodConfiguration.GooglePay googlePay) void
void
Unique identifier for the object.void
void
setIsDefault
(Boolean isDefault) The default configuration is used whenever a payment method configuration is not specified.void
void
void
void
void
setLivemode
(Boolean livemode) Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setMobilepay
(PaymentMethodConfiguration.Mobilepay mobilepay) void
setMultibanco
(PaymentMethodConfiguration.Multibanco multibanco) void
The configuration's name.void
String representing the object's type.void
void
void
For child configs, the configuration's parent configuration.void
void
void
setPromptpay
(PaymentMethodConfiguration.Promptpay promptpay) void
setResponseGetter
(StripeResponseGetter responseGetter) The effective display preference value.void
setRevolutPay
(PaymentMethodConfiguration.RevolutPay revolutPay) void
setSepaDebit
(PaymentMethodConfiguration.SepaDebit sepaDebit) void
void
void
void
setUsBankAccount
(PaymentMethodConfiguration.UsBankAccount usBankAccount) void
setWechatPay
(PaymentMethodConfiguration.WechatPay wechatPay) void
Update payment method configuration.update
(PaymentMethodConfigurationUpdateParams params, RequestOptions options) Update payment method configuration.Update payment method configuration.update
(Map<String, Object> params, RequestOptions options) Update payment method configuration.Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setStripeResponseGetter, urlEncode, urlEncodeId
Methods inherited from class com.stripe.model.StripeObject
deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.stripe.model.StripeActiveObject
trySetResponseGetter
-
Constructor Details
-
PaymentMethodConfiguration
public PaymentMethodConfiguration()
-
-
Method Details
-
create
Creates a payment method configuration.- Throws:
StripeException
-
create
public static PaymentMethodConfiguration create(Map<String, Object> params, RequestOptions options) throws StripeExceptionCreates a payment method configuration.- Throws:
StripeException
-
create
public static PaymentMethodConfiguration create(PaymentMethodConfigurationCreateParams params) throws StripeException Creates a payment method configuration.- Throws:
StripeException
-
create
public static PaymentMethodConfiguration create(PaymentMethodConfigurationCreateParams params, RequestOptions options) throws StripeException Creates a payment method configuration.- Throws:
StripeException
-
list
public static PaymentMethodConfigurationCollection list(Map<String, Object> params) throws StripeExceptionList payment method configurations.- Throws:
StripeException
-
list
public static PaymentMethodConfigurationCollection list(Map<String, Object> params, RequestOptions options) throws StripeExceptionList payment method configurations.- Throws:
StripeException
-
list
public static PaymentMethodConfigurationCollection list(PaymentMethodConfigurationListParams params) throws StripeException List payment method configurations.- Throws:
StripeException
-
list
public static PaymentMethodConfigurationCollection list(PaymentMethodConfigurationListParams params, RequestOptions options) throws StripeException List payment method configurations.- Throws:
StripeException
-
retrieve
Retrieve payment method configuration.- Throws:
StripeException
-
retrieve
public static PaymentMethodConfiguration retrieve(String configuration, RequestOptions options) throws StripeException Retrieve payment method configuration.- Throws:
StripeException
-
retrieve
public static PaymentMethodConfiguration retrieve(String configuration, Map<String, Object> params, RequestOptions options) throws StripeExceptionRetrieve payment method configuration.- Throws:
StripeException
-
retrieve
public static PaymentMethodConfiguration retrieve(String configuration, PaymentMethodConfigurationRetrieveParams params, RequestOptions options) throws StripeException Retrieve payment method configuration.- Throws:
StripeException
-
update
Update payment method configuration.- Throws:
StripeException
-
update
public PaymentMethodConfiguration update(Map<String, Object> params, RequestOptions options) throws StripeExceptionUpdate payment method configuration.- Throws:
StripeException
-
update
public PaymentMethodConfiguration update(PaymentMethodConfigurationUpdateParams params) throws StripeException Update payment method configuration.- Throws:
StripeException
-
update
public PaymentMethodConfiguration update(PaymentMethodConfigurationUpdateParams params, RequestOptions options) throws StripeException Update payment method configuration.- Throws:
StripeException
-
setResponseGetter
The effective display preference value.One of
off
, oron
.- Specified by:
setResponseGetter
in interfaceStripeActiveObject
- Overrides:
setResponseGetter
in classApiResource
- Parameters:
responseGetter
- theStripeResponseGetter
instance to use for making further requests.
-
getAcssDebit
-
getActive
Whether the configuration can be used for new payments. -
getAffirm
-
getAfterpayClearpay
-
getAlipay
-
getAmazonPay
-
getApplePay
-
getApplication
For child configs, the Connect application associated with the configuration. -
getAuBecsDebit
-
getBacsDebit
-
getBancontact
-
getBlik
-
getBoleto
-
getCard
-
getCartesBancaires
-
getCashapp
-
getCustomerBalance
-
getEps
-
getFpx
-
getGiropay
-
getGooglePay
-
getGrabpay
-
getIdeal
-
getIsDefault
The default configuration is used whenever a payment method configuration is not specified. -
getJcb
-
getKlarna
-
getKonbini
-
getLink
-
getLivemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode. -
getMobilepay
-
getMultibanco
-
getName
The configuration's name. -
getObject
String representing the object's type. Objects of the same type share the same value.Equal to
payment_method_configuration
. -
getOxxo
-
getP24
-
getParent
For child configs, the configuration's parent configuration. -
getPaynow
-
getPaypal
-
getPromptpay
-
getRevolutPay
-
getSepaDebit
-
getSofort
-
getSwish
-
getTwint
-
getUsBankAccount
-
getWechatPay
-
getZip
-
setAcssDebit
-
setActive
Whether the configuration can be used for new payments. -
setAffirm
-
setAfterpayClearpay
-
setAlipay
-
setAmazonPay
-
setApplePay
-
setApplication
For child configs, the Connect application associated with the configuration. -
setAuBecsDebit
-
setBacsDebit
-
setBancontact
-
setBlik
-
setBoleto
-
setCard
-
setCartesBancaires
-
setCashapp
-
setCustomerBalance
-
setEps
-
setFpx
-
setGiropay
-
setGooglePay
-
setGrabpay
-
setId
Unique identifier for the object. -
setIdeal
-
setIsDefault
The default configuration is used whenever a payment method configuration is not specified. -
setJcb
-
setKlarna
-
setKonbini
-
setLink
-
setLivemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode. -
setMobilepay
-
setMultibanco
-
setName
The configuration's name. -
setObject
String representing the object's type. Objects of the same type share the same value.Equal to
payment_method_configuration
. -
setOxxo
-
setP24
-
setParent
For child configs, the configuration's parent configuration. -
setPaynow
-
setPaypal
-
setPromptpay
-
setRevolutPay
-
setSepaDebit
-
setSofort
-
setSwish
-
setTwint
-
setUsBankAccount
-
setWechatPay
-
setZip
-
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the object.
-