Package com.stripe.model

Class PaymentMethod

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.PaymentMethod

All Implemented Interfaces:

HasId, MetadataStore<PaymentMethod>, StripeActiveObject, StripeObjectInterface

public class PaymentMethod
extends ApiResource
implements HasId, MetadataStore<PaymentMethod>

PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

Related guides: Payment Methods and More Payment Scenarios.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaymentMethod.AcssDebit	For more details about AcssDebit, please refer to the API Reference.
static class	PaymentMethod.Affirm	For more details about Affirm, please refer to the API Reference.
static class	PaymentMethod.AfterpayClearpay	For more details about AfterpayClearpay, please refer to the API Reference.
static class	PaymentMethod.Alipay	For more details about Alipay, please refer to the API Reference.
static class	PaymentMethod.Alma	For more details about Alma, please refer to the API Reference.
static class	PaymentMethod.AmazonPay	For more details about AmazonPay, please refer to the API Reference.
static class	PaymentMethod.AuBecsDebit	For more details about AuBecsDebit, please refer to the API Reference.
static class	PaymentMethod.BacsDebit	For more details about BacsDebit, please refer to the API Reference.
static class	PaymentMethod.Bancontact	For more details about Bancontact, please refer to the API Reference.
static class	PaymentMethod.Billie	For more details about Billie, please refer to the API Reference.
static class	PaymentMethod.BillingDetails	For more details about BillingDetails, please refer to the API Reference.
static class	PaymentMethod.Blik	For more details about Blik, please refer to the API Reference.
static class	PaymentMethod.Boleto	For more details about Boleto, please refer to the API Reference.
static class	PaymentMethod.Card	For more details about Card, please refer to the API Reference.
static class	PaymentMethod.CardPresent	For more details about CardPresent, please refer to the API Reference.
static class	PaymentMethod.Cashapp	For more details about Cashapp, please refer to the API Reference.
static class	PaymentMethod.Crypto	For more details about Crypto, please refer to the API Reference.
static class	PaymentMethod.Custom	For more details about Custom, please refer to the API Reference.
static class	PaymentMethod.CustomerBalance	For more details about CustomerBalance, please refer to the API Reference.
static class	PaymentMethod.Eps	For more details about Eps, please refer to the API Reference.
static class	PaymentMethod.Fpx	For more details about Fpx, please refer to the API Reference.
static class	PaymentMethod.Giropay	For more details about Giropay, please refer to the API Reference.
static class	PaymentMethod.Gopay	For more details about Gopay, please refer to the API Reference.
static class	PaymentMethod.Grabpay	For more details about Grabpay, please refer to the API Reference.
static class	PaymentMethod.IdBankTransfer	For more details about IdBankTransfer, please refer to the API Reference.
static class	PaymentMethod.Ideal	For more details about Ideal, please refer to the API Reference.
static class	PaymentMethod.InteracPresent	For more details about InteracPresent, please refer to the API Reference.
static class	PaymentMethod.KakaoPay	For more details about KakaoPay, please refer to the API Reference.
static class	PaymentMethod.Klarna	For more details about Klarna, please refer to the API Reference.
static class	PaymentMethod.Konbini	For more details about Konbini, please refer to the API Reference.
static class	PaymentMethod.KrCard	For more details about KrCard, please refer to the API Reference.
static class	PaymentMethod.Link	For more details about Link, please refer to the API Reference.
static class	PaymentMethod.MbWay	For more details about MbWay, please refer to the API Reference.
static class	PaymentMethod.Mobilepay	For more details about Mobilepay, please refer to the API Reference.
static class	PaymentMethod.Multibanco	For more details about Multibanco, please refer to the API Reference.
static class	PaymentMethod.NaverPay	For more details about NaverPay, please refer to the API Reference.
static class	PaymentMethod.NzBankAccount	For more details about NzBankAccount, please refer to the API Reference.
static class	PaymentMethod.Oxxo	For more details about Oxxo, please refer to the API Reference.
static class	PaymentMethod.P24	For more details about P24, please refer to the API Reference.
static class	PaymentMethod.PayByBank	For more details about PayByBank, please refer to the API Reference.
static class	PaymentMethod.Payco	For more details about Payco, please refer to the API Reference.
static class	PaymentMethod.Paynow	For more details about Paynow, please refer to the API Reference.
static class	PaymentMethod.Paypal	For more details about Paypal, please refer to the API Reference.
static class	PaymentMethod.Paypay	For more details about Paypay, please refer to the API Reference.
static class	PaymentMethod.Payto	For more details about Payto, please refer to the API Reference.
static class	PaymentMethod.Pix	For more details about Pix, please refer to the API Reference.
static class	PaymentMethod.Promptpay	For more details about Promptpay, please refer to the API Reference.
static class	PaymentMethod.Qris	For more details about Qris, please refer to the API Reference.
static class	PaymentMethod.RadarOptions	Options to configure Radar.
static class	PaymentMethod.Rechnung	For more details about Rechnung, please refer to the API Reference.
static class	PaymentMethod.RevolutPay	For more details about RevolutPay, please refer to the API Reference.
static class	PaymentMethod.SamsungPay	For more details about SamsungPay, please refer to the API Reference.
static class	PaymentMethod.Satispay	For more details about Satispay, please refer to the API Reference.
static class	PaymentMethod.SepaDebit	For more details about SepaDebit, please refer to the API Reference.
static class	PaymentMethod.Shopeepay	For more details about Shopeepay, please refer to the API Reference.
static class	PaymentMethod.Sofort	For more details about Sofort, please refer to the API Reference.
static class	PaymentMethod.StripeBalance	For more details about StripeBalance, please refer to the API Reference.
static class	PaymentMethod.Swish	For more details about Swish, please refer to the API Reference.
static class	PaymentMethod.Twint	For more details about Twint, please refer to the API Reference.
static class	PaymentMethod.UsBankAccount	For more details about UsBankAccount, please refer to the API Reference.
static class	PaymentMethod.WechatPay	For more details about WechatPay, please refer to the API Reference.
static class	PaymentMethod.Zip	For 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_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
PaymentMethod()

