ThreeDSecure (stripe-java 19.45.0 API)

java.lang.Object
- com.stripe.model.StripeObject
- - com.stripe.net.ApiResource
  - - com.stripe.model.ThreeDSecure

All Implemented Interfaces:: HasId, StripeObjectInterface

public class ThreeDSecure
extends ApiResource
implements HasId

Nested Class Summary
- Nested classes/interfaces inherited from class com.stripe.net.ApiResource
  ApiResource.RequestMethod

Field Summary
- Fields inherited from class com.stripe.net.ApiResource
  CHARSET, GSON
- Fields inherited from class com.stripe.model.StripeObject
  PRETTY_PRINT_GSON

Constructor Summary

Constructors
Constructor and Description

ThreeDSecure()

Constructors
Constructor and Description
`ThreeDSecure()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`static ThreeDSecure`	`create(java.util.Map<java.lang.String,java.lang.Object> params)` Initiate 3D Secure authentication.
`static ThreeDSecure`	`create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Initiate 3D Secure authentication.
`static ThreeDSecure`	`create(ThreeDSecureCreateParams params)` Initiate 3D Secure authentication.
`static ThreeDSecure`	`create(ThreeDSecureCreateParams params, RequestOptions options)` Initiate 3D Secure authentication.
`boolean`	`equals(java.lang.Object o)`
`java.lang.Long`	`getAmount()` Amount of the charge that you will create when authentication completes.
`java.lang.Boolean`	`getAuthenticated()` True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded.
`Card`	`getCard()` You can store multiple cards on a customer in order to charge the customer later.
`java.lang.Long`	`getCreated()` Time at which the object was created.
`java.lang.String`	`getCurrency()` Three-letter ISO currency code, in lowercase.
`java.lang.String`	`getId()` Unique identifier for the object.
`java.lang.Boolean`	`getLivemode()` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`java.lang.String`	`getObject()` String representing the object's type.
`java.lang.String`	`getRedirectUrl()` If present, this is the URL that you should send the cardholder to for authentication.
`java.lang.String`	`getStatus()` Possible values are `redirect_pending`, `succeeded`, or `failed`.
`int`	`hashCode()`
`static ThreeDSecure`	`retrieve(java.lang.String threeDSecure)` Retrieves a 3D Secure object.
`static ThreeDSecure`	`retrieve(java.lang.String threeDSecure, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Retrieves a 3D Secure object.
`static ThreeDSecure`	`retrieve(java.lang.String threeDSecure, RequestOptions options)` Retrieves a 3D Secure object.
`static ThreeDSecure`	`retrieve(java.lang.String threeDSecure, ThreeDSecureRetrieveParams params, RequestOptions options)` Retrieves a 3D Secure object.
`void`	`setAmount(java.lang.Long amount)` Amount of the charge that you will create when authentication completes.
`void`	`setAuthenticated(java.lang.Boolean authenticated)` True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded.
`void`	`setCard(Card card)` You can store multiple cards on a customer in order to charge the customer later.
`void`	`setCreated(java.lang.Long created)` Time at which the object was created.
`void`	`setCurrency(java.lang.String currency)` Three-letter ISO currency code, in lowercase.
`void`	`setId(java.lang.String id)` Unique identifier for the object.
`void`	`setLivemode(java.lang.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(java.lang.String object)` String representing the object's type.
`void`	`setRedirectUrl(java.lang.String redirectUrl)` If present, this is the URL that you should send the cardholder to for authentication.
`void`	`setStatus(java.lang.String status)` Possible values are `redirect_pending`, `succeeded`, or `failed`.

Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ThreeDSecure
```
public ThreeDSecure()
```
- Method Detail
  - retrieve
```
public static ThreeDSecure retrieve(java.lang.String threeDSecure)
                             throws StripeException
```
    Retrieves a 3D Secure object.
    
    Throws:
    
    StripeException
  - retrieve
```
public static ThreeDSecure retrieve(java.lang.String threeDSecure,
                                    RequestOptions options)
                             throws StripeException
```
    Retrieves a 3D Secure object.
    
    Throws:
    
    StripeException
  - retrieve
```
public static ThreeDSecure retrieve(java.lang.String threeDSecure,
                                    java.util.Map<java.lang.String,java.lang.Object> params,
                                    RequestOptions options)
                             throws StripeException
```
    Retrieves a 3D Secure object.
    
    Throws:
    
    StripeException
  - retrieve
```
public static ThreeDSecure retrieve(java.lang.String threeDSecure,
                                    ThreeDSecureRetrieveParams params,
                                    RequestOptions options)
                             throws StripeException
```
    Retrieves a 3D Secure object.
    
    Throws:
    
    StripeException
  - create
```
public static ThreeDSecure create(java.util.Map<java.lang.String,java.lang.Object> params)
                           throws StripeException
```
    Initiate 3D Secure authentication.
    
    Throws:
    
    StripeException
  - create
```
public static ThreeDSecure create(java.util.Map<java.lang.String,java.lang.Object> params,
                                  RequestOptions options)
                           throws StripeException
```
    Initiate 3D Secure authentication.
    
    Throws:
    
    StripeException
  - create
```
public static ThreeDSecure create(ThreeDSecureCreateParams params)
                           throws StripeException
```
    Initiate 3D Secure authentication.
    
    Throws:
    
    StripeException
  - create
```
public static ThreeDSecure create(ThreeDSecureCreateParams params,
                                  RequestOptions options)
                           throws StripeException
```
    Initiate 3D Secure authentication.
    
    Throws:
    
    StripeException
  - getAmount
```
public java.lang.Long getAmount()
```
    Amount of the charge that you will create when authentication completes.
  - getAuthenticated
```
public java.lang.Boolean getAuthenticated()
```
    True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded.
  - getCard
```
public Card getCard()
```
    You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.
    Related guide: Card Payments with Sources.
  - getCreated
```
public java.lang.Long getCreated()
```
    Time at which the object was created. Measured in seconds since the Unix epoch.
  - getCurrency
```
public java.lang.String getCurrency()
```
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
  - getLivemode
```
public java.lang.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 java.lang.String getObject()
```
    String representing the object's type. Objects of the same type share the same value.
    Equal to three_d_secure.
  - getRedirectUrl
```
public java.lang.String getRedirectUrl()
```
    If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback".
  - getStatus
```
public java.lang.String getStatus()
```
    Possible values are redirect_pending, succeeded, or failed. When the cardholder can be authenticated, the object starts with status redirect_pending. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status succeeded. failed indicates that authentication was attempted unsuccessfully.
  - setAmount
```
public void setAmount(java.lang.Long amount)
```
    Amount of the charge that you will create when authentication completes.
  - setAuthenticated
```
public void setAuthenticated(java.lang.Boolean authenticated)
```
    True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded.
  - setCard
```
public void setCard(Card card)
```
    You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.
    Related guide: Card Payments with Sources.
  - setCreated
```
public void setCreated(java.lang.Long created)
```
    Time at which the object was created. Measured in seconds since the Unix epoch.
  - setCurrency
```
public void setCurrency(java.lang.String currency)
```
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier for the object.
  - setLivemode
```
public void setLivemode(java.lang.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(java.lang.String object)
```
    String representing the object's type. Objects of the same type share the same value.
    Equal to three_d_secure.
  - setRedirectUrl
```
public void setRedirectUrl(java.lang.String redirectUrl)
```
    If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback".
  - setStatus
```
public void setStatus(java.lang.String status)
```
    Possible values are redirect_pending, succeeded, or failed. When the cardholder can be authenticated, the object starts with status redirect_pending. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status succeeded. failed indicates that authentication was attempted unsuccessfully.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getId
```
public java.lang.String getId()
```
    Unique identifier for the object.
    
    Specified by:
    
    getId in interface HasId

Class ThreeDSecure

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

Field Summary

Fields inherited from class com.stripe.net.ApiResource

Fields inherited from class com.stripe.model.StripeObject

Constructor Summary

Method Summary

Methods inherited from class com.stripe.net.ApiResource

Methods inherited from class com.stripe.model.StripeObject

Methods inherited from class java.lang.Object

Constructor Detail

ThreeDSecure

Method Detail

retrieve

retrieve

retrieve

retrieve

create

create

create

create

getAmount

getAuthenticated

getCard

getCreated

getCurrency

getLivemode

getObject

getRedirectUrl

getStatus

setAmount

setAuthenticated

setCard

setCreated

setCurrency

setId

setLivemode

setObject

setRedirectUrl

setStatus

equals

canEqual

hashCode

getId