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

public class PaymentVerificationResponse
extends Object

PaymentVerificationResponse

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_ADDITIONAL_DATA`
`static String`	`SERIALIZED_NAME_FRAUD_RESULT`
`static String`	`SERIALIZED_NAME_MERCHANT_REFERENCE`
`static String`	`SERIALIZED_NAME_ORDER`
`static String`	`SERIALIZED_NAME_PSP_REFERENCE`
`static String`	`SERIALIZED_NAME_REFUSAL_REASON`
`static String`	`SERIALIZED_NAME_REFUSAL_REASON_CODE`
`static String`	`SERIALIZED_NAME_RESULT_CODE`
`static String`	`SERIALIZED_NAME_SERVICE_ERROR`
`static String`	`SERIALIZED_NAME_SHOPPER_LOCALE`

Constructor Summary

Constructors
Constructor Description

PaymentVerificationResponse()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PaymentVerificationResponse`	`additionalData(Map<String,String> additionalData)`
`boolean`	`equals(Object o)`
`PaymentVerificationResponse`	`fraudResult(FraudResult fraudResult)`
`static PaymentVerificationResponse`	`fromJson(String jsonString)`	Create an instance of PaymentVerificationResponse given an JSON string
`Map<String,String>`	`getAdditionalData()`	Contains additional information about the payment.
`FraudResult`	`getFraudResult()`	Get fraudResult
`String`	`getMerchantReference()`	A unique value that you provided in the initial `/paymentSession` request as a `reference` field.
`CheckoutOrderResponse`	`getOrder()`	Get order
`String`	`getPspReference()`	Adyen's 16-character reference associated with the transaction/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()`	Code that specifies the refusal reason.
`PaymentVerificationResponse.ResultCodeEnum`	`getResultCode()`	The result of the payment.
`ServiceError2`	`getServiceError()`	Get serviceError
`String`	`getShopperLocale()`	The shopperLocale value provided in the payment request.
`int`	`hashCode()`
`PaymentVerificationResponse`	`merchantReference(String merchantReference)`
`PaymentVerificationResponse`	`order(CheckoutOrderResponse order)`
`PaymentVerificationResponse`	`pspReference(String pspReference)`
`PaymentVerificationResponse`	`putAdditionalDataItem(String key, String additionalDataItem)`
`PaymentVerificationResponse`	`refusalReason(String refusalReason)`
`PaymentVerificationResponse`	`refusalReasonCode(String refusalReasonCode)`
`PaymentVerificationResponse`	`resultCode(PaymentVerificationResponse.ResultCodeEnum resultCode)`
`PaymentVerificationResponse`	`serviceError(ServiceError2 serviceError)`
`void`	`setAdditionalData(Map<String,String> additionalData)`
`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(PaymentVerificationResponse.ResultCodeEnum resultCode)`
`void`	`setServiceError(ServiceError2 serviceError)`
`void`	`setShopperLocale(String shopperLocale)`
`PaymentVerificationResponse`	`shopperLocale(String shopperLocale)`
`String`	`toJson()`	Convert an instance of PaymentVerificationResponse to an JSON string
`String`	`toString()`
`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_ADDITIONAL_DATA
```
public static final String SERIALIZED_NAME_ADDITIONAL_DATA
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FRAUD_RESULT
```
public static final String SERIALIZED_NAME_FRAUD_RESULT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MERCHANT_REFERENCE
```
public static final String SERIALIZED_NAME_MERCHANT_REFERENCE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ORDER
```
public static final String SERIALIZED_NAME_ORDER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PSP_REFERENCE
```
public static final String SERIALIZED_NAME_PSP_REFERENCE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REFUSAL_REASON
```
public static final String SERIALIZED_NAME_REFUSAL_REASON
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REFUSAL_REASON_CODE
```
public static final String SERIALIZED_NAME_REFUSAL_REASON_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_RESULT_CODE
```
public static final String SERIALIZED_NAME_RESULT_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SERVICE_ERROR
```
public static final String SERIALIZED_NAME_SERVICE_ERROR
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SHOPPER_LOCALE
```
public static final String SERIALIZED_NAME_SHOPPER_LOCALE
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - PaymentVerificationResponse
```
public PaymentVerificationResponse()
```
- Method Detail
  - additionalData
```
public PaymentVerificationResponse additionalData(Map<String,String> additionalData)
```
  - putAdditionalDataItem
```
public PaymentVerificationResponse putAdditionalDataItem(String key,
                                                         String additionalDataItem)