Method Summary

Modifier and Type	Method	Description
PaymentMethod	attach()	Attaches a PaymentMethod object to a Customer.
PaymentMethod	attach(RequestOptions options)	Attaches a PaymentMethod object to a Customer.
PaymentMethod	attach(PaymentMethodAttachParams params)	Attaches a PaymentMethod object to a Customer.
PaymentMethod	attach(PaymentMethodAttachParams params, RequestOptions options)	Attaches a PaymentMethod object to a Customer.
PaymentMethod	attach(Map<String,Object> params)	Attaches a PaymentMethod object to a Customer.
PaymentMethod	attach(Map<String,Object> params, RequestOptions options)	Attaches a PaymentMethod object to a Customer.
protected boolean	canEqual(Object other)
PaymentMethodBalance	checkBalance()	Retrieves a payment method’s balance.
PaymentMethodBalance	checkBalance(RequestOptions options)	Retrieves a payment method’s balance.
PaymentMethodBalance	checkBalance(PaymentMethodCheckBalanceParams params)	Retrieves a payment method’s balance.
PaymentMethodBalance	checkBalance(PaymentMethodCheckBalanceParams params, RequestOptions options)	Retrieves a payment method’s balance.
PaymentMethodBalance	checkBalance(Map<String,Object> params)	Retrieves a payment method’s balance.
PaymentMethodBalance	checkBalance(Map<String,Object> params, RequestOptions options)	Retrieves a payment method’s balance.
static PaymentMethod	create(PaymentMethodCreateParams params)	Creates a PaymentMethod object.
static PaymentMethod	create(PaymentMethodCreateParams params, RequestOptions options)	Creates a PaymentMethod object.
static PaymentMethod	create(Map<String,Object> params)	Creates a PaymentMethod object.
static PaymentMethod	create(Map<String,Object> params, RequestOptions options)	Creates a PaymentMethod object.
PaymentMethod	detach()	Detaches a PaymentMethod object from a Customer.
PaymentMethod	detach(RequestOptions options)	Detaches a PaymentMethod object from a Customer.
PaymentMethod	detach(PaymentMethodDetachParams params)	Detaches a PaymentMethod object from a Customer.
PaymentMethod	detach(PaymentMethodDetachParams params, RequestOptions options)	Detaches a PaymentMethod object from a Customer.
PaymentMethod	detach(Map<String,Object> params)	Detaches a PaymentMethod object from a Customer.
PaymentMethod	detach(Map<String,Object> params, RequestOptions options)	Detaches a PaymentMethod object from a Customer.
boolean	equals(Object o)
PaymentMethod.AcssDebit	getAcssDebit()
PaymentMethod.Affirm	getAffirm()
PaymentMethod.AfterpayClearpay	getAfterpayClearpay()
PaymentMethod.Alipay	getAlipay()
String	getAllowRedisplay()	This field indicates whether this payment method can be shown again to its customer in a checkout flow.
PaymentMethod.Alma	getAlma()
PaymentMethod.AmazonPay	getAmazonPay()
PaymentMethod.AuBecsDebit	getAuBecsDebit()
PaymentMethod.BacsDebit	getBacsDebit()
PaymentMethod.Bancontact	getBancontact()
PaymentMethod.Billie	getBillie()
PaymentMethod.BillingDetails	getBillingDetails()
PaymentMethod.Blik	getBlik()
PaymentMethod.Boleto	getBoleto()
PaymentMethod.Card	getCard()
PaymentMethod.CardPresent	getCardPresent()
PaymentMethod.Cashapp	getCashapp()
Long	getCreated()	Time at which the object was created.
PaymentMethod.Crypto	getCrypto()
PaymentMethod.Custom	getCustom()
String	getCustomer()	Get ID of expandable customer object.
String	getCustomerAccount()
PaymentMethod.CustomerBalance	getCustomerBalance()
Customer	getCustomerObject()	Get expanded customer.
PaymentMethod.Eps	getEps()
PaymentMethod.Fpx	getFpx()
PaymentMethod.Giropay	getGiropay()
PaymentMethod.Gopay	getGopay()
PaymentMethod.Grabpay	getGrabpay()
String	getId()	Unique identifier for the object.
PaymentMethod.IdBankTransfer	getIdBankTransfer()
PaymentMethod.Ideal	getIdeal()
PaymentMethod.InteracPresent	getInteracPresent()
PaymentMethod.KakaoPay	getKakaoPay()
PaymentMethod.Klarna	getKlarna()
PaymentMethod.Konbini	getKonbini()
PaymentMethod.KrCard	getKrCard()
Mandate	getLatestActiveMandate()	The Mandate object of the most recently created Mandate associated with this payment method.
PaymentMethod.Link	getLink()
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
PaymentMethod.MbWay	getMbWay()
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
PaymentMethod.Mobilepay	getMobilepay()
PaymentMethod.Multibanco	getMultibanco()
PaymentMethod.NaverPay	getNaverPay()
PaymentMethod.NzBankAccount	getNzBankAccount()
String	getObject()	String representing the object's type.
PaymentMethod.Oxxo	getOxxo()
PaymentMethod.P24	getP24()
PaymentMethod.PayByBank	getPayByBank()
PaymentMethod.Payco	getPayco()
PaymentMethod.Paynow	getPaynow()
PaymentMethod.Paypal	getPaypal()
PaymentMethod.Paypay	getPaypay()
PaymentMethod.Payto	getPayto()
PaymentMethod.Pix	getPix()
PaymentMethod.Promptpay	getPromptpay()
PaymentMethod.Qris	getQris()
PaymentMethod.RadarOptions	getRadarOptions()	Options to configure Radar.
PaymentMethod.Rechnung	getRechnung()
PaymentMethod.RevolutPay	getRevolutPay()
PaymentMethod.SamsungPay	getSamsungPay()
PaymentMethod.Satispay	getSatispay()
PaymentMethod.SepaDebit	getSepaDebit()
PaymentMethod.Shopeepay	getShopeepay()
PaymentMethod.Sofort	getSofort()
PaymentMethod.StripeBalance	getStripeBalance()
PaymentMethod.Swish	getSwish()
PaymentMethod.Twint	getTwint()
String	getType()	The type of the PaymentMethod.
PaymentMethod.UsBankAccount	getUsBankAccount()
PaymentMethod.WechatPay	getWechatPay()
PaymentMethod.Zip	getZip()
int	hashCode()
static PaymentMethodCollection	list(PaymentMethodListParams params)	Returns a list of PaymentMethods for Treasury flows.
static PaymentMethodCollection	list(PaymentMethodListParams params, RequestOptions options)	Returns a list of PaymentMethods for Treasury flows.
static PaymentMethodCollection	list(Map<String,Object> params)	Returns a list of PaymentMethods for Treasury flows.
static PaymentMethodCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of PaymentMethods for Treasury flows.
static PaymentMethod	retrieve(String paymentMethod)	Retrieves a PaymentMethod object attached to the StripeAccount.
static PaymentMethod	retrieve(String paymentMethod, RequestOptions options)	Retrieves a PaymentMethod object attached to the StripeAccount.
static PaymentMethod	retrieve(String paymentMethod, PaymentMethodRetrieveParams params, RequestOptions options)	Retrieves a PaymentMethod object attached to the StripeAccount.
static PaymentMethod	retrieve(String paymentMethod, Map<String,Object> params, RequestOptions options)	Retrieves a PaymentMethod object attached to the StripeAccount.
void	setAcssDebit(PaymentMethod.AcssDebit acssDebit)
void	setAffirm(PaymentMethod.Affirm affirm)
void	setAfterpayClearpay(PaymentMethod.AfterpayClearpay afterpayClearpay)
void	setAlipay(PaymentMethod.Alipay alipay)
void	setAllowRedisplay(String allowRedisplay)	This field indicates whether this payment method can be shown again to its customer in a checkout flow.
void	setAlma(PaymentMethod.Alma alma)
void	setAmazonPay(PaymentMethod.AmazonPay amazonPay)
void	setAuBecsDebit(PaymentMethod.AuBecsDebit auBecsDebit)
void	setBacsDebit(PaymentMethod.BacsDebit bacsDebit)
void	setBancontact(PaymentMethod.Bancontact bancontact)
void	setBillie(PaymentMethod.Billie billie)
void	setBillingDetails(PaymentMethod.BillingDetails billingDetails)
void	setBlik(PaymentMethod.Blik blik)
void	setBoleto(PaymentMethod.Boleto boleto)
void	setCard(PaymentMethod.Card card)
void	setCardPresent(PaymentMethod.CardPresent cardPresent)
void	setCashapp(PaymentMethod.Cashapp cashapp)
void	setCreated(Long created)	Time at which the object was created.
void	setCrypto(PaymentMethod.Crypto crypto)
void	setCustom(PaymentMethod.Custom custom)
void	setCustomer(String id)
void	setCustomerAccount(String customerAccount)
void	setCustomerBalance(PaymentMethod.CustomerBalance customerBalance)
void	setCustomerObject(Customer expandableObject)
void	setEps(PaymentMethod.Eps eps)
void	setFpx(PaymentMethod.Fpx fpx)
void	setGiropay(PaymentMethod.Giropay giropay)
void	setGopay(PaymentMethod.Gopay gopay)
void	setGrabpay(PaymentMethod.Grabpay grabpay)
void	setId(String id)	Unique identifier for the object.
void	setIdBankTransfer(PaymentMethod.IdBankTransfer idBankTransfer)
void	setIdeal(PaymentMethod.Ideal ideal)
void	setInteracPresent(PaymentMethod.InteracPresent interacPresent)
void	setKakaoPay(PaymentMethod.KakaoPay kakaoPay)
void	setKlarna(PaymentMethod.Klarna klarna)
void	setKonbini(PaymentMethod.Konbini konbini)
void	setKrCard(PaymentMethod.KrCard krCard)
void	setLatestActiveMandate(Mandate latestActiveMandate)	The Mandate object of the most recently created Mandate associated with this payment method.
void	setLink(PaymentMethod.Link link)
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setMbWay(PaymentMethod.MbWay mbWay)
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setMobilepay(PaymentMethod.Mobilepay mobilepay)
void	setMultibanco(PaymentMethod.Multibanco multibanco)
void	setNaverPay(PaymentMethod.NaverPay naverPay)
void	setNzBankAccount(PaymentMethod.NzBankAccount nzBankAccount)
void	setObject(String object)	String representing the object's type.
void	setOxxo(PaymentMethod.Oxxo oxxo)
void	setP24(PaymentMethod.P24 p24)
void	setPayByBank(PaymentMethod.PayByBank payByBank)
void	setPayco(PaymentMethod.Payco payco)
void	setPaynow(PaymentMethod.Paynow paynow)
void	setPaypal(PaymentMethod.Paypal paypal)
void	setPaypay(PaymentMethod.Paypay paypay)
void	setPayto(PaymentMethod.Payto payto)
void	setPix(PaymentMethod.Pix pix)
void	setPromptpay(PaymentMethod.Promptpay promptpay)
void	setQris(PaymentMethod.Qris qris)
void	setRadarOptions(PaymentMethod.RadarOptions radarOptions)	Options to configure Radar.
void	setRechnung(PaymentMethod.Rechnung rechnung)
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setRevolutPay(PaymentMethod.RevolutPay revolutPay)
void	setSamsungPay(PaymentMethod.SamsungPay samsungPay)
void	setSatispay(PaymentMethod.Satispay satispay)
void	setSepaDebit(PaymentMethod.SepaDebit sepaDebit)
void	setShopeepay(PaymentMethod.Shopeepay shopeepay)
void	setSofort(PaymentMethod.Sofort sofort)
void	setStripeBalance(PaymentMethod.StripeBalance stripeBalance)
void	setSwish(PaymentMethod.Swish swish)
void	setTwint(PaymentMethod.Twint twint)
void	setType(String type)	The type of the PaymentMethod.
void	setUsBankAccount(PaymentMethod.UsBankAccount usBankAccount)
void	setWechatPay(PaymentMethod.WechatPay wechatPay)
void	setZip(PaymentMethod.Zip zip)
PaymentMethod	update(PaymentMethodUpdateParams params)	Updates a PaymentMethod object.
PaymentMethod	update(PaymentMethodUpdateParams params, RequestOptions options)	Updates a PaymentMethod object.
PaymentMethod	update(Map<String,Object> params)	Updates a PaymentMethod object.
PaymentMethod	update(Map<String,Object> params, RequestOptions options)	Updates a PaymentMethod object.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, 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

