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.TypeEnum	**voucher**

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_ALTERNATIVE_REFERENCE
static String	JSON_PROPERTY_COLLECTION_INSTITUTION_NUMBER
static String	JSON_PROPERTY_DOWNLOAD_URL
static String	JSON_PROPERTY_ENTITY
static String	JSON_PROPERTY_EXPIRES_AT
static String	JSON_PROPERTY_INITIAL_AMOUNT
static String	JSON_PROPERTY_INSTRUCTIONS_URL
static String	JSON_PROPERTY_ISSUER
static String	JSON_PROPERTY_MASKED_TELEPHONE_NUMBER
static String	JSON_PROPERTY_MERCHANT_NAME
static String	JSON_PROPERTY_MERCHANT_REFERENCE
static String	JSON_PROPERTY_PASS_CREATION_TOKEN
static String	JSON_PROPERTY_PAYMENT_DATA
static String	JSON_PROPERTY_PAYMENT_METHOD_TYPE
static String	JSON_PROPERTY_REFERENCE
static String	JSON_PROPERTY_SHOPPER_EMAIL
static String	JSON_PROPERTY_SHOPPER_NAME
static String	JSON_PROPERTY_SURCHARGE
static String	JSON_PROPERTY_TOTAL_AMOUNT
static String	JSON_PROPERTY_TYPE
static String	JSON_PROPERTY_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)	Return true if this CheckoutVoucherAction object is equal to 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	getPassCreationToken()	A base64 encoded signature of all properties
String	getPaymentData()	Encoded payment data.
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	passCreationToken(String passCreationToken)
CheckoutVoucherAction	paymentData(String paymentData)
CheckoutVoucherAction	paymentMethodType(String paymentMethodType)
CheckoutVoucherAction	reference(String reference)
void	setAlternativeReference(String alternativeReference)	The voucher alternative reference code.
void	setCollectionInstitutionNumber(String collectionInstitutionNumber)	A collection institution number (store number) for Econtext Pay-Easy ATM.
void	setDownloadUrl(String downloadUrl)	The URL to download the voucher.
void	setEntity(String entity)	An entity number of Multibanco.
void	setExpiresAt(String expiresAt)	The date time of the voucher expiry.
void	setInitialAmount(Amount initialAmount)	initialAmount
void	setInstructionsUrl(String instructionsUrl)	The URL to the detailed instructions to make payment using the voucher.
void	setIssuer(String issuer)	The issuer of the voucher.
void	setMaskedTelephoneNumber(String maskedTelephoneNumber)	The shopper telephone number (partially masked).
void	setMerchantName(String merchantName)	The merchant name.
void	setMerchantReference(String merchantReference)	The merchant reference.
void	setPassCreationToken(String passCreationToken)	A base64 encoded signature of all properties
void	setPaymentData(String paymentData)	Encoded payment data.
void	setPaymentMethodType(String paymentMethodType)	Specifies the payment method.
void	setReference(String reference)	The voucher reference code.
void	setShopperEmail(String shopperEmail)	The shopper email.
void	setShopperName(String shopperName)	The shopper name.
void	setSurcharge(Amount surcharge)	surcharge
void	setTotalAmount(Amount totalAmount)	totalAmount
void	setType(CheckoutVoucherAction.TypeEnum type)	**voucher**
void	setUrl(String url)	Specifies the URL to redirect to.
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)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_ALTERNATIVE_REFERENCE

public static final String JSON_PROPERTY_ALTERNATIVE_REFERENCE

See Also:

Constant Field Values

JSON_PROPERTY_COLLECTION_INSTITUTION_NUMBER

public static final String JSON_PROPERTY_COLLECTION_INSTITUTION_NUMBER

See Also:

Constant Field Values

JSON_PROPERTY_DOWNLOAD_URL

public static final String JSON_PROPERTY_DOWNLOAD_URL

See Also:

Constant Field Values

JSON_PROPERTY_ENTITY

public static final String JSON_PROPERTY_ENTITY

See Also:

Constant Field Values

JSON_PROPERTY_EXPIRES_AT

public static final String JSON_PROPERTY_EXPIRES_AT

See Also:

Constant Field Values

JSON_PROPERTY_INITIAL_AMOUNT

public static final String JSON_PROPERTY_INITIAL_AMOUNT

See Also:

Constant Field Values

JSON_PROPERTY_INSTRUCTIONS_URL

public static final String JSON_PROPERTY_INSTRUCTIONS_URL

See Also:

Constant Field Values

JSON_PROPERTY_ISSUER

public static final String JSON_PROPERTY_ISSUER

See Also:

Constant Field Values

JSON_PROPERTY_MASKED_TELEPHONE_NUMBER

public static final String JSON_PROPERTY_MASKED_TELEPHONE_NUMBER

See Also:

Constant Field Values

JSON_PROPERTY_MERCHANT_NAME

public static final String JSON_PROPERTY_MERCHANT_NAME

See Also:

Constant Field Values

JSON_PROPERTY_MERCHANT_REFERENCE

public static final String JSON_PROPERTY_MERCHANT_REFERENCE

See Also:

Constant Field Values

JSON_PROPERTY_PASS_CREATION_TOKEN

public static final String JSON_PROPERTY_PASS_CREATION_TOKEN

See Also:

Constant Field Values

JSON_PROPERTY_PAYMENT_DATA

public static final String JSON_PROPERTY_PAYMENT_DATA

See Also:

Constant Field Values

JSON_PROPERTY_PAYMENT_METHOD_TYPE

public static final String JSON_PROPERTY_PAYMENT_METHOD_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_REFERENCE

public static final String JSON_PROPERTY_REFERENCE

See Also:

Constant Field Values

JSON_PROPERTY_SHOPPER_EMAIL

public static final String JSON_PROPERTY_SHOPPER_EMAIL

See Also:

Constant Field Values

JSON_PROPERTY_SHOPPER_NAME

public static final String JSON_PROPERTY_SHOPPER_NAME

See Also:

Constant Field Values

JSON_PROPERTY_SURCHARGE

public static final String JSON_PROPERTY_SURCHARGE

See Also:

Constant Field Values

JSON_PROPERTY_TOTAL_AMOUNT

public static final String JSON_PROPERTY_TOTAL_AMOUNT

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_URL

public static final String JSON_PROPERTY_URL

See Also:

Constant Field Values

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)

The voucher alternative reference code.

Parameters:

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)

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

Parameters:

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)

The URL to download the voucher.

Parameters:

downloadUrl -

entity

public CheckoutVoucherAction entity(String entity)

getEntity

public String getEntity()

An entity number of Multibanco.

Returns:

entity

setEntity

public void setEntity(String entity)

An entity number of Multibanco.

Parameters:

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)

The date time of the voucher expiry.

Parameters:

expiresAt -

initialAmount

public CheckoutVoucherAction initialAmount(Amount initialAmount)

getInitialAmount

public Amount getInitialAmount()

Get initialAmount

Returns:

initialAmount

setInitialAmount

public void setInitialAmount(Amount initialAmount)

initialAmount

Parameters:

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)

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

Parameters:

instructionsUrl -

issuer

public CheckoutVoucherAction issuer(String issuer)

getIssuer

public String getIssuer()

The issuer of the voucher.

Returns:

issuer

setIssuer

public void setIssuer(String issuer)

The issuer of the voucher.

Parameters:

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)

The shopper telephone number (partially masked).

Parameters:

maskedTelephoneNumber -

merchantName

public CheckoutVoucherAction merchantName(String merchantName)

getMerchantName

public String getMerchantName()

The merchant name.

Returns:

merchantName

setMerchantName

public void setMerchantName(String merchantName)

The merchant name.

Parameters:

merchantName -

merchantReference

public CheckoutVoucherAction merchantReference(String merchantReference)

getMerchantReference

public String getMerchantReference()

The merchant reference.

Returns:

merchantReference

setMerchantReference

public void setMerchantReference(String merchantReference)

The merchant reference.

Parameters:

merchantReference -

passCreationToken

public CheckoutVoucherAction passCreationToken(String passCreationToken)

getPassCreationToken

public String getPassCreationToken()

A base64 encoded signature of all properties

Returns:

passCreationToken

setPassCreationToken

public void setPassCreationToken(String passCreationToken)

A base64 encoded signature of all properties

Parameters:

passCreationToken -

paymentData

public CheckoutVoucherAction paymentData(String paymentData)

getPaymentData

public String getPaymentData()

Encoded payment data.

Returns:

paymentData

setPaymentData

public void setPaymentData(String paymentData)

Encoded payment data.

Parameters:

paymentData -

paymentMethodType

public CheckoutVoucherAction paymentMethodType(String paymentMethodType)

getPaymentMethodType

public String getPaymentMethodType()

Specifies the payment method.

Returns:

paymentMethodType

setPaymentMethodType

public void setPaymentMethodType(String paymentMethodType)

Specifies the payment method.

Parameters:

paymentMethodType -

reference

public CheckoutVoucherAction reference(String reference)

getReference

public String getReference()

The voucher reference code.

Returns:

reference

setReference

public void setReference(String reference)

The voucher reference code.

Parameters:

reference -

shopperEmail

public CheckoutVoucherAction shopperEmail(String shopperEmail)

getShopperEmail

public String getShopperEmail()

The shopper email.

Returns:

shopperEmail

setShopperEmail

public void setShopperEmail(String shopperEmail)

The shopper email.

Parameters:

shopperEmail -

shopperName

public CheckoutVoucherAction shopperName(String shopperName)

getShopperName

public String getShopperName()

The shopper name.

Returns:

shopperName

setShopperName

public void setShopperName(String shopperName)

The shopper name.

Parameters:

shopperName -

surcharge

public CheckoutVoucherAction surcharge(Amount surcharge)

getSurcharge

public Amount getSurcharge()

Get surcharge

Returns:

surcharge

setSurcharge

public void setSurcharge(Amount surcharge)

surcharge

Parameters:

surcharge -

totalAmount

public CheckoutVoucherAction totalAmount(Amount totalAmount)

getTotalAmount

public Amount getTotalAmount()

Get totalAmount

Returns:

totalAmount

setTotalAmount

public void setTotalAmount(Amount totalAmount)

totalAmount

Parameters:

totalAmount -

type

public CheckoutVoucherAction type(CheckoutVoucherAction.TypeEnum type)

getType

public CheckoutVoucherAction.TypeEnum getType()

**voucher**

Returns:

type

setType

public void setType(CheckoutVoucherAction.TypeEnum type)

**voucher**

Parameters:

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)

Specifies the URL to redirect to.

Parameters:

url -

equals

public boolean equals(Object o)

Return true if this CheckoutVoucherAction 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

fromJson

public static CheckoutVoucherAction fromJson(String jsonString)
                                      throws com.fasterxml.jackson.core.JsonProcessingException

Create an instance of CheckoutVoucherAction given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CheckoutVoucherAction

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CheckoutVoucherAction

toJson

public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException

Convert an instance of CheckoutVoucherAction to an JSON string

Returns:

JSON string

Throws:

com.fasterxml.jackson.core.JsonProcessingException