Package com.stripe.model.threedsecure

Class Authentication

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.threedsecure.Authentication

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class Authentication
extends ApiResource
implements HasId

The Standalone 3DS API allows you to run EMV 3D Secure (3DS) authentication using Stripe while authorizing the payment with any PSP.

Related guide: Standalone 3DS

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Authentication.AcquirerDetails	Contains additional details about the acquirer for a 3DS Authentication.
static class	Authentication.Channel	Contains details on the channel used (browser, 3RI) for a standalone 3DS Authentication.
static class	Authentication.FlowPreference	Contains details of the flow preference used for a standalone 3DS Authentication.
static class	Authentication.FutureUsage	Contains information about the future authorisations related to this authentication.
static class	Authentication.OutcomeDetails	Contains details on the result for a standalone 3DS Authentication.
static class	Authentication.ShippingAddress	Contains details about the shipping address for a 3DS Authentication.

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

Method Summary

Modifier and Type	Method	Description
Authentication	cancel()	This endpoint cancels a 3DS Authentication.
Authentication	cancel(RequestOptions options)	This endpoint cancels a 3DS Authentication.
Authentication	cancel(AuthenticationCancelParams params)	This endpoint cancels a 3DS Authentication.
Authentication	cancel(AuthenticationCancelParams params, RequestOptions options)	This endpoint cancels a 3DS Authentication.
Authentication	cancel(Map<String,Object> params)	This endpoint cancels a 3DS Authentication.
Authentication	cancel(Map<String,Object> params, RequestOptions options)	This endpoint cancels a 3DS Authentication.
protected boolean	canEqual(Object other)
static Authentication	create(AuthenticationCreateParams params)	This endpoint creates a 3DS Authentication.
static Authentication	create(AuthenticationCreateParams params, RequestOptions options)	This endpoint creates a 3DS Authentication.
static Authentication	create(Map<String,Object> params)	This endpoint creates a 3DS Authentication.
static Authentication	create(Map<String,Object> params, RequestOptions options)	This endpoint creates a 3DS Authentication.
boolean	equals(Object o)
Authentication.AcquirerDetails	getAcquirerDetails()	Contains additional details about the acquirer for a 3DS Authentication.
Long	getAmount()	The amount for this 3DS Authentication.
String	getChallengeUrl()	The URL for presenting a challenge to your cardholder, present if status is requires_challenge.
Authentication.Channel	getChannel()	Contains details on the channel used (browser, 3RI) for a standalone 3DS Authentication.
Long	getCreated()	Time at which the object was created.
String	getCurrency()	Three-letter ISO currency code, in lowercase.
String	getDirectoryServer()	The 3DS directory server with which this 3DS Authentication was processed.
String	getFingerprintingUrl()	The URL for performing issuer fingerprinting, present if fingerprinting is supported for the given payment method.
Authentication.FlowPreference	getFlowPreference()	Contains details of the flow preference used for a standalone 3DS Authentication.
Authentication.FutureUsage	getFutureUsage()	Contains information about the future authorisations related to this authentication.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	If the object exists in live mode, the value is true.
String	getMessageCategory()	Indicates whether this 3DS Authentication is being performed for a payment or non-payment use case.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getObject()	String representing the object's type.
String	getOutcome()	The outcome of this 3DS Authentication.
Authentication.OutcomeDetails	getOutcomeDetails()	Contains details on the result for a standalone 3DS Authentication.
String	getPaymentMethod()	Get ID of expandable paymentMethod object.
PaymentMethod	getPaymentMethodObject()	Get expanded paymentMethod.
String	getReason()	The reason for invoking this 3DS Authentication.
Authentication.ShippingAddress	getShippingAddress()	Contains details about the shipping address for a 3DS Authentication.
String	getStatus()	Status of this Authentication.
int	hashCode()
static AuthenticationCollection	list(AuthenticationListParams params)	Returns a list of 3D Secure Authentications.
static AuthenticationCollection	list(AuthenticationListParams params, RequestOptions options)	Returns a list of 3D Secure Authentications.
static AuthenticationCollection	list(Map<String,Object> params)	Returns a list of 3D Secure Authentications.
static AuthenticationCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of 3D Secure Authentications.
static Authentication	retrieve(String authentication)	This endpoint retrieves a 3DS Authentication.
static Authentication	retrieve(String authentication, RequestOptions options)	This endpoint retrieves a 3DS Authentication.
static Authentication	retrieve(String authentication, AuthenticationRetrieveParams params, RequestOptions options)	This endpoint retrieves a 3DS Authentication.
static Authentication	retrieve(String authentication, Map<String,Object> params, RequestOptions options)	This endpoint retrieves a 3DS Authentication.
void	setAcquirerDetails(Authentication.AcquirerDetails acquirerDetails)	Contains additional details about the acquirer for a 3DS Authentication.
void	setAmount(Long amount)	The amount for this 3DS Authentication.
void	setChallengeUrl(String challengeUrl)	The URL for presenting a challenge to your cardholder, present if status is requires_challenge.
void	setChannel(Authentication.Channel channel)	Contains details on the channel used (browser, 3RI) for a standalone 3DS Authentication.
void	setCreated(Long created)	Time at which the object was created.
void	setCurrency(String currency)	Three-letter ISO currency code, in lowercase.
void	setDirectoryServer(String directoryServer)	The 3DS directory server with which this 3DS Authentication was processed.
void	setFingerprintingUrl(String fingerprintingUrl)	The URL for performing issuer fingerprinting, present if fingerprinting is supported for the given payment method.
void	setFlowPreference(Authentication.FlowPreference flowPreference)	Contains details of the flow preference used for a standalone 3DS Authentication.
void	setFutureUsage(Authentication.FutureUsage futureUsage)	Contains information about the future authorisations related to this authentication.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	If the object exists in live mode, the value is true.
void	setMessageCategory(String messageCategory)	Indicates whether this 3DS Authentication is being performed for a payment or non-payment use case.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setObject(String object)	String representing the object's type.
void	setOutcome(String outcome)	The outcome of this 3DS Authentication.
void	setOutcomeDetails(Authentication.OutcomeDetails outcomeDetails)	Contains details on the result for a standalone 3DS Authentication.
void	setPaymentMethod(String id)
void	setPaymentMethodObject(PaymentMethod expandableObject)
void	setReason(String reason)	The reason for invoking this 3DS Authentication.
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	setShippingAddress(Authentication.ShippingAddress shippingAddress)	Contains details about the shipping address for a 3DS Authentication.
void	setStatus(String status)	Status of this Authentication.
Authentication	submit()	This endpoint submits a 3DS Authentication.
Authentication	submit(RequestOptions options)	This endpoint submits a 3DS Authentication.
Authentication	submit(AuthenticationSubmitParams params)	This endpoint submits a 3DS Authentication.
Authentication	submit(AuthenticationSubmitParams params, RequestOptions options)	This endpoint submits a 3DS Authentication.
Authentication	submit(Map<String,Object> params)	This endpoint submits a 3DS Authentication.
Authentication	submit(Map<String,Object> params, RequestOptions options)	This endpoint submits a 3DS Authentication.

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