PaymentMethod

public PaymentMethod()

Method Details

getCustomer

public String getCustomer()

Get ID of expandable customer object.

setCustomer

public void setCustomer(String id)

getCustomerObject

public Customer getCustomerObject()

Get expanded customer.

setCustomerObject

public void setCustomerObject(Customer expandableObject)

attach

public PaymentMethod attach()
                     throws StripeException

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See Optimizing cards for future payments for more information about setting up future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

Throws:

StripeException

attach

public PaymentMethod attach(RequestOptions options)
                     throws StripeException

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See Optimizing cards for future payments for more information about setting up future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

Throws:

StripeException

attach

public PaymentMethod attach(Map<String,Object> params)
                     throws StripeException

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See Optimizing cards for future payments for more information about setting up future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

Throws:

StripeException

attach

public PaymentMethod attach(Map<String,Object> params,
 RequestOptions options)
                     throws StripeException

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See Optimizing cards for future payments for more information about setting up future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

Throws:

StripeException

attach

public PaymentMethod attach(PaymentMethodAttachParams params)
                     throws StripeException

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See Optimizing cards for future payments for more information about setting up future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

Throws:

StripeException

attach

public PaymentMethod attach(PaymentMethodAttachParams params,
 RequestOptions options)
                     throws StripeException

