AbstractPaymentsResponse (Adyen Java API Library 17.3.0 API)

java.lang.Object
- com.adyen.model.checkout.AbstractPaymentsResponse<T>

Direct Known Subclasses:: PaymentsDetailsResponse, PaymentsResponse

public abstract class AbstractPaymentsResponse<T extends AbstractPaymentsResponse<T>>
extends Object

Constructor Summary

Constructors
Constructor and Description

AbstractPaymentsResponse()

Constructors
Constructor and Description
`AbstractPaymentsResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`additionalData(Map<String,String> additionalData)`
`T`	`amount(Amount amount)`
`boolean`	`equals(Object o)`
`T`	`fraudResult(FraudResult fraudResult)`
`boolean`	`get3DAuthenticated()`
`boolean`	`get3DOffered()`
`Map<String,String>`	`getAdditionalData()` This field contains additional data, which may be required to return in a particular payment response.
`String`	`getAdditionalDataByKey(String key)`
`Amount`	`getAmount()` Get amount
`String`	`getAuthCode()`
`PaymentsResponse.ResultCodeEnum`	`getAuthResponse()`
`String`	`getAvsResult()`
`String`	`getCardBin()`
`String`	`getCardHolderName()`
`String`	`getCardSummary()`
`String`	`getDonationToken()` Donation Token containing payment details for Adyen Giving.
`Date`	`getExpiryDate()`
`FraudResult`	`getFraudResult()` Get fraudResult
`String`	`getMerchantReference()`
`CheckoutOrderResponse`	`getOrder()` Get order
`String`	`getPaymentMethod()`
`String`	`getPspReference()` Adyen's 16-digit unique reference associated with the transaction/the request.
`String`	`getRefusalReason()` If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error.
`String`	`getRefusalReasonCode()`
`PaymentsResponse.ResultCodeEnum`	`getResultCode()` The result of the payment.
`ServiceError`	`getServiceError()`
`ThreeDS2Result`	`getThreeDS2Result()` Result of the 3D Secure 2 authentication.
`int`	`hashCode()`
`T`	`order(CheckoutOrderResponse order)`
`T`	`pspReference(String pspReference)`
`T`	`putAdditionalDataItem(String key, String additionalDataItem)`
`T`	`refusalReason(String refusalReason)`
`T`	`refusalReasonCode(String refusalReasonCode)`
`T`	`resultCode(PaymentsResponse.ResultCodeEnum resultCode)`
`void`	`setAdditionalData(Map<String,String> additionalData)`
`void`	`setAmount(Amount amount)`
`void`	`setAuthResponse(PaymentsResponse.ResultCodeEnum authResponse)`
`void`	`setDonationToken(String donationToken)`
`void`	`setFraudResult(FraudResult fraudResult)`
`void`	`setMerchantReference(String merchantReference)`
`void`	`setOrder(CheckoutOrderResponse order)`
`void`	`setPspReference(String pspReference)`
`void`	`setRefusalReason(String refusalReason)`
`void`	`setRefusalReasonCode(String refusalReasonCode)`
`void`	`setResultCode(PaymentsResponse.ResultCodeEnum resultCode)`
`void`	`setServiceError(ServiceError serviceError)`
`void`	`setThreeDS2Result(ThreeDS2Result threeDS2Result)`
`T`	`threeDS2Result(ThreeDS2Result threeDS2Result)`
`String`	`toString()`

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

- Constructor Detail
  - AbstractPaymentsResponse
```
public AbstractPaymentsResponse()
```
- Method Detail
  - additionalData
```
public T additionalData(Map<String,String> additionalData)
```
  - putAdditionalDataItem
```
public T putAdditionalDataItem(String key,
                               String additionalDataItem)
