Package com.stripe.model

Class PaymentMethodDomain

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.PaymentMethodDomain

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class PaymentMethodDomain
extends ApiResource
implements HasId

A payment method domain represents a web domain that you have registered with Stripe. Stripe Elements use registered payment method domains to control where certain payment methods are shown.

Related guide: Payment method domains.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaymentMethodDomain.ApplePay	Indicates the status of a specific payment method on a payment method domain.
static class	PaymentMethodDomain.GooglePay	Indicates the status of a specific payment method on a payment method domain.
static class	PaymentMethodDomain.Link	Indicates the status of a specific payment method on a payment method domain.
static class	PaymentMethodDomain.Paypal	Indicates the status of a specific payment method on a payment method domain.

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static PaymentMethodDomain	create(PaymentMethodDomainCreateParams params)	Creates a payment method domain.
static PaymentMethodDomain	create(PaymentMethodDomainCreateParams params, RequestOptions options)	Creates a payment method domain.
static PaymentMethodDomain	create(Map<String,Object> params)	Creates a payment method domain.
static PaymentMethodDomain	create(Map<String,Object> params, RequestOptions options)	Creates a payment method domain.
boolean	equals(Object o)
PaymentMethodDomain.ApplePay	getApplePay()	Indicates the status of a specific payment method on a payment method domain.
Long	getCreated()	Time at which the object was created.
String	getDomainName()	The domain name that this payment method domain object represents.
Boolean	getEnabled()	Whether this payment method domain is enabled.
PaymentMethodDomain.GooglePay	getGooglePay()	Indicates the status of a specific payment method on a payment method domain.
String	getId()	Unique identifier for the object.
PaymentMethodDomain.Link	getLink()	Indicates the status of a specific payment method on a payment method domain.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
String	getObject()	String representing the object's type.
PaymentMethodDomain.Paypal	getPaypal()	Indicates the status of a specific payment method on a payment method domain.
int	hashCode()
static PaymentMethodDomainCollection	list(PaymentMethodDomainListParams params)	Lists the details of existing payment method domains.
static PaymentMethodDomainCollection	list(PaymentMethodDomainListParams params, RequestOptions options)	Lists the details of existing payment method domains.
static PaymentMethodDomainCollection	list(Map<String,Object> params)	Lists the details of existing payment method domains.
static PaymentMethodDomainCollection	list(Map<String,Object> params, RequestOptions options)	Lists the details of existing payment method domains.
static PaymentMethodDomain	retrieve(String paymentMethodDomain)	Retrieves the details of an existing payment method domain.
static PaymentMethodDomain	retrieve(String paymentMethodDomain, RequestOptions options)	Retrieves the details of an existing payment method domain.
static PaymentMethodDomain	retrieve(String paymentMethodDomain, PaymentMethodDomainRetrieveParams params, RequestOptions options)	Retrieves the details of an existing payment method domain.
static PaymentMethodDomain	retrieve(String paymentMethodDomain, Map<String,Object> params, RequestOptions options)	Retrieves the details of an existing payment method domain.
void	setApplePay(PaymentMethodDomain.ApplePay applePay)	Indicates the status of a specific payment method on a payment method domain.
void	setCreated(Long created)	Time at which the object was created.
void	setDomainName(String domainName)	The domain name that this payment method domain object represents.
void	setEnabled(Boolean enabled)	Whether this payment method domain is enabled.
void	setGooglePay(PaymentMethodDomain.GooglePay googlePay)	Indicates the status of a specific payment method on a payment method domain.
void	setId(String id)	Unique identifier for the object.
void	setLink(PaymentMethodDomain.Link link)	Indicates the status of a specific payment method on a payment method domain.
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	setObject(String object)	String representing the object's type.
void	setPaypal(PaymentMethodDomain.Paypal paypal)	Indicates the status of a specific payment method on a payment method domain.
void	setResponseGetter(StripeResponseGetter responseGetter)	The error message associated with the status of the payment method on the domain.
PaymentMethodDomain	update(PaymentMethodDomainUpdateParams params)	Updates an existing payment method domain.
PaymentMethodDomain	update(PaymentMethodDomainUpdateParams params, RequestOptions options)	Updates an existing payment method domain.
PaymentMethodDomain	update(Map<String,Object> params)	Updates an existing payment method domain.
PaymentMethodDomain	update(Map<String,Object> params, RequestOptions options)	Updates an existing payment method domain.
PaymentMethodDomain	validate()	Some payment methods such as Apple Pay require additional steps to verify a domain.
PaymentMethodDomain	validate(RequestOptions options)	Some payment methods such as Apple Pay require additional steps to verify a domain.
PaymentMethodDomain	validate(PaymentMethodDomainValidateParams params)	Some payment methods such as Apple Pay require additional steps to verify a domain.
PaymentMethodDomain	validate(PaymentMethodDomainValidateParams params, RequestOptions options)	Some payment methods such as Apple Pay require additional steps to verify a domain.
PaymentMethodDomain	validate(Map<String,Object> params)	Some payment methods such as Apple Pay require additional steps to verify a domain.
PaymentMethodDomain	validate(Map<String,Object> params, RequestOptions options)	Some payment methods such as Apple Pay require additional steps to verify a domain.

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