Attaches a PaymentMethod object to a Customer.

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See Optimizing cards for future payments for more information about setting up future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

Throws:

StripeException

checkBalance

public PaymentMethodBalance checkBalance()
                                  throws StripeException

Retrieves a payment method’s balance.

Throws:

StripeException

checkBalance

public PaymentMethodBalance checkBalance(RequestOptions options)
                                  throws StripeException

Retrieves a payment method’s balance.

Throws:

StripeException

checkBalance

public PaymentMethodBalance checkBalance(Map<String,Object> params)
                                  throws StripeException

Retrieves a payment method’s balance.

Throws:

StripeException

checkBalance

public PaymentMethodBalance checkBalance(Map<String,Object> params,
 RequestOptions options)
                                  throws StripeException

Retrieves a payment method’s balance.

Throws:

StripeException

checkBalance

public PaymentMethodBalance checkBalance(PaymentMethodCheckBalanceParams params)
                                  throws StripeException

Retrieves a payment method’s balance.

Throws:

StripeException

checkBalance

public PaymentMethodBalance checkBalance(PaymentMethodCheckBalanceParams params,
 RequestOptions options)
                                  throws StripeException

Retrieves a payment method’s balance.

Throws:

StripeException

create

public static PaymentMethod create(Map<String,Object> params)
                            throws StripeException

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

