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
static class	PaymentMethod.Affirm
static class	PaymentMethod.AfterpayClearpay
static class	PaymentMethod.Alipay
static class	PaymentMethod.AmazonPay
static class	PaymentMethod.AuBecsDebit
static class	PaymentMethod.BacsDebit
static class	PaymentMethod.Bancontact
static class	PaymentMethod.BillingDetails
static class	PaymentMethod.Blik
static class	PaymentMethod.Boleto
static class	PaymentMethod.Card
static class	PaymentMethod.CardPresent	Owner's verified shipping address.
static class	PaymentMethod.Cashapp	The preferred network for the card.
static class	PaymentMethod.CustomerBalance
static class	PaymentMethod.Eps
static class	PaymentMethod.Fpx
static class	PaymentMethod.Giropay
static class	PaymentMethod.Grabpay
static class	PaymentMethod.Ideal
static class	PaymentMethod.InteracPresent
static class	PaymentMethod.Klarna	The preferred network for the card.
static class	PaymentMethod.Konbini	The four-digit year of birth.
static class	PaymentMethod.Link
static class	PaymentMethod.Mobilepay
static class	PaymentMethod.Oxxo
static class	PaymentMethod.P24
static class	PaymentMethod.Paynow
static class	PaymentMethod.Paypal
static class	PaymentMethod.Pix
static class	PaymentMethod.Promptpay
static class	PaymentMethod.RadarOptions	Options to configure Radar.
static class	PaymentMethod.RevolutPay
static class	PaymentMethod.SepaDebit
static class	PaymentMethod.Sofort	Get expanded setupAttempt.
static class	PaymentMethod.Swish
static class	PaymentMethod.UsBankAccount
static class	PaymentMethod.WechatPay	The reason why this PaymentMethod's fingerprint has been blocked
static class	PaymentMethod.Zip

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(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)
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.AmazonPay	getAmazonPay()
PaymentMethod.AuBecsDebit	getAuBecsDebit()
PaymentMethod.BacsDebit	getBacsDebit()
PaymentMethod.Bancontact	getBancontact()
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.
String	getCustomer()	Get ID of expandable customer object.
PaymentMethod.CustomerBalance	getCustomerBalance()
Customer	getCustomerObject()	Get expanded customer.
PaymentMethod.Eps	getEps()
PaymentMethod.Fpx	getFpx()
PaymentMethod.Giropay	getGiropay()
PaymentMethod.Grabpay	getGrabpay()
String	getId()	Unique identifier for the object.
PaymentMethod.Ideal	getIdeal()
PaymentMethod.InteracPresent	getInteracPresent()
PaymentMethod.Klarna	getKlarna()
PaymentMethod.Konbini	getKonbini()
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.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
PaymentMethod.Mobilepay	getMobilepay()
String	getObject()	String representing the object's type.
PaymentMethod.Oxxo	getOxxo()
PaymentMethod.P24	getP24()
PaymentMethod.Paynow	getPaynow()
PaymentMethod.Paypal	getPaypal()
PaymentMethod.Pix	getPix()
PaymentMethod.Promptpay	getPromptpay()
PaymentMethod.RadarOptions	getRadarOptions()	Options to configure Radar.
PaymentMethod.RevolutPay	getRevolutPay()
PaymentMethod.SepaDebit	getSepaDebit()
PaymentMethod.Sofort	getSofort()
PaymentMethod.Swish	getSwish()
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	setAmazonPay(PaymentMethod.AmazonPay amazonPay)
void	setAuBecsDebit(PaymentMethod.AuBecsDebit auBecsDebit)
void	setBacsDebit(PaymentMethod.BacsDebit bacsDebit)
void	setBancontact(PaymentMethod.Bancontact bancontact)
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	setCustomer(String id)
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	setGrabpay(PaymentMethod.Grabpay grabpay)
void	setId(String id)	Unique identifier for the object.
void	setIdeal(PaymentMethod.Ideal ideal)
void	setInteracPresent(PaymentMethod.InteracPresent interacPresent)
void	setKlarna(PaymentMethod.Klarna klarna)
void	setKonbini(PaymentMethod.Konbini konbini)
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	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setMobilepay(PaymentMethod.Mobilepay mobilepay)
void	setObject(String object)	String representing the object's type.
void	setOxxo(PaymentMethod.Oxxo oxxo)
void	setP24(PaymentMethod.P24 p24)
void	setPaynow(PaymentMethod.Paynow paynow)
void	setPaypal(PaymentMethod.Paypal paypal)
void	setPix(PaymentMethod.Pix pix)
void	setPromptpay(PaymentMethod.Promptpay promptpay)
void	setRadarOptions(PaymentMethod.RadarOptions radarOptions)	Options to configure Radar.
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	setSepaDebit(PaymentMethod.SepaDebit sepaDebit)
void	setSofort(PaymentMethod.Sofort sofort)
void	setSwish(PaymentMethod.Swish swish)
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, 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

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(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

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 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 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 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 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.

getAmazonPay

public PaymentMethod.AmazonPay getAmazonPay()

getAuBecsDebit

public PaymentMethod.AuBecsDebit getAuBecsDebit()

getBacsDebit

public PaymentMethod.BacsDebit getBacsDebit()

getBancontact

public PaymentMethod.Bancontact getBancontact()

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.

getCustomerBalance

public PaymentMethod.CustomerBalance getCustomerBalance()

getEps

public PaymentMethod.Eps getEps()

getFpx

public PaymentMethod.Fpx getFpx()

getGiropay

public PaymentMethod.Giropay getGiropay()

getGrabpay

public PaymentMethod.Grabpay getGrabpay()

getIdeal

public PaymentMethod.Ideal getIdeal()

getInteracPresent

public PaymentMethod.InteracPresent getInteracPresent()

getKlarna

public PaymentMethod.Klarna getKlarna()

getKonbini

public PaymentMethod.Konbini getKonbini()

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.

getMobilepay

public PaymentMethod.Mobilepay getMobilepay()

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()

getPaynow

public PaymentMethod.Paynow getPaynow()

getPaypal

public PaymentMethod.Paypal getPaypal()

getPix

public PaymentMethod.Pix getPix()

getPromptpay

public PaymentMethod.Promptpay getPromptpay()

getRadarOptions

public PaymentMethod.RadarOptions getRadarOptions()

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

getRevolutPay

public PaymentMethod.RevolutPay getRevolutPay()

getSepaDebit

public PaymentMethod.SepaDebit getSepaDebit()

getSofort

public PaymentMethod.Sofort getSofort()

getSwish

public PaymentMethod.Swish getSwish()

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, amazon_pay, au_becs_debit, bacs_debit, bancontact, blik, boleto, card, card_present, cashapp, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, klarna, konbini, link, mobilepay, oxxo, p24, paynow, paypal, pix, promptpay, revolut_pay, sepa_debit, sofort, swish, 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.

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)

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.

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)