```
  - getAdditionalData
```
public Map<String,String> getAdditionalData()
```
    This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Settings** > **API and Response**.
    
    Returns:
    
    additionalData
  - setAdditionalData
```
public void setAdditionalData(Map<String,String> additionalData)
```
  - getAdditionalDataByKey
```
public String getAdditionalDataByKey(String key)
```
  - fraudResult
```
public T fraudResult(FraudResult fraudResult)
```
  - getFraudResult
```
public FraudResult getFraudResult()
```
    Get fraudResult
    
    Returns:
    
    fraudResult
  - setFraudResult
```
public void setFraudResult(FraudResult fraudResult)
```
  - pspReference
```
public T pspReference(String pspReference)
```
  - getPspReference
```
public String getPspReference()
```
    Adyen's 16-digit unique reference associated with the transaction/the request. This value is globally unique; quote it when communicating with us about this request. > `pspReference` is returned only for non-redirect payment methods.
    
    Returns:
    
    pspReference
  - setPspReference
```
public void setPspReference(String pspReference)
```
  - refusalReason
```
public T refusalReason(String refusalReason)
```
  - getRefusalReason
```
public String getRefusalReason()
```
    If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.
    
    Returns:
    
    refusalReason
  - setRefusalReason
```
public void setRefusalReason(String refusalReason)
```
  - refusalReasonCode
```
public T refusalReasonCode(String refusalReasonCode)
```
  - getRefusalReasonCode
```
public String getRefusalReasonCode()
```
  - setRefusalReasonCode
```
public void setRefusalReasonCode(String refusalReasonCode)
```
  - resultCode
```
public T resultCode(PaymentsResponse.ResultCodeEnum resultCode)
```
  - getResultCode
```
public PaymentsResponse.ResultCodeEnum getResultCode()
```
    The result of the payment. Possible values: * **Authorised** – Indicates the payment authorisation was successfully completed. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. For more information on handling a redirect, refer to [Handling a redirect](https://docs.adyen.com/developers/checkout/api-integration/payments#handlingaredirect). * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. For more information on handling a pending payment, refer to [Payments with pending status](https://docs.adyen.com/developers/development-resources/payments-with-pending-status). * **Error** – Indicates an error occurred during processing of the payment. The reason is given in the `refusalReason` field. This is a final state.
    
    Returns:
    
    resultCode
  - setResultCode
```
public void setResultCode(PaymentsResponse.ResultCodeEnum resultCode)
```
  - getServiceError
```
public ServiceError getServiceError()
```
  - setServiceError
```
public void setServiceError(ServiceError serviceError)
```
  - getAuthResponse
```
public PaymentsResponse.ResultCodeEnum getAuthResponse()
```
  - setAuthResponse
```
public void setAuthResponse(PaymentsResponse.ResultCodeEnum authResponse)
```
  - getMerchantReference
```
public String getMerchantReference()
```
  - setMerchantReference
```
public void setMerchantReference(String merchantReference)
```
  - getThreeDS2Result
```
public ThreeDS2Result getThreeDS2Result()
```
    Result of the 3D Secure 2 authentication.
    
    Returns:
    
    threeDS2Result
  - setThreeDS2Result
```
public void setThreeDS2Result(ThreeDS2Result threeDS2Result)
```
  - threeDS2Result
```
public T threeDS2Result(ThreeDS2Result threeDS2Result)
```
  - amount
```
public T amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
  - order
```
public T order(CheckoutOrderResponse order)
```
  - getOrder
```
public CheckoutOrderResponse getOrder()
```
    Get order
    
    Returns:
    
    order
  - setOrder
```
public void setOrder(CheckoutOrderResponse order)
```
  - getDonationToken
```
public String getDonationToken()
```
    Donation Token containing payment details for Adyen Giving.
    
    Returns:
    
    donationToken
  - setDonationToken
```
public void setDonationToken(String donationToken)
```
  - 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
  - getCardBin
```
public String getCardBin()
```
  - getCardHolderName
```
public String getCardHolderName()
```
  - getCardSummary
```
public String getCardSummary()
```
  - getPaymentMethod
```
public String getPaymentMethod()
```
  - getAvsResult
```
public String getAvsResult()
```
  - get3DOffered
```
public boolean get3DOffered()
```
  - get3DAuthenticated
```
public boolean get3DAuthenticated()
```
  - getAuthCode
```
public String getAuthCode()
```
  - getExpiryDate
```
public Date getExpiryDate()
```

Class AbstractPaymentsResponse<T extends AbstractPaymentsResponse<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractPaymentsResponse

Method Detail

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

getAdditionalDataByKey

fraudResult

getFraudResult

setFraudResult

pspReference

getPspReference

setPspReference

refusalReason

getRefusalReason

setRefusalReason

refusalReasonCode

getRefusalReasonCode

setRefusalReasonCode

resultCode

getResultCode

setResultCode

getServiceError

setServiceError

getAuthResponse

setAuthResponse

getMerchantReference

setMerchantReference

getThreeDS2Result

setThreeDS2Result

threeDS2Result

amount

getAmount

setAmount

order

getOrder

setOrder

getDonationToken

setDonationToken

equals

hashCode

toString

getCardBin

getCardHolderName

getCardSummary

getPaymentMethod

getAvsResult

get3DOffered

get3DAuthenticated

getAuthCode

getExpiryDate