Throws:

StripeException

create

public static PaymentMethod create(Map<String,Object> params,
 RequestOptions options)
                            throws StripeException

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

Throws:

StripeException

create

public static PaymentMethod create(PaymentMethodCreateParams params)
                            throws StripeException

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

Throws:

StripeException

create

public static PaymentMethod create(PaymentMethodCreateParams params,
 RequestOptions options)
                            throws StripeException

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

Throws:

StripeException

detach

public PaymentMethod detach()
                     throws StripeException

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

Throws:

StripeException

detach

public PaymentMethod detach(RequestOptions options)
                     throws StripeException

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

Throws:

StripeException

detach

public PaymentMethod detach(Map<String,Object> params)
                     throws StripeException

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

Throws:

StripeException

detach

public PaymentMethod detach(Map<String,Object> params,
 RequestOptions options)
                     throws StripeException

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

Throws:

StripeException

detach

public PaymentMethod detach(PaymentMethodDetachParams params)
                     throws StripeException

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

Throws:

StripeException

detach

public PaymentMethod detach(PaymentMethodDetachParams params,
 RequestOptions options)
                     throws StripeException

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

Throws:

StripeException

list

public static PaymentMethodCollection list(Map<String,Object> params)
                                    throws StripeException

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

Throws:

StripeException