setGrabpay

public void setGrabpay(PaymentMethod.Grabpay grabpay)

setId

public void setId(String id)

Unique identifier for the object.

setIdeal

public void setIdeal(PaymentMethod.Ideal ideal)

setInteracPresent

public void setInteracPresent(PaymentMethod.InteracPresent interacPresent)

setKlarna

public void setKlarna(PaymentMethod.Klarna klarna)

setKonbini

public void setKonbini(PaymentMethod.Konbini konbini)

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.

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)

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)

setPaynow

public void setPaynow(PaymentMethod.Paynow paynow)

setPaypal

public void setPaypal(PaymentMethod.Paypal paypal)

setPix

public void setPix(PaymentMethod.Pix pix)

setPromptpay

public void setPromptpay(PaymentMethod.Promptpay promptpay)

setRadarOptions

public void setRadarOptions(PaymentMethod.RadarOptions radarOptions)

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

setRevolutPay

public void setRevolutPay(PaymentMethod.RevolutPay revolutPay)

setSepaDebit

public void setSepaDebit(PaymentMethod.SepaDebit sepaDebit)

setSofort

public void setSofort(PaymentMethod.Sofort sofort)

setSwish

public void setSwish(PaymentMethod.Swish swish)

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, amazon_pay, au_becs_debit, bacs_debit, bancontact, blik, boleto, card, card_present, cashapp, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, klarna, konbini, link, mobilepay, oxxo, p24, paynow, paypal, pix, promptpay, revolut_pay, sepa_debit, sofort, swish, 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>