PaymentResultResponse (Adyen Java API Library 17.3.0 API)

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

public class PaymentResultResponse
extends Object

PaymentResultResponse

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PaymentResultResponse.ResultCodeEnum
The result of the payment.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PaymentResultResponse.ResultCodeEnum` The result of the payment.

Constructor Summary

Constructors
Constructor and Description

PaymentResultResponse()

Constructors
Constructor and Description
`PaymentResultResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PaymentResultResponse`	`additionalData(Map<String,String> additionalData)`
`PaymentResultResponse`	`authResponse(String authResponse)`
`boolean`	`equals(Object o)`
`Map<String,String>`	`getAdditionalData()` This field contains additional data, which may be required to return in a particular payment response.
`String`	`getAuthResponse()` The authorisation code representing the authentication result.
`FraudResult`	`getFraudResult()` Get fraudResult
`String`	`getMerchantReference()` A unique value that you provided in the initial `/paymentSession` request as a `reference` field.
`String`	`getPaymentMethod()` The payment method used in the transaction.
`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()`
`PaymentResultResponse.ResultCodeEnum`	`getResultCode()` The result of the payment.
`ServiceError`	`getServiceError()` Get serviceError
`String`	`getShopperLocale()` The shopperLocale value provided in the payment request.
`int`	`hashCode()`
`PaymentResultResponse`	`merchantReference(String merchantReference)`
`PaymentResultResponse`	`paymentMethod(String paymentMethod)`
`PaymentResultResponse`	`pspReference(String pspReference)`
`PaymentResultResponse`	`putAdditionalDataItem(String key, String additionalDataItem)`
`PaymentResultResponse`	`refusalReason(String refusalReason)`
`PaymentResultResponse`	`resultCode(PaymentResultResponse.ResultCodeEnum resultCode)`
`PaymentResultResponse`	`serviceError(ServiceError serviceError)`
`void`	`setAdditionalData(Map<String,String> additionalData)`
`void`	`setAuthResponse(String authResponse)`
`void`	`setFraudResult(FraudResult fraudResult)`
`void`	`setMerchantReference(String merchantReference)`
`void`	`setPaymentMethod(String paymentMethod)`
`void`	`setPspReference(String pspReference)`
`void`	`setRefusalReason(String refusalReason)`
`void`	`setRefusalReasonCode(String refusalReasonCode)`
`void`	`setResultCode(PaymentResultResponse.ResultCodeEnum resultCode)`
`void`	`setServiceError(ServiceError serviceError)`
`void`	`setShopperLocale(String shopperLocale)`
`PaymentResultResponse`	`shopperLocale(String shopperLocale)`
`String`	`toString()`

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

- Constructor Detail
  - PaymentResultResponse
```
public PaymentResultResponse()
```
- Method Detail
  - getRefusalReasonCode
```
public String getRefusalReasonCode()
```
  - setRefusalReasonCode
```
public void setRefusalReasonCode(String refusalReasonCode)
```
  - additionalData
```
public PaymentResultResponse additionalData(Map<String,String> additionalData)
```
  - putAdditionalDataItem
```
public PaymentResultResponse 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)
```
  - authResponse
```
public PaymentResultResponse authResponse(String authResponse)
```
  - getAuthResponse
```
public String getAuthResponse()
```
    The authorisation code representing the authentication result. Possible values: * Received * Authorised * Error * Refused * Cancelled * Unknown
    
    Returns:
    
    authResponse
  - setAuthResponse
```
public void setAuthResponse(String authResponse)
```
  - getFraudResult
```
public FraudResult getFraudResult()
```
    Get fraudResult
    
    Returns:
    
    fraudResult
  - setFraudResult
```
public void setFraudResult(FraudResult fraudResult)
```
  - merchantReference
```
public PaymentResultResponse merchantReference(String merchantReference)
```
  - getMerchantReference
```
public String getMerchantReference()
```
    A unique value that you provided in the initial `/paymentSession` request as a `reference` field.
    
    Returns:
    
    merchantReference
  - setMerchantReference
```
public void setMerchantReference(String merchantReference)
```
  - paymentMethod
```
public PaymentResultResponse paymentMethod(String paymentMethod)
```
  - getPaymentMethod
```
public String getPaymentMethod()
```
    The payment method used in the transaction.
    
    Returns:
    
    paymentMethod
  - setPaymentMethod
```
public void setPaymentMethod(String paymentMethod)
```
  - pspReference
```
public PaymentResultResponse 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 PaymentResultResponse 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)
```
  - resultCode
```
public PaymentResultResponse resultCode(PaymentResultResponse.ResultCodeEnum resultCode)
```
  - getResultCode
```
public PaymentResultResponse.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(PaymentResultResponse.ResultCodeEnum resultCode)
```
  - serviceError
```
public PaymentResultResponse serviceError(ServiceError serviceError)
```
  - getServiceError
```
public ServiceError getServiceError()
```
    Get serviceError
    
    Returns:
    
    serviceError
  - setServiceError
```
public void setServiceError(ServiceError serviceError)
```
  - shopperLocale
```
public PaymentResultResponse shopperLocale(String shopperLocale)
```
  - getShopperLocale
```
public String getShopperLocale()
```
    The shopperLocale value provided in the payment request.
    
    Returns:
    
    shopperLocale
  - setShopperLocale
```
public void setShopperLocale(String shopperLocale)
```
  - 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 PaymentResultResponse

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PaymentResultResponse

Method Detail

getRefusalReasonCode

setRefusalReasonCode

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

authResponse

getAuthResponse

setAuthResponse

getFraudResult

setFraudResult

merchantReference

getMerchantReference

setMerchantReference

paymentMethod

getPaymentMethod

setPaymentMethod

pspReference

getPspReference

setPspReference

refusalReason

getRefusalReason

setRefusalReason

resultCode

getResultCode

setResultCode

serviceError

getServiceError

setServiceError

shopperLocale

getShopperLocale

setShopperLocale

equals

hashCode

toString