list

public static PaymentMethodCollection list(Map<String,Object> params,
 RequestOptions options)
                                    throws StripeException

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

Throws:

StripeException

list

public static PaymentMethodCollection list(PaymentMethodListParams params)
                                    throws StripeException

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

Throws:

StripeException

list

public static PaymentMethodCollection list(PaymentMethodListParams params,
 RequestOptions options)
                                    throws StripeException

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

Throws:

StripeException

retrieve

public static PaymentMethod retrieve(String paymentMethod)
                              throws StripeException

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

Throws:

StripeException

retrieve

public static PaymentMethod retrieve(String paymentMethod,
 RequestOptions options)
                              throws StripeException

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

Throws:

StripeException

retrieve

public static PaymentMethod retrieve(String paymentMethod,
 Map<String,Object> params,
 RequestOptions options)
                              throws StripeException

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

Throws:

StripeException

retrieve

public static PaymentMethod retrieve(String paymentMethod,
 PaymentMethodRetrieveParams params,
 RequestOptions options)
                              throws StripeException

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

Throws:

StripeException

update

public PaymentMethod update(Map<String,Object> params)
                     throws StripeException

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.

Specified by:

update in interface MetadataStore<PaymentMethod>

Throws:

StripeException

update

public PaymentMethod update(Map<String,Object> params,
 RequestOptions options)
                     throws StripeException

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.

Specified by:

update in interface MetadataStore<PaymentMethod>

Throws:

StripeException

update

public PaymentMethod update(PaymentMethodUpdateParams params)
                     throws StripeException

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.

Throws:

StripeException

update

public PaymentMethod update(PaymentMethodUpdateParams params,
 RequestOptions options)
                     throws StripeException

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getAcssDebit

public PaymentMethod.AcssDebit getAcssDebit()

getAffirm

public PaymentMethod.Affirm getAffirm()

getAfterpayClearpay

public PaymentMethod.AfterpayClearpay getAfterpayClearpay()

getAlipay

public PaymentMethod.Alipay getAlipay()

getAllowRedisplay

public String getAllowRedisplay()

This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.

One of always, limited, or unspecified.

getAlma

public PaymentMethod.Alma getAlma()

getAmazonPay

public PaymentMethod.AmazonPay getAmazonPay()

getAuBecsDebit

public PaymentMethod.AuBecsDebit getAuBecsDebit()

getBacsDebit

public PaymentMethod.BacsDebit getBacsDebit()

getBancontact

public PaymentMethod.Bancontact getBancontact()

getBillie

public PaymentMethod.Billie getBillie()

getBillingDetails

public PaymentMethod.BillingDetails getBillingDetails()

getBlik

public PaymentMethod.Blik getBlik()

getBoleto

public PaymentMethod.Boleto getBoleto()

getCard

public PaymentMethod.Card getCard()

getCardPresent

public PaymentMethod.CardPresent getCardPresent()

getCashapp

public PaymentMethod.Cashapp getCashapp()

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getCrypto

public PaymentMethod.Crypto getCrypto()

getCustom

public PaymentMethod.Custom getCustom()

getCustomerAccount

public String getCustomerAccount()

getCustomerBalance

public PaymentMethod.CustomerBalance getCustomerBalance()

getEps

public PaymentMethod.Eps getEps()

getFpx

public PaymentMethod.Fpx getFpx()

getGiropay

public PaymentMethod.Giropay getGiropay()

getGopay

public PaymentMethod.Gopay getGopay()

getGrabpay

public PaymentMethod.Grabpay getGrabpay()

getIdBankTransfer

public PaymentMethod.IdBankTransfer getIdBankTransfer()

getIdeal

public PaymentMethod.Ideal getIdeal()

getInteracPresent

public PaymentMethod.InteracPresent getInteracPresent()

getKakaoPay

public PaymentMethod.KakaoPay getKakaoPay()

getKlarna

public PaymentMethod.Klarna getKlarna()

getKonbini

public PaymentMethod.Konbini getKonbini()

getKrCard

public PaymentMethod.KrCard getKrCard()

getLatestActiveMandate

public Mandate getLatestActiveMandate()