PaymentMethodDomain

public PaymentMethodDomain()

Method Details

create

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

Creates a payment method domain.

Throws:

StripeException

create

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

Creates a payment method domain.

Throws:

StripeException

create

public static PaymentMethodDomain create(PaymentMethodDomainCreateParams params)
                                  throws StripeException

Creates a payment method domain.

Throws:

StripeException

create

public static PaymentMethodDomain create(PaymentMethodDomainCreateParams params,
 RequestOptions options)
                                  throws StripeException

Creates a payment method domain.

Throws:

StripeException

list

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

Lists the details of existing payment method domains.

Throws:

StripeException

list

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

Lists the details of existing payment method domains.

Throws:

StripeException

list

public static PaymentMethodDomainCollection list(PaymentMethodDomainListParams params)
                                          throws StripeException

Lists the details of existing payment method domains.

Throws:

StripeException

list

public static PaymentMethodDomainCollection list(PaymentMethodDomainListParams params,
 RequestOptions options)
                                          throws StripeException

Lists the details of existing payment method domains.

Throws:

StripeException

retrieve

public static PaymentMethodDomain retrieve(String paymentMethodDomain)
                                    throws StripeException

Retrieves the details of an existing payment method domain.

Throws:

StripeException

retrieve

public static PaymentMethodDomain retrieve(String paymentMethodDomain,
 RequestOptions options)
                                    throws StripeException

Retrieves the details of an existing payment method domain.

Throws:

StripeException

retrieve

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

Retrieves the details of an existing payment method domain.

Throws:

StripeException

retrieve

public static PaymentMethodDomain retrieve(String paymentMethodDomain,
 PaymentMethodDomainRetrieveParams params,
 RequestOptions options)
                                    throws StripeException

Retrieves the details of an existing payment method domain.

Throws:

StripeException

update

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

Updates an existing payment method domain.

Throws:

StripeException

update

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

Updates an existing payment method domain.

Throws:

StripeException

update

public PaymentMethodDomain update(PaymentMethodDomainUpdateParams params)
                           throws StripeException

Updates an existing payment method domain.

Throws:

StripeException

update

public PaymentMethodDomain update(PaymentMethodDomainUpdateParams params,
 RequestOptions options)
                           throws StripeException

Updates an existing payment method domain.

Throws:

StripeException

validate

public PaymentMethodDomain validate()
                             throws StripeException

Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements for this domain until it is active.

To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.

Related guides: Payment method domains.

Throws:

StripeException

validate

public PaymentMethodDomain validate(RequestOptions options)
                             throws StripeException

Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements for this domain until it is active.

To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.

Related guides: Payment method domains.

Throws:

StripeException

validate

public PaymentMethodDomain validate(Map<String,Object> params)
                             throws StripeException

Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements for this domain until it is active.

To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.

Related guides: Payment method domains.

Throws:

StripeException

validate

public PaymentMethodDomain validate(Map<String,Object> params,
 RequestOptions options)
                             throws StripeException

Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements for this domain until it is active.

To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.

Related guides: Payment method domains.

Throws:

StripeException

validate

public PaymentMethodDomain validate(PaymentMethodDomainValidateParams params)
                             throws StripeException

Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements for this domain until it is active.

To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.

Related guides: Payment method domains.

Throws:

StripeException

validate

public PaymentMethodDomain validate(PaymentMethodDomainValidateParams params,
 RequestOptions options)
                             throws StripeException

Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements for this domain until it is active.

To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.

Related guides: Payment method domains.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

The error message associated with the status of the payment method on the domain.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

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

getApplePay

public PaymentMethodDomain.ApplePay getApplePay()

Indicates the status of a specific payment method on a payment method domain.

getCreated

public Long getCreated()

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

getDomainName

public String getDomainName()

The domain name that this payment method domain object represents.

getEnabled

public Boolean getEnabled()

Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.

getGooglePay

public PaymentMethodDomain.GooglePay getGooglePay()

Indicates the status of a specific payment method on a payment method domain.

getLink

public PaymentMethodDomain.Link getLink()

Indicates the status of a specific payment method on a payment method domain.

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.

getObject

public String getObject()

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

Equal to payment_method_domain.

getPaypal

public PaymentMethodDomain.Paypal getPaypal()

Indicates the status of a specific payment method on a payment method domain.

setApplePay

public void setApplePay(PaymentMethodDomain.ApplePay applePay)

Indicates the status of a specific payment method on a payment method domain.

setCreated

public void setCreated(Long created)

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

setDomainName

public void setDomainName(String domainName)

The domain name that this payment method domain object represents.

setEnabled

public void setEnabled(Boolean enabled)

Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.

setGooglePay

public void setGooglePay(PaymentMethodDomain.GooglePay googlePay)

Indicates the status of a specific payment method on a payment method domain.

setId

public void setId(String id)

Unique identifier for the object.

setLink

public void setLink(PaymentMethodDomain.Link link)

Indicates the status of a specific payment method on a payment method domain.

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.

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

setPaypal

public void setPaypal(PaymentMethodDomain.Paypal paypal)

Indicates the status of a specific payment method on a payment method domain.

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