Authentication

public Authentication()

Method Details

getPaymentMethod

public String getPaymentMethod()

Get ID of expandable paymentMethod object.

setPaymentMethod

public void setPaymentMethod(String id)

getPaymentMethodObject

public PaymentMethod getPaymentMethodObject()

Get expanded paymentMethod.

setPaymentMethodObject

public void setPaymentMethodObject(PaymentMethod expandableObject)

cancel

public Authentication cancel()
                      throws StripeException

This endpoint cancels a 3DS Authentication. You can cancel a 3DS Authentication object when it’s in a non-final status: requires_submission or requires_challenge.

Throws:

StripeException

cancel

public Authentication cancel(RequestOptions options)
                      throws StripeException

This endpoint cancels a 3DS Authentication. You can cancel a 3DS Authentication object when it’s in a non-final status: requires_submission or requires_challenge.

Throws:

StripeException

cancel

public Authentication cancel(Map<String,Object> params)
                      throws StripeException

This endpoint cancels a 3DS Authentication. You can cancel a 3DS Authentication object when it’s in a non-final status: requires_submission or requires_challenge.

Throws:

StripeException

cancel

public Authentication cancel(Map<String,Object> params,
 RequestOptions options)
                      throws StripeException

This endpoint cancels a 3DS Authentication. You can cancel a 3DS Authentication object when it’s in a non-final status: requires_submission or requires_challenge.

Throws:

StripeException

cancel

public Authentication cancel(AuthenticationCancelParams params)
                      throws StripeException

This endpoint cancels a 3DS Authentication. You can cancel a 3DS Authentication object when it’s in a non-final status: requires_submission or requires_challenge.

Throws:

StripeException

cancel

public Authentication cancel(AuthenticationCancelParams params,
 RequestOptions options)
                      throws StripeException

This endpoint cancels a 3DS Authentication. You can cancel a 3DS Authentication object when it’s in a non-final status: requires_submission or requires_challenge.

Throws:

StripeException

create

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

This endpoint creates a 3DS Authentication. Refer to the Create a 3DS Authentication object section of the Standalone 3DS guide for more information.

