java.lang.Object
- com.adyen.model.tapi.PaymentToken

```
public class PaymentToken
extends Object
```
Surrogate of the PAN (Primary Account Number) of the payment card to identify the payment mean of the customer. It allows, for a merchant, to identify the customer.

Field Summary

Fields
Modifier and Type Field Description

static String JSON_PROPERTY_EXPIRY_DATE_TIME

static String JSON_PROPERTY_TOKEN_REQUESTED_TYPE

static String JSON_PROPERTY_TOKEN_VALUE

Constructor Summary

Constructors
Constructor Description

PaymentToken()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`	Return true if this PaymentToken object is equal to o.
`PaymentToken`	`expiryDateTime(OffsetDateTime expiryDateTime)`	Expiry date and time.
`static PaymentToken`	`fromJson(String jsonString)`	Create an instance of PaymentToken given an JSON string
`OffsetDateTime`	`getExpiryDateTime()`	Expiry date and time.
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`TokenRequestedType`	`getTokenRequestedType()`	Get tokenRequestedType
`String`	`getTokenValue()`	Payment token replacing the PAN of the payment card to identify the payment mean of the customer.
`int`	`hashCode()`
`PaymentToken`	`includeNullValues(boolean includeNullValues)`	Configures whether null values are explicitly serialized in the JSON payload.
`boolean`	`isIncludeNullValues()`	Returns whether null values are explicitly serialized in the JSON payload.
`void`	`setExpiryDateTime(OffsetDateTime expiryDateTime)`	Expiry date and time.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setTokenRequestedType(TokenRequestedType tokenRequestedType)`	tokenRequestedType
`void`	`setTokenValue(String tokenValue)`	Payment token replacing the PAN of the payment card to identify the payment mean of the customer.
`String`	`toJson()`	Convert an instance of PaymentToken to an JSON string
`PaymentToken`	`tokenRequestedType(TokenRequestedType tokenRequestedType)`	tokenRequestedType
`PaymentToken`	`tokenValue(String tokenValue)`	Payment token replacing the PAN of the payment card to identify the payment mean of the customer.
`String`	`toString()`

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

- Field Detail
  - JSON_PROPERTY_TOKEN_REQUESTED_TYPE
```
public static final String JSON_PROPERTY_TOKEN_REQUESTED_TYPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TOKEN_VALUE
```
public static final String JSON_PROPERTY_TOKEN_VALUE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_EXPIRY_DATE_TIME
```
public static final String JSON_PROPERTY_EXPIRY_DATE_TIME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PaymentToken
```
public PaymentToken()
```
- Method Detail
  - tokenRequestedType
```
public PaymentToken tokenRequestedType(TokenRequestedType tokenRequestedType)
```
    tokenRequestedType
    
    Parameters:
    
    tokenRequestedType -
    
    Returns:
    
    the current PaymentToken instance, allowing for method chaining
  - getTokenRequestedType
```
public TokenRequestedType getTokenRequestedType()
```
    Get tokenRequestedType
    
    Returns:
    
    tokenRequestedType
  - setTokenRequestedType
```
public void setTokenRequestedType(TokenRequestedType tokenRequestedType)
```
    tokenRequestedType
    
    Parameters:
    
    tokenRequestedType -
  - tokenValue
```
public PaymentToken tokenValue(String tokenValue)
```
    Payment token replacing the PAN of the payment card to identify the payment mean of the customer.
    
    Parameters:
    
    tokenValue - Payment token replacing the PAN of the payment card to identify the payment mean of the customer.
    
    Returns:
    
    the current PaymentToken instance, allowing for method chaining
  - getTokenValue
```
public String getTokenValue()
```
    Payment token replacing the PAN of the payment card to identify the payment mean of the customer.
    
    Returns:
    
    tokenValue Payment token replacing the PAN of the payment card to identify the payment mean of the customer.
  - setTokenValue
```
public void setTokenValue(String tokenValue)
```
    Payment token replacing the PAN of the payment card to identify the payment mean of the customer.
    
    Parameters:
    
    tokenValue - Payment token replacing the PAN of the payment card to identify the payment mean of the customer.
  - expiryDateTime
```
public PaymentToken expiryDateTime(OffsetDateTime expiryDateTime)
```
    Expiry date and time. Limits the validity of a payment token.
    
    Parameters:
    
    expiryDateTime - Expiry date and time. Limits the validity of a payment token.
    
    Returns:
    
    the current PaymentToken instance, allowing for method chaining
  - getExpiryDateTime
```
public OffsetDateTime getExpiryDateTime()
```
    Expiry date and time. Limits the validity of a payment token.
    
    Returns:
    
    expiryDateTime Expiry date and time. Limits the validity of a payment token.
  - setExpiryDateTime
```
public void setExpiryDateTime(OffsetDateTime expiryDateTime)
```
    Expiry date and time. Limits the validity of a payment token.
    
    Parameters:
    
    expiryDateTime - Expiry date and time. Limits the validity of a payment token.
  - includeNullValues
```
public PaymentToken includeNullValues(boolean includeNullValues)
```
    Configures whether null values are explicitly serialized in the JSON payload. Default is false.
  - isIncludeNullValues
```
public boolean isIncludeNullValues()
```
    Returns whether null values are explicitly serialized in the JSON payload.
  - setIncludeNullValues
```
public void setIncludeNullValues(boolean includeNullValues)
```
    Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
  - equals
```
public boolean equals(Object o)
```
    Return true if this PaymentToken object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getExplicitNulls
```
public Map<String,Object> getExplicitNulls()
```
    Returns a map of properties to be merged into the JSON payload as explicit null values.
  - fromJson
```
public static PaymentToken fromJson(String jsonString)
                             throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of PaymentToken given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PaymentToken
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PaymentToken
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of PaymentToken to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_EXPIRY_DATE_TIME`
`static String`	`JSON_PROPERTY_TOKEN_REQUESTED_TYPE`
`static String`	`JSON_PROPERTY_TOKEN_VALUE`

Class PaymentToken

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_TOKEN_REQUESTED_TYPE

JSON_PROPERTY_TOKEN_VALUE

JSON_PROPERTY_EXPIRY_DATE_TIME

Constructor Detail

PaymentToken

Method Detail

tokenRequestedType

getTokenRequestedType

setTokenRequestedType

tokenValue

getTokenValue

setTokenValue

expiryDateTime

getExpiryDateTime

setExpiryDateTime

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson