Package com.adyen.model.checkout

Class CheckoutVoucherAction

java.lang.Object

com.adyen.model.checkout.CheckoutVoucherAction

public class CheckoutVoucherAction
extends Object

CheckoutVoucherAction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CheckoutVoucherAction.CustomTypeAdapterFactory
static class	CheckoutVoucherAction.TypeEnum	**voucher**

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ALTERNATIVE_REFERENCE
static String	SERIALIZED_NAME_COLLECTION_INSTITUTION_NUMBER
static String	SERIALIZED_NAME_DOWNLOAD_URL
static String	SERIALIZED_NAME_ENTITY
static String	SERIALIZED_NAME_EXPIRES_AT
static String	SERIALIZED_NAME_INITIAL_AMOUNT
static String	SERIALIZED_NAME_INSTRUCTIONS_URL
static String	SERIALIZED_NAME_ISSUER
static String	SERIALIZED_NAME_MASKED_TELEPHONE_NUMBER
static String	SERIALIZED_NAME_MERCHANT_NAME
static String	SERIALIZED_NAME_MERCHANT_REFERENCE
static String	SERIALIZED_NAME_PAYMENT_DATA
static String	SERIALIZED_NAME_PAYMENT_METHOD_TYPE
static String	SERIALIZED_NAME_REFERENCE
static String	SERIALIZED_NAME_SHOPPER_EMAIL
static String	SERIALIZED_NAME_SHOPPER_NAME
static String	SERIALIZED_NAME_SURCHARGE
static String	SERIALIZED_NAME_TOTAL_AMOUNT
static String	SERIALIZED_NAME_TYPE
static String	SERIALIZED_NAME_URL

Constructor Summary

Constructors

Constructor	Description
CheckoutVoucherAction()

Method Summary

Modifier and Type	Method	Description
CheckoutVoucherAction	alternativeReference(String alternativeReference)
CheckoutVoucherAction	collectionInstitutionNumber(String collectionInstitutionNumber)
CheckoutVoucherAction	downloadUrl(String downloadUrl)
CheckoutVoucherAction	entity(String entity)
boolean	equals(Object o)
CheckoutVoucherAction	expiresAt(String expiresAt)
static CheckoutVoucherAction	fromJson(String jsonString)	Create an instance of CheckoutVoucherAction given an JSON string
String	getAlternativeReference()	The voucher alternative reference code.
String	getCollectionInstitutionNumber()	A collection institution number (store number) for Econtext Pay-Easy ATM.
String	getDownloadUrl()	The URL to download the voucher.
String	getEntity()	An entity number of Multibanco.
String	getExpiresAt()	The date time of the voucher expiry.
Amount	getInitialAmount()	Get initialAmount
String	getInstructionsUrl()	The URL to the detailed instructions to make payment using the voucher.
String	getIssuer()	The issuer of the voucher.
String	getMaskedTelephoneNumber()	The shopper telephone number (partially masked).
String	getMerchantName()	The merchant name.
String	getMerchantReference()	The merchant reference.
String	getPaymentData()	A value that must be submitted to the `/payments/details` endpoint to verify this payment.
String	getPaymentMethodType()	Specifies the payment method.
String	getReference()	The voucher reference code.
String	getShopperEmail()	The shopper email.
String	getShopperName()	The shopper name.
Amount	getSurcharge()	Get surcharge
Amount	getTotalAmount()	Get totalAmount
CheckoutVoucherAction.TypeEnum	getType()	**voucher**
String	getUrl()	Specifies the URL to redirect to.
int	hashCode()
CheckoutVoucherAction	initialAmount(Amount initialAmount)
CheckoutVoucherAction	instructionsUrl(String instructionsUrl)
CheckoutVoucherAction	issuer(String issuer)
CheckoutVoucherAction	maskedTelephoneNumber(String maskedTelephoneNumber)
CheckoutVoucherAction	merchantName(String merchantName)
CheckoutVoucherAction	merchantReference(String merchantReference)
CheckoutVoucherAction	paymentData(String paymentData)
CheckoutVoucherAction	paymentMethodType(String paymentMethodType)
CheckoutVoucherAction	reference(String reference)
void	setAlternativeReference(String alternativeReference)
void	setCollectionInstitutionNumber(String collectionInstitutionNumber)
void	setDownloadUrl(String downloadUrl)
void	setEntity(String entity)
void	setExpiresAt(String expiresAt)
void	setInitialAmount(Amount initialAmount)
void	setInstructionsUrl(String instructionsUrl)
void	setIssuer(String issuer)
void	setMaskedTelephoneNumber(String maskedTelephoneNumber)
void	setMerchantName(String merchantName)
void	setMerchantReference(String merchantReference)
void	setPaymentData(String paymentData)
void	setPaymentMethodType(String paymentMethodType)
void	setReference(String reference)
void	setShopperEmail(String shopperEmail)
void	setShopperName(String shopperName)
void	setSurcharge(Amount surcharge)
void	setTotalAmount(Amount totalAmount)
void	setType(CheckoutVoucherAction.TypeEnum type)
void	setUrl(String url)
CheckoutVoucherAction	shopperEmail(String shopperEmail)
CheckoutVoucherAction	shopperName(String shopperName)
CheckoutVoucherAction	surcharge(Amount surcharge)
String	toJson()	Convert an instance of CheckoutVoucherAction to an JSON string
String	toString()
CheckoutVoucherAction	totalAmount(Amount totalAmount)
CheckoutVoucherAction	type(CheckoutVoucherAction.TypeEnum type)
CheckoutVoucherAction	url(String url)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj)	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ALTERNATIVE_REFERENCE

public static final String SERIALIZED_NAME_ALTERNATIVE_REFERENCE

See Also:

Constant Field Values

SERIALIZED_NAME_COLLECTION_INSTITUTION_NUMBER

public static final String SERIALIZED_NAME_COLLECTION_INSTITUTION_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_DOWNLOAD_URL

public static final String SERIALIZED_NAME_DOWNLOAD_URL

See Also:

Constant Field Values

SERIALIZED_NAME_ENTITY

public static final String SERIALIZED_NAME_ENTITY

See Also:

Constant Field Values

SERIALIZED_NAME_EXPIRES_AT

public static final String SERIALIZED_NAME_EXPIRES_AT

See Also:

Constant Field Values

SERIALIZED_NAME_INITIAL_AMOUNT

public static final String SERIALIZED_NAME_INITIAL_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_INSTRUCTIONS_URL

public static final String SERIALIZED_NAME_INSTRUCTIONS_URL

See Also:

Constant Field Values

SERIALIZED_NAME_ISSUER

public static final String SERIALIZED_NAME_ISSUER

See Also:

Constant Field Values

SERIALIZED_NAME_MASKED_TELEPHONE_NUMBER

public static final String SERIALIZED_NAME_MASKED_TELEPHONE_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_MERCHANT_NAME

public static final String SERIALIZED_NAME_MERCHANT_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_MERCHANT_REFERENCE

public static final String SERIALIZED_NAME_MERCHANT_REFERENCE

See Also:

Constant Field Values

SERIALIZED_NAME_PAYMENT_DATA

public static final String SERIALIZED_NAME_PAYMENT_DATA

See Also:

Constant Field Values

SERIALIZED_NAME_PAYMENT_METHOD_TYPE

public static final String SERIALIZED_NAME_PAYMENT_METHOD_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_REFERENCE

public static final String SERIALIZED_NAME_REFERENCE

See Also:

Constant Field Values

SERIALIZED_NAME_SHOPPER_EMAIL

public static final String SERIALIZED_NAME_SHOPPER_EMAIL

See Also:

Constant Field Values

SERIALIZED_NAME_SHOPPER_NAME

public static final String SERIALIZED_NAME_SHOPPER_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_SURCHARGE

public static final String SERIALIZED_NAME_SURCHARGE

See Also:

Constant Field Values

SERIALIZED_NAME_TOTAL_AMOUNT

public static final String SERIALIZED_NAME_TOTAL_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_URL

public static final String SERIALIZED_NAME_URL

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

CheckoutVoucherAction

public CheckoutVoucherAction()

Method Detail

alternativeReference

public CheckoutVoucherAction alternativeReference(String alternativeReference)

getAlternativeReference

public String getAlternativeReference()

The voucher alternative reference code.

Returns:

alternativeReference

setAlternativeReference

public void setAlternativeReference(String alternativeReference)

collectionInstitutionNumber

public CheckoutVoucherAction collectionInstitutionNumber(String collectionInstitutionNumber)

getCollectionInstitutionNumber

public String getCollectionInstitutionNumber()

A collection institution number (store number) for Econtext Pay-Easy ATM.

Returns:

collectionInstitutionNumber

setCollectionInstitutionNumber

public void setCollectionInstitutionNumber(String collectionInstitutionNumber)

downloadUrl

public CheckoutVoucherAction downloadUrl(String downloadUrl)

getDownloadUrl

public String getDownloadUrl()

The URL to download the voucher.

Returns:

downloadUrl

setDownloadUrl

public void setDownloadUrl(String downloadUrl)

entity

public CheckoutVoucherAction entity(String entity)

getEntity

public String getEntity()

An entity number of Multibanco.

Returns:

entity

setEntity

public void setEntity(String entity)

expiresAt

public CheckoutVoucherAction expiresAt(String expiresAt)

getExpiresAt

public String getExpiresAt()

The date time of the voucher expiry.

Returns:

expiresAt

setExpiresAt

public void setExpiresAt(String expiresAt)

initialAmount

public CheckoutVoucherAction initialAmount(Amount initialAmount)

getInitialAmount

public Amount getInitialAmount()

Get initialAmount

Returns:

initialAmount

setInitialAmount

public void setInitialAmount(Amount initialAmount)

instructionsUrl

public CheckoutVoucherAction instructionsUrl(String instructionsUrl)

getInstructionsUrl

public String getInstructionsUrl()

The URL to the detailed instructions to make payment using the voucher.

Returns:

instructionsUrl

setInstructionsUrl

public void setInstructionsUrl(String instructionsUrl)

issuer

public CheckoutVoucherAction issuer(String issuer)

getIssuer

public String getIssuer()

The issuer of the voucher.

Returns:

issuer

setIssuer

public void setIssuer(String issuer)

maskedTelephoneNumber

public CheckoutVoucherAction maskedTelephoneNumber(String maskedTelephoneNumber)

getMaskedTelephoneNumber

public String getMaskedTelephoneNumber()

The shopper telephone number (partially masked).

Returns:

maskedTelephoneNumber

setMaskedTelephoneNumber

public void setMaskedTelephoneNumber(String maskedTelephoneNumber)

merchantName

public CheckoutVoucherAction merchantName(String merchantName)

getMerchantName

public String getMerchantName()

The merchant name.

Returns:

merchantName

setMerchantName

public void setMerchantName(String merchantName)

merchantReference

public CheckoutVoucherAction merchantReference(String merchantReference)

getMerchantReference

public String getMerchantReference()

The merchant reference.

Returns:

merchantReference

setMerchantReference

public void setMerchantReference(String merchantReference)

paymentData

public CheckoutVoucherAction paymentData(String paymentData)

getPaymentData

public String getPaymentData()

A value that must be submitted to the `/payments/details` endpoint to verify this payment.

Returns:

paymentData

setPaymentData

public void setPaymentData(String paymentData)

paymentMethodType

public CheckoutVoucherAction paymentMethodType(String paymentMethodType)

getPaymentMethodType

public String getPaymentMethodType()

Specifies the payment method.

Returns:

paymentMethodType

setPaymentMethodType

public void setPaymentMethodType(String paymentMethodType)

reference

public CheckoutVoucherAction reference(String reference)

getReference

public String getReference()

The voucher reference code.

Returns:

reference

setReference

public void setReference(String reference)

shopperEmail

public CheckoutVoucherAction shopperEmail(String shopperEmail)

getShopperEmail

public String getShopperEmail()

The shopper email.

Returns:

shopperEmail

setShopperEmail

public void setShopperEmail(String shopperEmail)

shopperName

public CheckoutVoucherAction shopperName(String shopperName)

getShopperName

public String getShopperName()

The shopper name.

Returns:

shopperName

setShopperName

public void setShopperName(String shopperName)

surcharge

public CheckoutVoucherAction surcharge(Amount surcharge)

getSurcharge

public Amount getSurcharge()

Get surcharge

Returns:

surcharge

setSurcharge

public void setSurcharge(Amount surcharge)

totalAmount

public CheckoutVoucherAction totalAmount(Amount totalAmount)

getTotalAmount

public Amount getTotalAmount()

Get totalAmount

Returns:

totalAmount

setTotalAmount

public void setTotalAmount(Amount totalAmount)

type

public CheckoutVoucherAction type(CheckoutVoucherAction.TypeEnum type)

getType

public CheckoutVoucherAction.TypeEnum getType()

**voucher**

Returns:

type

setType

public void setType(CheckoutVoucherAction.TypeEnum type)

url

public CheckoutVoucherAction url(String url)

getUrl

public String getUrl()

Specifies the URL to redirect to.

Returns:

url

setUrl

public void setUrl(String url)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to CheckoutVoucherAction

fromJson

public static CheckoutVoucherAction fromJson(String jsonString)
                                      throws IOException

Create an instance of CheckoutVoucherAction given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CheckoutVoucherAction

Throws:

IOException - if the JSON string is invalid with respect to CheckoutVoucherAction

toJson

public String toJson()

Convert an instance of CheckoutVoucherAction to an JSON string

Returns:

JSON string