You can pass the submit parameter to automatically submit the 3DS Authentication object when you create it. Refer to the Submit at creation section of the Standalone 3DS guide for more information.

Throws:

StripeException

create

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

This endpoint creates a 3DS Authentication. Refer to the Create a 3DS Authentication object section of the Standalone 3DS guide for more information.

You can pass the submit parameter to automatically submit the 3DS Authentication object when you create it. Refer to the Submit at creation section of the Standalone 3DS guide for more information.

Throws:

StripeException

create

public static Authentication create(AuthenticationCreateParams params)
                             throws StripeException

This endpoint creates a 3DS Authentication. Refer to the Create a 3DS Authentication object section of the Standalone 3DS guide for more information.

You can pass the submit parameter to automatically submit the 3DS Authentication object when you create it. Refer to the Submit at creation section of the Standalone 3DS guide for more information.

Throws:

StripeException

create

public static Authentication create(AuthenticationCreateParams params,
 RequestOptions options)
                             throws StripeException

This endpoint creates a 3DS Authentication. Refer to the Create a 3DS Authentication object section of the Standalone 3DS guide for more information.

You can pass the submit parameter to automatically submit the 3DS Authentication object when you create it. Refer to the Submit at creation section of the Standalone 3DS guide for more information.

Throws:

StripeException

list

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

Returns a list of 3D Secure Authentications.

Throws:

StripeException

list

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

Returns a list of 3D Secure Authentications.

Throws:

StripeException

list

public static AuthenticationCollection list(AuthenticationListParams params)
                                     throws StripeException

Returns a list of 3D Secure Authentications.

Throws:

StripeException

list

public static AuthenticationCollection list(AuthenticationListParams params,
 RequestOptions options)
                                     throws StripeException

Returns a list of 3D Secure Authentications.

Throws:

StripeException

retrieve

public static Authentication retrieve(String authentication)
                               throws StripeException

This endpoint retrieves a 3DS Authentication.

Throws:

StripeException

retrieve

public static Authentication retrieve(String authentication,
 RequestOptions options)
                               throws StripeException

This endpoint retrieves a 3DS Authentication.

Throws:

StripeException

retrieve

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

This endpoint retrieves a 3DS Authentication.

Throws:

StripeException

retrieve

public static Authentication retrieve(String authentication,
 AuthenticationRetrieveParams params,
 RequestOptions options)
                               throws StripeException

This endpoint retrieves a 3DS Authentication.

Throws:

StripeException

submit

public Authentication submit()
                      throws StripeException

This endpoint submits a 3DS Authentication. You can submit a 3DS Authentication object when it has status requires_submission. Refer to the Submit the 3DS Authentication object section of the Standalone 3DS guide for more information.

Throws:

StripeException

submit

public Authentication submit(RequestOptions options)
                      throws StripeException

This endpoint submits a 3DS Authentication. You can submit a 3DS Authentication object when it has status requires_submission. Refer to the Submit the 3DS Authentication object section of the Standalone 3DS guide for more information.

Throws:

StripeException

submit

public Authentication submit(Map<String,Object> params)
                      throws StripeException

This endpoint submits a 3DS Authentication. You can submit a 3DS Authentication object when it has status requires_submission. Refer to the Submit the 3DS Authentication object section of the Standalone 3DS guide for more information.

Throws:

StripeException

submit

public Authentication submit(Map<String,Object> params,
 RequestOptions options)
                      throws StripeException

This endpoint submits a 3DS Authentication. You can submit a 3DS Authentication object when it has status requires_submission. Refer to the Submit the 3DS Authentication object section of the Standalone 3DS guide for more information.

Throws:

StripeException

submit

public Authentication submit(AuthenticationSubmitParams params)
                      throws StripeException

This endpoint submits a 3DS Authentication. You can submit a 3DS Authentication object when it has status requires_submission. Refer to the Submit the 3DS Authentication object section of the Standalone 3DS guide for more information.

Throws:

StripeException

submit

public Authentication submit(AuthenticationSubmitParams params,
 RequestOptions options)
                      throws StripeException

This endpoint submits a 3DS Authentication. You can submit a 3DS Authentication object when it has status requires_submission. Refer to the Submit the 3DS Authentication object section of the Standalone 3DS guide for more information.

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.

getAcquirerDetails

public Authentication.AcquirerDetails getAcquirerDetails()

Contains additional details about the acquirer for a 3DS Authentication.

getAmount

public Long getAmount()

The amount for this 3DS Authentication.

getChallengeUrl

public String getChallengeUrl()

