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
Nested ClassesModifier and TypeClassDescriptionstatic classFor more details about AcssDebit, please refer to the API Reference.static classFor more details about Affirm, please refer to the API Reference.static classFor more details about AfterpayClearpay, please refer to the API Reference.static classFor more details about Alipay, please refer to the API Reference.static classFor more details about Alma, please refer to the API Reference.static classFor more details about AmazonPay, please refer to the API Reference.static classFor more details about ApplePay, please refer to the API Reference.static classFor more details about AuBecsDebit, please refer to the API Reference.static classFor more details about BacsDebit, please refer to the API Reference.static classFor more details about Bancontact, please refer to the API Reference.static classFor more details about Billie, please refer to the API Reference.static classFor more details about Blik, please refer to the API Reference.static classFor more details about Boleto, please refer to the API Reference.static classFor more details about Card, please refer to the API Reference.static classFor more details about CartesBancaires, please refer to the API Reference.static classFor more details about Cashapp, please refer to the API Reference.static classFor more details about CustomerBalance, please refer to the API Reference.static classFor more details about Eps, please refer to the API Reference.static classFor more details about Fpx, please refer to the API Reference.static classFor more details about Giropay, please refer to the API Reference.static classFor more details about GooglePay, please refer to the API Reference.static classFor more details about Gopay, please refer to the API Reference.static classFor more details about Grabpay, please refer to the API Reference.static classFor more details about IdBankTransfer, please refer to the API Reference.static classFor more details about Ideal, please refer to the API Reference.static classFor more details about Jcb, please refer to the API Reference.static classFor more details about KakaoPay, please refer to the API Reference.static classFor more details about Klarna, please refer to the API Reference.static classFor more details about Konbini, please refer to the API Reference.static classFor more details about KrCard, please refer to the API Reference.static classFor more details about Link, please refer to the API Reference.static classFor more details about Mobilepay, please refer to the API Reference.static classFor more details about Multibanco, please refer to the API Reference.static classFor more details about NaverPay, please refer to the API Reference.static classFor more details about NzBankAccount, please refer to the API Reference.static classFor more details about Oxxo, please refer to the API Reference.static classFor more details about P24, please refer to the API Reference.static classFor more details about PayByBank, please refer to the API Reference.static classFor more details about Payco, please refer to the API Reference.static classFor more details about Paynow, please refer to the API Reference.static classFor more details about Paypal, please refer to the API Reference.static classFor more details about Paypay, please refer to the API Reference.static classFor more details about Payto, please refer to the API Reference.static classFor more details about Pix, please refer to the API Reference.static classFor more details about Promptpay, please refer to the API Reference.static classFor more details about Qris, please refer to the API Reference.static classFor more details about RevolutPay, please refer to the API Reference.static classFor more details about SamsungPay, please refer to the API Reference.static classFor more details about Satispay, please refer to the API Reference.static classFor more details about SepaDebit, please refer to the API Reference.static classFor more details about Shopeepay, please refer to the API Reference.static classFor more details about Sofort, please refer to the API Reference.static classFor more details about Swish, please refer to the API Reference.static classFor more details about Twint, please refer to the API Reference.static classFor more details about UsBankAccount, please refer to the API Reference.static classFor more details about WechatPay, please refer to the API Reference.static classFor more details about Zip, please refer to the API Reference.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_GSONFields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanstatic PaymentMethodConfigurationCreates a payment method configuration.static PaymentMethodConfigurationcreate(PaymentMethodConfigurationCreateParams params, RequestOptions options) Creates a payment method configuration.static PaymentMethodConfigurationCreates a payment method configuration.static PaymentMethodConfigurationcreate(Map<String, Object> params, RequestOptions options) Creates a payment method configuration.booleanWhether the configuration can be used for new payments.getAlma()For child configs, the Connect application associated with the configuration.getBlik()getCard()getEps()getFpx()getGopay()getId()Unique identifier for the object.getIdeal()The default configuration is used whenever a payment method configuration is not specified.getJcb()getLink()Has the valuetrueif the object exists in live mode or the valuefalseif 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.getPayco()getPayto()getPix()getQris()getSwish()getTwint()getZip()inthashCode()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 PaymentMethodConfigurationRetrieve payment method configuration.static PaymentMethodConfigurationretrieve(String configuration, RequestOptions options) Retrieve payment method configuration.static PaymentMethodConfigurationretrieve(String configuration, PaymentMethodConfigurationRetrieveParams params, RequestOptions options) Retrieve payment method configuration.static PaymentMethodConfigurationRetrieve payment method configuration.voidsetAcssDebit(PaymentMethodConfiguration.AcssDebit acssDebit) voidWhether the configuration can be used for new payments.voidvoidsetAfterpayClearpay(PaymentMethodConfiguration.AfterpayClearpay afterpayClearpay) voidvoidvoidsetAmazonPay(PaymentMethodConfiguration.AmazonPay amazonPay) voidvoidsetApplication(String application) For child configs, the Connect application associated with the configuration.voidsetAuBecsDebit(PaymentMethodConfiguration.AuBecsDebit auBecsDebit) voidsetBacsDebit(PaymentMethodConfiguration.BacsDebit bacsDebit) voidsetBancontact(PaymentMethodConfiguration.Bancontact bancontact) voidvoidvoidvoidvoidsetCartesBancaires(PaymentMethodConfiguration.CartesBancaires cartesBancaires) voidvoidsetCustomerBalance(PaymentMethodConfiguration.CustomerBalance customerBalance) voidvoidvoidvoidsetGooglePay(PaymentMethodConfiguration.GooglePay googlePay) voidvoidvoidUnique identifier for the object.voidsetIdBankTransfer(PaymentMethodConfiguration.IdBankTransfer idBankTransfer) voidvoidsetIsDefault(Boolean isDefault) The default configuration is used whenever a payment method configuration is not specified.voidvoidvoidvoidvoidvoidvoidsetLivemode(Boolean livemode) Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.voidsetMobilepay(PaymentMethodConfiguration.Mobilepay mobilepay) voidsetMultibanco(PaymentMethodConfiguration.Multibanco multibanco) voidThe configuration's name.voidvoidsetNzBankAccount(PaymentMethodConfiguration.NzBankAccount nzBankAccount) voidString representing the object's type.voidvoidvoidFor child configs, the configuration's parent configuration.voidsetPayByBank(PaymentMethodConfiguration.PayByBank payByBank) voidvoidvoidvoidvoidvoidvoidsetPromptpay(PaymentMethodConfiguration.Promptpay promptpay) voidvoidsetResponseGetter(StripeResponseGetter responseGetter) The effective display preference value.voidsetRevolutPay(PaymentMethodConfiguration.RevolutPay revolutPay) voidsetSamsungPay(PaymentMethodConfiguration.SamsungPay samsungPay) voidvoidsetSepaDebit(PaymentMethodConfiguration.SepaDebit sepaDebit) voidsetShopeepay(PaymentMethodConfiguration.Shopeepay shopeepay) voidvoidvoidvoidsetUsBankAccount(PaymentMethodConfiguration.UsBankAccount usBankAccount) voidsetWechatPay(PaymentMethodConfiguration.WechatPay wechatPay) voidUpdate 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, setGlobalResponseGetter, urlEncode, urlEncodeIdMethods inherited from class com.stripe.model.StripeObject
deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods 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:
setResponseGetterin interfaceStripeActiveObject- Overrides:
setResponseGetterin classApiResource- Parameters:
responseGetter- theStripeResponseGetterinstance to use for making further requests.
-
getAcssDebit
-
getActive
Whether the configuration can be used for new payments. -
getAffirm
-
getAfterpayClearpay
-
getAlipay
-
getAlma
-
getAmazonPay
-
getApplePay
-
getApplication
For child configs, the Connect application associated with the configuration. -
getAuBecsDebit
-
getBacsDebit
-
getBancontact
-
getBillie
-
getBlik
-
getBoleto
-
getCard
-
getCartesBancaires
-
getCashapp
-
getCustomerBalance
-
getEps
-
getFpx
-
getGiropay
-
getGooglePay
-
getGopay
-
getGrabpay
-
getIdBankTransfer
-
getIdeal
-
getIsDefault
The default configuration is used whenever a payment method configuration is not specified. -
getJcb
-
getKakaoPay
-
getKlarna
-
getKonbini
-
getKrCard
-
getLink
-
getLivemode
Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode. -
getMobilepay
-
getMultibanco
-
getName
The configuration's name. -
getNzBankAccount
-
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. -
getPayByBank
-
getPayco
-
getPaynow
-
getPaypal
-
getPaypay
-
getPayto
-
getPix
-
getPromptpay
-
getQris
-
getRevolutPay
-
getSamsungPay
-
getSatispay
-
getSepaDebit
-
getShopeepay
-
getSofort
-
getSwish
-
getTwint
-
getUsBankAccount
-
getWechatPay
-
getZip
-
setAcssDebit
-
setActive
Whether the configuration can be used for new payments. -
setAffirm
-
setAfterpayClearpay
-
setAlipay
-
setAlma
-
setAmazonPay
-
setApplePay
-
setApplication
For child configs, the Connect application associated with the configuration. -
setAuBecsDebit
-
setBacsDebit
-
setBancontact
-
setBillie
-
setBlik
-
setBoleto
-
setCard
-
setCartesBancaires
-
setCashapp
-
setCustomerBalance
-
setEps
-
setFpx
-
setGiropay
-
setGooglePay
-
setGopay
-
setGrabpay
-
setId
Unique identifier for the object. -
setIdBankTransfer
-
setIdeal
-
setIsDefault
The default configuration is used whenever a payment method configuration is not specified. -
setJcb
-
setKakaoPay
-
setKlarna
-
setKonbini
-
setKrCard
-
setLink
-
setLivemode
Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode. -
setMobilepay
-
setMultibanco
-
setName
The configuration's name. -
setNzBankAccount
-
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. -
setPayByBank
-
setPayco
-
setPaynow
-
setPaypal
-
setPaypay
-
setPayto
-
setPix
-
setPromptpay
-
setQris
-
setRevolutPay
-
setSamsungPay
-
setSatispay
-
setSepaDebit
-
setShopeepay
-
setSofort
-
setSwish
-
setTwint
-
setUsBankAccount
-
setWechatPay
-
setZip
-
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the object.
-