```
  - getAdditionalData
```
public Map<String,String> getAdditionalData()
```
    Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.
    
    Returns:
    
    additionalData
  - setAdditionalData
```
public void setAdditionalData(Map<String,String> additionalData)
```
  - fraudResult
```
public PaymentVerificationResponse fraudResult(FraudResult fraudResult)
```
  - getFraudResult
```
public FraudResult getFraudResult()
```
    Get fraudResult
    
    Returns:
    
    fraudResult
  - setFraudResult
```
public void setFraudResult(FraudResult fraudResult)
```
  - merchantReference
```
public PaymentVerificationResponse 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)
```
  - order
```
public PaymentVerificationResponse order(CheckoutOrderResponse order)
```
  - getOrder
```
public CheckoutOrderResponse getOrder()
```
    Get order
    
    Returns:
    
    order
  - setOrder
```
public void setOrder(CheckoutOrderResponse order)
```
  - pspReference
```
public PaymentVerificationResponse pspReference(String pspReference)
```
  - getPspReference
```
public String getPspReference()
```
    Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
    
    Returns:
    
    pspReference
  - setPspReference
```
public void setPspReference(String pspReference)
```
  - refusalReason
```
public PaymentVerificationResponse 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. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
    
    Returns:
    
    refusalReason
  - setRefusalReason
```
public void setRefusalReason(String refusalReason)
```
  - refusalReasonCode
```
public PaymentVerificationResponse refusalReasonCode(String refusalReasonCode)
```
  - getRefusalReasonCode
```
public String getRefusalReasonCode()
```
    Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
    
    Returns:
    
    refusalReasonCode
  - setRefusalReasonCode
```
public void setRefusalReasonCode(String refusalReasonCode)
```
  - resultCode
```
public PaymentVerificationResponse resultCode(PaymentVerificationResponse.ResultCodeEnum resultCode)
```
  - getResultCode
```
public PaymentVerificationResponse.ResultCodeEnum getResultCode()
```
    The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **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. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.
    
    Returns:
    
    resultCode
  - setResultCode
```
public void setResultCode(PaymentVerificationResponse.ResultCodeEnum resultCode)
```
  - serviceError
```
public PaymentVerificationResponse serviceError(ServiceError2 serviceError)
```
  - getServiceError
```
public ServiceError2 getServiceError()
```
    Get serviceError
    
    Returns:
    
    serviceError
  - setServiceError
```
public void setServiceError(ServiceError2 serviceError)
```
  - shopperLocale
```
public PaymentVerificationResponse 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
  - 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 PaymentVerificationResponse
  - fromJson
```
public static PaymentVerificationResponse fromJson(String jsonString)
                                            throws IOException
```
    Create an instance of PaymentVerificationResponse given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PaymentVerificationResponse
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to PaymentVerificationResponse
  - toJson
```
public String toJson()
```
    Convert an instance of PaymentVerificationResponse to an JSON string
    
    Returns:
    
    JSON string

Class PaymentVerificationResponse

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ADDITIONAL_DATA

SERIALIZED_NAME_FRAUD_RESULT

SERIALIZED_NAME_MERCHANT_REFERENCE

SERIALIZED_NAME_ORDER

SERIALIZED_NAME_PSP_REFERENCE

SERIALIZED_NAME_REFUSAL_REASON

SERIALIZED_NAME_REFUSAL_REASON_CODE

SERIALIZED_NAME_RESULT_CODE

SERIALIZED_NAME_SERVICE_ERROR

SERIALIZED_NAME_SHOPPER_LOCALE

openapiFields

openapiRequiredFields

Constructor Detail

PaymentVerificationResponse

Method Detail

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

fraudResult

getFraudResult

setFraudResult

merchantReference

getMerchantReference

setMerchantReference

order

getOrder

setOrder

pspReference

getPspReference

setPspReference

refusalReason

getRefusalReason

setRefusalReason

refusalReasonCode

getRefusalReasonCode

setRefusalReasonCode

resultCode

getResultCode

setResultCode

serviceError

getServiceError

setServiceError

shopperLocale

getShopperLocale

setShopperLocale

equals

hashCode

toString

validateJsonObject

fromJson

toJson