The URL for presenting a challenge to your cardholder, present if status is requires_challenge.

getChannel

public Authentication.Channel getChannel()

Contains details on the channel used (browser, 3RI) for a standalone 3DS Authentication.

getCreated

public Long getCreated()

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

getCurrency

public String getCurrency()

Three-letter ISO currency code, in lowercase. Must be a supported currency.

getDirectoryServer

public String getDirectoryServer()

The 3DS directory server with which this 3DS Authentication was processed.

One of american_express, cartes_bancaires, discover, mastercard, or visa.

getFingerprintingUrl

public String getFingerprintingUrl()

The URL for performing issuer fingerprinting, present if fingerprinting is supported for the given payment method.

getFlowPreference

public Authentication.FlowPreference getFlowPreference()

Contains details of the flow preference used for a standalone 3DS Authentication.

getFutureUsage

public Authentication.FutureUsage getFutureUsage()

Contains information about the future authorisations related to this authentication.

getLivemode

public Boolean getLivemode()

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

getMessageCategory

public String getMessageCategory()

Indicates whether this 3DS Authentication is being performed for a payment or non-payment use case.

One of non_payment_authentication, or payment_authentication.

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.

getObject

public String getObject()

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

Equal to three_d_secure.authentication.

getOutcome

public String getOutcome()

The outcome of this 3DS Authentication.

One of abandoned, attempt_acknowledged, authenticated, canceled, denied, informational, internal_error, not_supported, not_triggered, processing_error, or rejected.

getOutcomeDetails

public Authentication.OutcomeDetails getOutcomeDetails()

Contains details on the result for a standalone 3DS Authentication.

getReason

public String getReason()

The reason for invoking this 3DS Authentication.

One of cardholder_authentication, issuer_requested, liability_shift, processing_costs, or regulatory_compliance.

getShippingAddress

public Authentication.ShippingAddress getShippingAddress()

Contains details about the shipping address for a 3DS Authentication.

getStatus

public String getStatus()

Status of this Authentication.

One of canceled, error, failed, requires_challenge, requires_submission, or succeeded.

setAcquirerDetails

public void setAcquirerDetails(Authentication.AcquirerDetails acquirerDetails)

Contains additional details about the acquirer for a 3DS Authentication.

setAmount

public void setAmount(Long amount)

The amount for this 3DS Authentication.

setChallengeUrl

public void setChallengeUrl(String challengeUrl)

The URL for presenting a challenge to your cardholder, present if status is requires_challenge.

setChannel

public void setChannel(Authentication.Channel channel)

Contains details on the channel used (browser, 3RI) for a standalone 3DS Authentication.

setCreated

public void setCreated(Long created)

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

setCurrency

public void setCurrency(String currency)

Three-letter ISO currency code, in lowercase. Must be a supported currency.

setDirectoryServer

public void setDirectoryServer(String directoryServer)

The 3DS directory server with which this 3DS Authentication was processed.

One of american_express, cartes_bancaires, discover, mastercard, or visa.

setFingerprintingUrl

public void setFingerprintingUrl(String fingerprintingUrl)

The URL for performing issuer fingerprinting, present if fingerprinting is supported for the given payment method.

setFlowPreference

public void setFlowPreference(Authentication.FlowPreference flowPreference)

Contains details of the flow preference used for a standalone 3DS Authentication.

setFutureUsage

public void setFutureUsage(Authentication.FutureUsage futureUsage)

Contains information about the future authorisations related to this authentication.

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

setMessageCategory

public void setMessageCategory(String messageCategory)

Indicates whether this 3DS Authentication is being performed for a payment or non-payment use case.

One of non_payment_authentication, or payment_authentication.

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.

setObject

public void setObject(String object)

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

Equal to three_d_secure.authentication.

setOutcome

public void setOutcome(String outcome)

The outcome of this 3DS Authentication.

One of abandoned, attempt_acknowledged, authenticated, canceled, denied, informational, internal_error, not_supported, not_triggered, processing_error, or rejected.

setOutcomeDetails

public void setOutcomeDetails(Authentication.OutcomeDetails outcomeDetails)

Contains details on the result for a standalone 3DS Authentication.

setReason

public void setReason(String reason)

The reason for invoking this 3DS Authentication.

One of cardholder_authentication, issuer_requested, liability_shift, processing_costs, or regulatory_compliance.

setShippingAddress

public void setShippingAddress(Authentication.ShippingAddress shippingAddress)

Contains details about the shipping address for a 3DS Authentication.

setStatus

public void setStatus(String status)

Status of this Authentication.

One of canceled, error, failed, requires_challenge, requires_submission, or succeeded.

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