The Mandate object of the most recently created Mandate associated with this payment method.

getLink

public PaymentMethod.Link getLink()

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getMbWay

public PaymentMethod.MbWay getMbWay()

getMobilepay

public PaymentMethod.Mobilepay getMobilepay()

getMultibanco

public PaymentMethod.Multibanco getMultibanco()

getNaverPay

public PaymentMethod.NaverPay getNaverPay()

getNzBankAccount

public PaymentMethod.NzBankAccount getNzBankAccount()

getObject

public String getObject()

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

Equal to payment_method.

getOxxo

public PaymentMethod.Oxxo getOxxo()

getP24

public PaymentMethod.P24 getP24()

getPayByBank

public PaymentMethod.PayByBank getPayByBank()

getPayco

public PaymentMethod.Payco getPayco()

getPaynow

public PaymentMethod.Paynow getPaynow()

getPaypal

public PaymentMethod.Paypal getPaypal()

getPaypay

public PaymentMethod.Paypay getPaypay()

getPayto

public PaymentMethod.Payto getPayto()

getPix

public PaymentMethod.Pix getPix()

getPromptpay

public PaymentMethod.Promptpay getPromptpay()

getQris

public PaymentMethod.Qris getQris()

getRadarOptions

public PaymentMethod.RadarOptions getRadarOptions()

Options to configure Radar. See Radar Session for more information.

getRechnung

public PaymentMethod.Rechnung getRechnung()

getRevolutPay

public PaymentMethod.RevolutPay getRevolutPay()

getSamsungPay

public PaymentMethod.SamsungPay getSamsungPay()

getSatispay

public PaymentMethod.Satispay getSatispay()

getSepaDebit

public PaymentMethod.SepaDebit getSepaDebit()

getShopeepay

public PaymentMethod.Shopeepay getShopeepay()

getSofort

public PaymentMethod.Sofort getSofort()

getStripeBalance

public PaymentMethod.StripeBalance getStripeBalance()

getSwish

public PaymentMethod.Swish getSwish()

getTwint

public PaymentMethod.Twint getTwint()

getType

public String getType()

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

One of acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, blik, boleto, card, card_present, cashapp, crypto, custom, customer_balance, eps, fpx, giropay, gopay, grabpay, id_bank_transfer, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, qris, rechnung, revolut_pay, samsung_pay, satispay, sepa_debit, shopeepay, sofort, stripe_balance, swish, twint, us_bank_account, wechat_pay, or zip.

getUsBankAccount

public PaymentMethod.UsBankAccount getUsBankAccount()

getWechatPay

public PaymentMethod.WechatPay getWechatPay()

getZip

public PaymentMethod.Zip getZip()

setAcssDebit

public void setAcssDebit(PaymentMethod.AcssDebit acssDebit)

setAffirm

public void setAffirm(PaymentMethod.Affirm affirm)

setAfterpayClearpay

public void setAfterpayClearpay(PaymentMethod.AfterpayClearpay afterpayClearpay)

setAlipay

public void setAlipay(PaymentMethod.Alipay alipay)

setAllowRedisplay

public void setAllowRedisplay(String allowRedisplay)

This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.

One of always, limited, or unspecified.

setAlma

public void setAlma(PaymentMethod.Alma alma)

setAmazonPay

public void setAmazonPay(PaymentMethod.AmazonPay amazonPay)

setAuBecsDebit

public void setAuBecsDebit(PaymentMethod.AuBecsDebit auBecsDebit)

setBacsDebit

public void setBacsDebit(PaymentMethod.BacsDebit bacsDebit)

setBancontact

public void setBancontact(PaymentMethod.Bancontact bancontact)

setBillie

public void setBillie(PaymentMethod.Billie billie)

setBillingDetails

public void setBillingDetails(PaymentMethod.BillingDetails billingDetails)

setBlik

public void setBlik(PaymentMethod.Blik blik)

setBoleto

public void setBoleto(PaymentMethod.Boleto boleto)

setCard

public void setCard(PaymentMethod.Card card)

setCardPresent

public void setCardPresent(PaymentMethod.CardPresent cardPresent)

setCashapp

public void setCashapp(PaymentMethod.Cashapp cashapp)

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setCrypto

public void setCrypto(PaymentMethod.Crypto crypto)

setCustom

public void setCustom(PaymentMethod.Custom custom)

setCustomerAccount

public void setCustomerAccount(String customerAccount)

setCustomerBalance

public void setCustomerBalance(PaymentMethod.CustomerBalance customerBalance)

