java.lang.Object
- com.adyen.model.checkout.ExternalTokenDetails

public class ExternalTokenDetails
extends Object

ExternalTokenDetails

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ExternalTokenDetails.SubtypeEnum`	The external service from which to fetch the token.
`static class`	`ExternalTokenDetails.TypeEnum`	The type of token.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_CHECKOUT_ATTEMPT_ID`
`static String`	`JSON_PROPERTY_EXPIRY_MONTH`
`static String`	`JSON_PROPERTY_EXPIRY_YEAR`
`static String`	`JSON_PROPERTY_HOLDER_NAME`
`static String`	`JSON_PROPERTY_NUMBER`
`static String`	`JSON_PROPERTY_STORED_PAYMENT_METHOD_ID`
`static String`	`JSON_PROPERTY_SUBTYPE`
`static String`	`JSON_PROPERTY_TYPE`

Constructor Summary

Constructors
Constructor Description

ExternalTokenDetails()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ExternalTokenDetails`	`checkoutAttemptId(String checkoutAttemptId)`	The checkout attempt identifier.
`boolean`	`equals(Object o)`	Return true if this ExternalTokenDetails object is equal to o.
`ExternalTokenDetails`	`expiryMonth(String expiryMonth)`	The card expiry month.
`ExternalTokenDetails`	`expiryYear(String expiryYear)`	The card expiry year.
`static ExternalTokenDetails`	`fromJson(String jsonString)`	Create an instance of ExternalTokenDetails given an JSON string
`String`	`getCheckoutAttemptId()`	The checkout attempt identifier.
`String`	`getExpiryMonth()`	The card expiry month.
`String`	`getExpiryYear()`	The card expiry year.
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`String`	`getHolderName()`	The name of the card holder.
`String`	`getNumber()`	The card number.
`String`	`getStoredPaymentMethodId()`	Identifier used to fetch the token from the external service
`ExternalTokenDetails.SubtypeEnum`	`getSubtype()`	The external service from which to fetch the token.
`ExternalTokenDetails.TypeEnum`	`getType()`	The type of token.
`int`	`hashCode()`
`ExternalTokenDetails`	`holderName(String holderName)`	The name of the card holder.
`ExternalTokenDetails`	`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.
`ExternalTokenDetails`	`number(String number)`	The card number.
`void`	`setCheckoutAttemptId(String checkoutAttemptId)`	The checkout attempt identifier.
`void`	`setExpiryMonth(String expiryMonth)`	The card expiry month.
`void`	`setExpiryYear(String expiryYear)`	The card expiry year.
`void`	`setHolderName(String holderName)`	The name of the card holder.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setNumber(String number)`	The card number.
`void`	`setStoredPaymentMethodId(String storedPaymentMethodId)`	Identifier used to fetch the token from the external service
`void`	`setSubtype(ExternalTokenDetails.SubtypeEnum subtype)`	The external service from which to fetch the token.
`void`	`setType(ExternalTokenDetails.TypeEnum type)`	The type of token.
`ExternalTokenDetails`	`storedPaymentMethodId(String storedPaymentMethodId)`	Identifier used to fetch the token from the external service
`ExternalTokenDetails`	`subtype(ExternalTokenDetails.SubtypeEnum subtype)`	The external service from which to fetch the token.
`String`	`toJson()`	Convert an instance of ExternalTokenDetails to an JSON string
`String`	`toString()`
`ExternalTokenDetails`	`type(ExternalTokenDetails.TypeEnum type)`	The type of token.

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

- Field Detail
  - JSON_PROPERTY_CHECKOUT_ATTEMPT_ID
```
public static final String JSON_PROPERTY_CHECKOUT_ATTEMPT_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_EXPIRY_MONTH
```
public static final String JSON_PROPERTY_EXPIRY_MONTH
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_EXPIRY_YEAR
```
public static final String JSON_PROPERTY_EXPIRY_YEAR
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HOLDER_NAME
```
public static final String JSON_PROPERTY_HOLDER_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NUMBER
```
public static final String JSON_PROPERTY_NUMBER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STORED_PAYMENT_METHOD_ID
```
public static final String JSON_PROPERTY_STORED_PAYMENT_METHOD_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SUBTYPE
```
public static final String JSON_PROPERTY_SUBTYPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TYPE
```
public static final String JSON_PROPERTY_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExternalTokenDetails
```
public ExternalTokenDetails()
```
- Method Detail
  - checkoutAttemptId
```
public ExternalTokenDetails checkoutAttemptId(String checkoutAttemptId)
```
    The checkout attempt identifier.
    
    Parameters:
    
    checkoutAttemptId - The checkout attempt identifier.
    
    Returns:
    
    the current ExternalTokenDetails instance, allowing for method chaining
  - getCheckoutAttemptId
```
public String getCheckoutAttemptId()
```
    The checkout attempt identifier.
    
    Returns:
    
    checkoutAttemptId The checkout attempt identifier.
  - setCheckoutAttemptId
```
public void setCheckoutAttemptId(String checkoutAttemptId)
```
    The checkout attempt identifier.
    
    Parameters:
    
    checkoutAttemptId - The checkout attempt identifier.
  - expiryMonth
```
public ExternalTokenDetails expiryMonth(String expiryMonth)
```
    The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
    
    Parameters:
    
    expiryMonth - The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
    
    Returns:
    
    the current ExternalTokenDetails instance, allowing for method chaining
  - getExpiryMonth
```
public String getExpiryMonth()
```
    The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
    
    Returns:
    
    expiryMonth The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
  - setExpiryMonth
```
public void setExpiryMonth(String expiryMonth)
```
    The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
    
    Parameters:
    
    expiryMonth - The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
  - expiryYear
```
public ExternalTokenDetails expiryYear(String expiryYear)
```
    The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
    
    Parameters:
    
    expiryYear - The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
    
    Returns:
    
    the current ExternalTokenDetails instance, allowing for method chaining
  - getExpiryYear
```
public String getExpiryYear()
```
    The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
    
    Returns:
    
    expiryYear The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
  - setExpiryYear
```
public void setExpiryYear(String expiryYear)
```
    The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
    
    Parameters:
    
    expiryYear - The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
  - holderName
```
public ExternalTokenDetails holderName(String holderName)
```
    The name of the card holder.
    
    Parameters:
    
    holderName - The name of the card holder.
    
    Returns:
    
    the current ExternalTokenDetails instance, allowing for method chaining
  - getHolderName
```
public String getHolderName()
```
    The name of the card holder.
    
    Returns:
    
    holderName The name of the card holder.
  - setHolderName
```
public void setHolderName(String holderName)
```
    The name of the card holder.
    
    Parameters:
    
    holderName - The name of the card holder.
  - number
```
public ExternalTokenDetails number(String number)
```
    The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
    
    Parameters:
    
    number - The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
    
    Returns:
    
    the current ExternalTokenDetails instance, allowing for method chaining
  - getNumber
```
public String getNumber()
```
    The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
    
    Returns:
    
    number The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
  - setNumber
```
public void setNumber(String number)
```
    The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
    
    Parameters:
    
    number - The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
  - storedPaymentMethodId
```
public ExternalTokenDetails storedPaymentMethodId(String storedPaymentMethodId)
```
    Identifier used to fetch the token from the external service
    
    Parameters:
    
    storedPaymentMethodId - Identifier used to fetch the token from the external service
    
    Returns:
    
    the current ExternalTokenDetails instance, allowing for method chaining
  - getStoredPaymentMethodId
```
public String getStoredPaymentMethodId()
```
    Identifier used to fetch the token from the external service
    
    Returns:
    
    storedPaymentMethodId Identifier used to fetch the token from the external service
  - setStoredPaymentMethodId
```
public void setStoredPaymentMethodId(String storedPaymentMethodId)
```
    Identifier used to fetch the token from the external service
    
    Parameters:
    
    storedPaymentMethodId - Identifier used to fetch the token from the external service
  - subtype
```
public ExternalTokenDetails subtype(ExternalTokenDetails.SubtypeEnum subtype)
```
    The external service from which to fetch the token. Supported only for specific companies. Contact Adyen if you want to use this feature.
    
    Parameters:
    
    subtype - The external service from which to fetch the token. Supported only for specific companies. Contact Adyen if you want to use this feature.
    
    Returns:
    
    the current ExternalTokenDetails instance, allowing for method chaining
  - getSubtype
```
public ExternalTokenDetails.SubtypeEnum getSubtype()
```
    The external service from which to fetch the token. Supported only for specific companies. Contact Adyen if you want to use this feature.
    
    Returns:
    
    subtype The external service from which to fetch the token. Supported only for specific companies. Contact Adyen if you want to use this feature.
  - setSubtype
```
public void setSubtype(ExternalTokenDetails.SubtypeEnum subtype)
```
    The external service from which to fetch the token. Supported only for specific companies. Contact Adyen if you want to use this feature.
    
    Parameters:
    
    subtype - The external service from which to fetch the token. Supported only for specific companies. Contact Adyen if you want to use this feature.
  - type
```
public ExternalTokenDetails type(ExternalTokenDetails.TypeEnum type)
```
    The type of token. Allowed value: **externalToken**.
    
    Parameters:
    
    type - The type of token. Allowed value: **externalToken**.
    
    Returns:
    
    the current ExternalTokenDetails instance, allowing for method chaining
  - getType
```
public ExternalTokenDetails.TypeEnum getType()
```
    The type of token. Allowed value: **externalToken**.
    
    Returns:
    
    type The type of token. Allowed value: **externalToken**.
  - setType
```
public void setType(ExternalTokenDetails.TypeEnum type)
```
    The type of token. Allowed value: **externalToken**.
    
    Parameters:
    
    type - The type of token. Allowed value: **externalToken**.
  - includeNullValues
```
public ExternalTokenDetails 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 ExternalTokenDetails 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 ExternalTokenDetails fromJson(String jsonString)
                                     throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of ExternalTokenDetails given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of ExternalTokenDetails
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to ExternalTokenDetails
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of ExternalTokenDetails to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class ExternalTokenDetails

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_CHECKOUT_ATTEMPT_ID

JSON_PROPERTY_EXPIRY_MONTH

JSON_PROPERTY_EXPIRY_YEAR

JSON_PROPERTY_HOLDER_NAME

JSON_PROPERTY_NUMBER

JSON_PROPERTY_STORED_PAYMENT_METHOD_ID

JSON_PROPERTY_SUBTYPE

JSON_PROPERTY_TYPE

Constructor Detail

ExternalTokenDetails

Method Detail

checkoutAttemptId

getCheckoutAttemptId

setCheckoutAttemptId

expiryMonth

getExpiryMonth

setExpiryMonth

expiryYear

getExpiryYear

setExpiryYear

holderName

getHolderName

setHolderName

number

getNumber

setNumber

storedPaymentMethodId

getStoredPaymentMethodId

setStoredPaymentMethodId

subtype

getSubtype

setSubtype

type

getType

setType

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson