CheckoutPaymentsAction (Adyen Java API Library 17.3.0 API)

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

public class CheckoutPaymentsAction
extends Object

CheckoutPaymentsAction

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CheckoutPaymentsAction.CheckoutActionType
Enum that specifies the action that needs to be taken by the client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CheckoutPaymentsAction.CheckoutActionType` Enum that specifies the action that needs to be taken by the client.

Constructor Summary

Constructors
Constructor and Description

CheckoutPaymentsAction()

Constructors
Constructor and Description
`CheckoutPaymentsAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CheckoutPaymentsAction`	`alternativeReference(String alternativeReference)`
`CheckoutPaymentsAction`	`authorisationToken(String authorisationToken)`
`CheckoutPaymentsAction`	`data(Map<String,String> data)`
`CheckoutPaymentsAction`	`downloadUrl(String downloadUrl)`
`CheckoutPaymentsAction`	`entity(String entity)`
`boolean`	`equals(Object o)`
`CheckoutPaymentsAction`	`expiresAt(String expiresAt)`
`String`	`getAlternativeReference()` The voucher alternative reference code.
`String`	`getAuthorisationToken()`
`String`	`getBeneficiary()`
`String`	`getBic()`
`String`	`getCollectionInstitutionNumber()`
`Map<String,String>`	`getData()` When the redirect URL must be accessed via POST, use this data to post to the redirect URL.
`String`	`getDownloadUrl()` The URL to download the voucher.
`String`	`getEntity()`
`String`	`getExpiresAt()` The date time of the voucher expiry.
`String`	`getIban()`
`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`	`getMethod()` Specifies the HTTP method, for example GET or POST.
`String`	`getPaymentData()` When non-empty, contains a value that you must submit to the `/payments/details` endpoint.
`String`	`getPaymentMethodType()` Specifies the payment method.
`String`	`getQrCodeData()` The contents of the QR code as a UTF8 string.
`Redirect`	`getRedirect()`
`String`	`getReference()` The voucher reference code.
`int`	`getResendInterval()`
`int`	`getResendMaxAttempts()`
`String`	`getResendUrl()`
`Map<String,String>`	`getSdkData()` Returns SDK data.
`String`	`getShopperEmail()` The shopper email.
`String`	`getShopperName()` The shopper name.
`String`	`getShopperStatement()`
`String`	`getSubtype()`
`Amount`	`getSurcharge()` Get surcharge
`String`	`getToken()` A token to pass to the 3DS2 Component to get the fingerprint/challenge.
`Amount`	`getTotalAmount()` Get totalAmount
`CheckoutPaymentsAction.CheckoutActionType`	`getType()` Enum that specifies the action that needs to be taken by the client.
`String`	`getUrl()` Specifies the URL to redirect to.
`int`	`hashCode()`
`CheckoutPaymentsAction`	`initialAmount(Amount initialAmount)`
`CheckoutPaymentsAction`	`instructionsUrl(String instructionsUrl)`
`CheckoutPaymentsAction`	`issuer(String issuer)`
`CheckoutPaymentsAction`	`maskedTelephoneNumber(String maskedTelephoneNumber)`
`CheckoutPaymentsAction`	`merchantName(String merchantName)`
`CheckoutPaymentsAction`	`merchantReference(String merchantReference)`
`CheckoutPaymentsAction`	`method(String method)`
`CheckoutPaymentsAction`	`paymentData(String paymentData)`
`CheckoutPaymentsAction`	`paymentMethodType(String paymentMethodType)`
`CheckoutPaymentsAction`	`qrCodeData(String qrCodeData)`
`CheckoutPaymentsAction`	`reference(String reference)`
`void`	`setAlternativeReference(String alternativeReference)`
`void`	`setAuthorisationToken(String authorisationToken)`
`void`	`setBeneficiary(String beneficiary)`
`void`	`setBic(String bic)`
`void`	`setCollectionInstitutionNumber(String collectionInstitutionNumber)`
`void`	`setData(Map<String,String> data)`
`void`	`setDownloadUrl(String downloadUrl)`
`void`	`setEntity(String entity)`
`void`	`setExpiresAt(String expiresAt)`
`void`	`setIban(String iban)`
`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`	`setMethod(String method)`
`void`	`setPaymentData(String paymentData)`
`void`	`setPaymentMethodType(String paymentMethodType)`
`void`	`setQrCodeData(String qrCodeData)`
`void`	`setRedirect(Redirect redirect)`
`void`	`setReference(String reference)`
`void`	`setResendInterval(int resendInterval)`
`void`	`setResendMaxAttempts(int resendMaxAttempts)`
`void`	`setResendUrl(String resendUrl)`
`void`	`setSdkData(Map<String,String> sdkData)`
`void`	`setShopperEmail(String shopperEmail)`
`void`	`setShopperName(String shopperName)`
`void`	`setShopperStatement(String shopperStatement)`
`void`	`setSubtype(String subtype)`
`void`	`setSurcharge(Amount surcharge)`
`void`	`setToken(String token)`
`void`	`setTotalAmount(Amount totalAmount)`
`void`	`setType(CheckoutPaymentsAction.CheckoutActionType type)`
`void`	`setUrl(String url)`
`CheckoutPaymentsAction`	`shopperEmail(String shopperEmail)`
`CheckoutPaymentsAction`	`shopperName(String shopperName)`
`CheckoutPaymentsAction`	`subtype(String subtype)`
`CheckoutPaymentsAction`	`surcharge(Amount surcharge)`
`CheckoutPaymentsAction`	`token(String token)`
`String`	`toString()`
`CheckoutPaymentsAction`	`totalAmount(Amount totalAmount)`
`CheckoutPaymentsAction`	`type(CheckoutPaymentsAction.CheckoutActionType type)`
`CheckoutPaymentsAction`	`url(String url)`

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

Constructor Detail
- CheckoutPaymentsAction
```
public CheckoutPaymentsAction()
```

Method Detail

alternativeReference

public CheckoutPaymentsAction alternativeReference(String alternativeReference)

getAlternativeReference
```
public String getAlternativeReference()
```
The voucher alternative reference code.

Returns:

alternativeReference

setAlternativeReference

public void setAlternativeReference(String alternativeReference)

data

public CheckoutPaymentsAction data(Map<String,String> data)

getData
```
public Map<String,String> getData()
```
When the redirect URL must be accessed via POST, use this data to post to the redirect URL.

Returns:

data

setData

public void setData(Map<String,String> data)

downloadUrl

public CheckoutPaymentsAction downloadUrl(String downloadUrl)

getDownloadUrl
```
public String getDownloadUrl()
```
The URL to download the voucher.

Returns:

downloadUrl

setDownloadUrl

public void setDownloadUrl(String downloadUrl)

expiresAt

public CheckoutPaymentsAction expiresAt(String expiresAt)

getExpiresAt
```
public String getExpiresAt()
```
The date time of the voucher expiry.

Returns:

expiresAt

setExpiresAt

public void setExpiresAt(String expiresAt)

initialAmount

public CheckoutPaymentsAction initialAmount(Amount initialAmount)

getInitialAmount
```
public Amount getInitialAmount()
```
Get initialAmount

Returns:

initialAmount

setInitialAmount

public void setInitialAmount(Amount initialAmount)

instructionsUrl

public CheckoutPaymentsAction 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 CheckoutPaymentsAction issuer(String issuer)

getIssuer
```
public String getIssuer()
```
The issuer of the voucher.

Returns:

issuer

setIssuer
```
public void setIssuer(String issuer)
```

maskedTelephoneNumber

public CheckoutPaymentsAction maskedTelephoneNumber(String maskedTelephoneNumber)

getMaskedTelephoneNumber
```
public String getMaskedTelephoneNumber()
```
The shopper telephone number (partially masked).

Returns:

maskedTelephoneNumber

setMaskedTelephoneNumber

public void setMaskedTelephoneNumber(String maskedTelephoneNumber)

merchantName

public CheckoutPaymentsAction merchantName(String merchantName)

getMerchantName
```
public String getMerchantName()
```
The merchant name.

Returns:

merchantName

setMerchantName

public void setMerchantName(String merchantName)

merchantReference

public CheckoutPaymentsAction merchantReference(String merchantReference)

getMerchantReference
```
public String getMerchantReference()
```
The merchant reference.

Returns:

merchantReference

setMerchantReference

public void setMerchantReference(String merchantReference)

method

public CheckoutPaymentsAction method(String method)

getMethod
```
public String getMethod()
```
Specifies the HTTP method, for example GET or POST.

Returns:

method

setMethod
```
public void setMethod(String method)
```

paymentData

public CheckoutPaymentsAction paymentData(String paymentData)

getPaymentData
```
public String getPaymentData()
```
When non-empty, contains a value that you must submit to the `/payments/details` endpoint. In some cases, required for polling.

Returns:

paymentData

setPaymentData

public void setPaymentData(String paymentData)

paymentMethodType

public CheckoutPaymentsAction paymentMethodType(String paymentMethodType)

getPaymentMethodType
```
public String getPaymentMethodType()
```
Specifies the payment method.

Returns:

paymentMethodType

setPaymentMethodType

public void setPaymentMethodType(String paymentMethodType)

qrCodeData

public CheckoutPaymentsAction qrCodeData(String qrCodeData)

getQrCodeData
```
public String getQrCodeData()
```
The contents of the QR code as a UTF8 string.

Returns:

qrCodeData

setQrCodeData

public void setQrCodeData(String qrCodeData)

reference

public CheckoutPaymentsAction reference(String reference)

getReference
```
public String getReference()
```
The voucher reference code.

Returns:

reference

setReference

public void setReference(String reference)

shopperEmail

public CheckoutPaymentsAction shopperEmail(String shopperEmail)

getShopperEmail
```
public String getShopperEmail()
```
The shopper email.

Returns:

shopperEmail

setShopperEmail

public void setShopperEmail(String shopperEmail)

shopperName

public CheckoutPaymentsAction shopperName(String shopperName)

getShopperName
```
public String getShopperName()
```
The shopper name.

Returns:

shopperName

setShopperName

public void setShopperName(String shopperName)

surcharge

public CheckoutPaymentsAction surcharge(Amount surcharge)

getSurcharge
```
public Amount getSurcharge()
```
Get surcharge

Returns:

surcharge

setSurcharge

public void setSurcharge(Amount surcharge)

token

public CheckoutPaymentsAction token(String token)

getToken
```
public String getToken()
```
A token to pass to the 3DS2 Component to get the fingerprint/challenge.

Returns:

token

setToken
```
public void setToken(String token)
```

totalAmount

public CheckoutPaymentsAction totalAmount(Amount totalAmount)

getTotalAmount
```
public Amount getTotalAmount()
```
Get totalAmount

Returns:

totalAmount

setTotalAmount

public void setTotalAmount(Amount totalAmount)

getEntity
```
public String getEntity()
```

setEntity
```
public void setEntity(String entity)
```

entity

public CheckoutPaymentsAction entity(String entity)

type

public CheckoutPaymentsAction type(CheckoutPaymentsAction.CheckoutActionType type)

getType
```
public CheckoutPaymentsAction.CheckoutActionType getType()
```
Enum that specifies the action that needs to be taken by the client.

Returns:

type

setType

public void setType(CheckoutPaymentsAction.CheckoutActionType type)

url

public CheckoutPaymentsAction url(String url)

getUrl
```
public String getUrl()
```
Specifies the URL to redirect to.

Returns:

url

setUrl
```
public void setUrl(String url)
```

getSdkData

public Map<String,String> getSdkData()

Returns SDK data.

Returns:: sdkData

setSdkData

public void setSdkData(Map<String,String> sdkData)

getResendInterval
```
public int getResendInterval()
```

getResendMaxAttempts
```
public int getResendMaxAttempts()
```

getResendUrl
```
public String getResendUrl()
```

getRedirect
```
public Redirect getRedirect()
```

getAuthorisationToken
```
public String getAuthorisationToken()
```

setAuthorisationToken

public void setAuthorisationToken(String authorisationToken)

authorisationToken

public CheckoutPaymentsAction authorisationToken(String authorisationToken)

getSubtype
```
public String getSubtype()
```

setSubtype

public void setSubtype(String subtype)

subtype

public CheckoutPaymentsAction subtype(String subtype)

setResendInterval

public void setResendInterval(int resendInterval)

setResendMaxAttempts

public void setResendMaxAttempts(int resendMaxAttempts)

setResendUrl

public void setResendUrl(String resendUrl)

setRedirect

public void setRedirect(Redirect redirect)

getBeneficiary
```
public String getBeneficiary()
```

setBeneficiary

public void setBeneficiary(String beneficiary)

getBic
```
public String getBic()
```

setBic
```
public void setBic(String bic)
```

getIban
```
public String getIban()
```

setIban
```
public void setIban(String iban)
```

getShopperStatement
```
public String getShopperStatement()
```

setShopperStatement

public void setShopperStatement(String shopperStatement)

getCollectionInstitutionNumber

public String getCollectionInstitutionNumber()

setCollectionInstitutionNumber

public void setCollectionInstitutionNumber(String collectionInstitutionNumber)

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

Class CheckoutPaymentsAction

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CheckoutPaymentsAction

Method Detail

alternativeReference

getAlternativeReference

setAlternativeReference

data

getData

setData

downloadUrl

getDownloadUrl

setDownloadUrl

expiresAt

getExpiresAt

setExpiresAt

initialAmount

getInitialAmount

setInitialAmount

instructionsUrl

getInstructionsUrl

setInstructionsUrl

issuer

getIssuer

setIssuer

maskedTelephoneNumber

getMaskedTelephoneNumber

setMaskedTelephoneNumber

merchantName

getMerchantName

setMerchantName

merchantReference

getMerchantReference

setMerchantReference

method

getMethod

setMethod

paymentData

getPaymentData

setPaymentData

paymentMethodType

getPaymentMethodType

setPaymentMethodType

qrCodeData

getQrCodeData

setQrCodeData

reference

getReference

setReference

shopperEmail

getShopperEmail

setShopperEmail

shopperName

getShopperName

setShopperName

surcharge

getSurcharge

setSurcharge

token

getToken

setToken

totalAmount

getTotalAmount

setTotalAmount

getEntity

setEntity

entity

type

getType

setType

url

getUrl

setUrl

getSdkData

setSdkData

getResendInterval