setEps

public void setEps(PaymentMethod.Eps eps)

setFpx

public void setFpx(PaymentMethod.Fpx fpx)

setGiropay

public void setGiropay(PaymentMethod.Giropay giropay)

setGopay

public void setGopay(PaymentMethod.Gopay gopay)

setGrabpay

public void setGrabpay(PaymentMethod.Grabpay grabpay)

setId

public void setId(String id)

Unique identifier for the object.

setIdBankTransfer

public void setIdBankTransfer(PaymentMethod.IdBankTransfer idBankTransfer)

setIdeal

public void setIdeal(PaymentMethod.Ideal ideal)

setInteracPresent

public void setInteracPresent(PaymentMethod.InteracPresent interacPresent)

setKakaoPay

public void setKakaoPay(PaymentMethod.KakaoPay kakaoPay)

setKlarna

public void setKlarna(PaymentMethod.Klarna klarna)

setKonbini

public void setKonbini(PaymentMethod.Konbini konbini)

setKrCard

public void setKrCard(PaymentMethod.KrCard krCard)

setLatestActiveMandate

public void setLatestActiveMandate(Mandate latestActiveMandate)

The Mandate object of the most recently created Mandate associated with this payment method.

setLink

public void setLink(PaymentMethod.Link link)

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setMbWay

public void setMbWay(PaymentMethod.MbWay mbWay)

setMetadata

public void setMetadata(Map<String,String> metadata)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

setMobilepay

public void setMobilepay(PaymentMethod.Mobilepay mobilepay)

setMultibanco

public void setMultibanco(PaymentMethod.Multibanco multibanco)

setNaverPay

public void setNaverPay(PaymentMethod.NaverPay naverPay)

setNzBankAccount

public void setNzBankAccount(PaymentMethod.NzBankAccount nzBankAccount)

setObject

public void setObject(String object)

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

Equal to payment_method.

setOxxo

public void setOxxo(PaymentMethod.Oxxo oxxo)

setP24

public void setP24(PaymentMethod.P24 p24)

setPayByBank

public void setPayByBank(PaymentMethod.PayByBank payByBank)

setPayco

public void setPayco(PaymentMethod.Payco payco)

setPaynow

public void setPaynow(PaymentMethod.Paynow paynow)

setPaypal

public void setPaypal(PaymentMethod.Paypal paypal)

setPaypay

public void setPaypay(PaymentMethod.Paypay paypay)

setPayto

public void setPayto(PaymentMethod.Payto payto)

setPix

public void setPix(PaymentMethod.Pix pix)

setPromptpay

public void setPromptpay(PaymentMethod.Promptpay promptpay)

setQris

public void setQris(PaymentMethod.Qris qris)

setRadarOptions

public void setRadarOptions(PaymentMethod.RadarOptions radarOptions)

Options to configure Radar. See Radar Session for more information.

setRechnung

public void setRechnung(PaymentMethod.Rechnung rechnung)

setRevolutPay

public void setRevolutPay(PaymentMethod.RevolutPay revolutPay)

setSamsungPay

public void setSamsungPay(PaymentMethod.SamsungPay samsungPay)

setSatispay

public void setSatispay(PaymentMethod.Satispay satispay)

setSepaDebit

public void setSepaDebit(PaymentMethod.SepaDebit sepaDebit)

setShopeepay

public void setShopeepay(PaymentMethod.Shopeepay shopeepay)

setSofort

public void setSofort(PaymentMethod.Sofort sofort)

setStripeBalance

public void setStripeBalance(PaymentMethod.StripeBalance stripeBalance)

setSwish

public void setSwish(PaymentMethod.Swish swish)

setTwint

public void setTwint(PaymentMethod.Twint twint)

setType

public void setType(String type)

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

One of acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, blik, boleto, card, card_present, cashapp, crypto, custom, customer_balance, eps, fpx, giropay, gopay, grabpay, id_bank_transfer, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, qris, rechnung, revolut_pay, samsung_pay, satispay, sepa_debit, shopeepay, sofort, stripe_balance, swish, twint, us_bank_account, wechat_pay, or zip.

setUsBankAccount

public void setUsBankAccount(PaymentMethod.UsBankAccount usBankAccount)

setWechatPay

public void setWechatPay(PaymentMethod.WechatPay wechatPay)

setZip

public void setZip(PaymentMethod.Zip zip)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

getMetadata

public Map<String,String> getMetadata()

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Specified by:

getMetadata in interface MetadataStore<PaymentMethod>