Class IdentificationData
- java.lang.Object
-
- com.adyen.model.legalentitymanagement.IdentificationData
-
public class IdentificationData extends Object
IdentificationData
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classIdentificationData.TypeEnumType of identity data.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_CARD_NUMBERstatic StringJSON_PROPERTY_EXPIRY_DATEstatic StringJSON_PROPERTY_ISSUER_COUNTRYstatic StringJSON_PROPERTY_ISSUER_STATEstatic StringJSON_PROPERTY_NATIONAL_ID_EXEMPTstatic StringJSON_PROPERTY_NUMBERstatic StringJSON_PROPERTY_TYPE
-
Constructor Summary
Constructors Constructor Description IdentificationData()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IdentificationDatacardNumber(String cardNumber)booleanequals(Object o)Return true if this IdentificationData object is equal to o.IdentificationDataexpiryDate(String expiryDate)static IdentificationDatafromJson(String jsonString)Create an instance of IdentificationData given an JSON stringStringgetCardNumber()The card number of the document that was issued (AU only).StringgetExpiryDate()The expiry date of the document, in YYYY-MM-DD format.StringgetIssuerCountry()Deprecated.StringgetIssuerState()The state or province where the document was issued (AU only).BooleangetNationalIdExempt()Applies only to individuals in the US.StringgetNumber()The number in the document.IdentificationData.TypeEnumgetType()Type of identity data.inthashCode()IdentificationDataissuerCountry(String issuerCountry)Deprecated.IdentificationDataissuerState(String issuerState)IdentificationDatanationalIdExempt(Boolean nationalIdExempt)IdentificationDatanumber(String number)voidsetCardNumber(String cardNumber)The card number of the document that was issued (AU only).voidsetExpiryDate(String expiryDate)The expiry date of the document, in YYYY-MM-DD format.voidsetIssuerCountry(String issuerCountry)Deprecated.voidsetIssuerState(String issuerState)The state or province where the document was issued (AU only).voidsetNationalIdExempt(Boolean nationalIdExempt)Applies only to individuals in the US.voidsetNumber(String number)The number in the document.voidsetType(IdentificationData.TypeEnum type)Type of identity data.StringtoJson()Convert an instance of IdentificationData to an JSON stringStringtoString()IdentificationDatatype(IdentificationData.TypeEnum type)
-
-
-
Field Detail
-
JSON_PROPERTY_CARD_NUMBER
public static final String JSON_PROPERTY_CARD_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EXPIRY_DATE
public static final String JSON_PROPERTY_EXPIRY_DATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ISSUER_COUNTRY
public static final String JSON_PROPERTY_ISSUER_COUNTRY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ISSUER_STATE
public static final String JSON_PROPERTY_ISSUER_STATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NATIONAL_ID_EXEMPT
public static final String JSON_PROPERTY_NATIONAL_ID_EXEMPT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NUMBER
public static final String JSON_PROPERTY_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TYPE
public static final String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
-
Method Detail
-
cardNumber
public IdentificationData cardNumber(String cardNumber)
-
getCardNumber
public String getCardNumber()
The card number of the document that was issued (AU only).- Returns:
- cardNumber
-
setCardNumber
public void setCardNumber(String cardNumber)
The card number of the document that was issued (AU only).- Parameters:
cardNumber-
-
expiryDate
public IdentificationData expiryDate(String expiryDate)
-
getExpiryDate
public String getExpiryDate()
The expiry date of the document, in YYYY-MM-DD format.- Returns:
- expiryDate
-
setExpiryDate
public void setExpiryDate(String expiryDate)
The expiry date of the document, in YYYY-MM-DD format.- Parameters:
expiryDate-
-
issuerCountry
@Deprecated public IdentificationData issuerCountry(String issuerCountry)
Deprecated.
-
getIssuerCountry
@Deprecated public String getIssuerCountry()
Deprecated.The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**.- Returns:
- issuerCountry
-
setIssuerCountry
@Deprecated public void setIssuerCountry(String issuerCountry)
Deprecated.The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**.- Parameters:
issuerCountry-
-
issuerState
public IdentificationData issuerState(String issuerState)
-
getIssuerState
public String getIssuerState()
The state or province where the document was issued (AU only).- Returns:
- issuerState
-
setIssuerState
public void setIssuerState(String issuerState)
The state or province where the document was issued (AU only).- Parameters:
issuerState-
-
nationalIdExempt
public IdentificationData nationalIdExempt(Boolean nationalIdExempt)
-
getNationalIdExempt
public Boolean getNationalIdExempt()
Applies only to individuals in the US. Set to **true** if the individual does not have an SSN. To verify their identity, Adyen will require them to upload an ID document.- Returns:
- nationalIdExempt
-
setNationalIdExempt
public void setNationalIdExempt(Boolean nationalIdExempt)
Applies only to individuals in the US. Set to **true** if the individual does not have an SSN. To verify their identity, Adyen will require them to upload an ID document.- Parameters:
nationalIdExempt-
-
number
public IdentificationData number(String number)
-
getNumber
public String getNumber()
The number in the document.- Returns:
- number
-
setNumber
public void setNumber(String number)
The number in the document.- Parameters:
number-
-
type
public IdentificationData type(IdentificationData.TypeEnum type)
-
getType
public IdentificationData.TypeEnum getType()
Type of identity data. For individuals, the `type` value is **nationalIdNumber**. For individuals in these countries, the following types are supported. - Australia: **driversLicense**, **passport** - Hong Kong: **driversLicense**, **nationalIdNumber**, **passport** - New Zealand: **driversLicense**, **passport** - Singapore: **driversLicense**, **nationalIdNumber**, **passport**- Returns:
- type
-
setType
public void setType(IdentificationData.TypeEnum type)
Type of identity data. For individuals, the `type` value is **nationalIdNumber**. For individuals in these countries, the following types are supported. - Australia: **driversLicense**, **passport** - Hong Kong: **driversLicense**, **nationalIdNumber**, **passport** - New Zealand: **driversLicense**, **passport** - Singapore: **driversLicense**, **nationalIdNumber**, **passport**- Parameters:
type-
-
equals
public boolean equals(Object o)
Return true if this IdentificationData object is equal to o.
-
fromJson
public static IdentificationData fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of IdentificationData given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of IdentificationData
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to IdentificationData
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of IdentificationData to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-