java.lang.Object
- com.adyen.model.payments.PaymentResult

public class PaymentResult
extends Object

PaymentResult

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PaymentResult.CustomTypeAdapterFactory

static class PaymentResult.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_AUTH_CODE`
`static String`	`SERIALIZED_NAME_DCC_AMOUNT`
`static String`	`SERIALIZED_NAME_DCC_SIGNATURE`
`static String`	`SERIALIZED_NAME_FRAUD_RESULT`
`static String`	`SERIALIZED_NAME_ISSUER_URL`
`static String`	`SERIALIZED_NAME_MD`
`static String`	`SERIALIZED_NAME_PA_REQUEST`
`static String`	`SERIALIZED_NAME_PSP_REFERENCE`
`static String`	`SERIALIZED_NAME_REFUSAL_REASON`
`static String`	`SERIALIZED_NAME_RESULT_CODE`

Constructor Summary

Constructors
Constructor Description

PaymentResult()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PaymentResult`	`additionalData(Map<String,String> additionalData)`
`PaymentResult`	`authCode(String authCode)`
`PaymentResult`	`dccAmount(Amount dccAmount)`
`PaymentResult`	`dccSignature(String dccSignature)`
`boolean`	`equals(Object o)`
`PaymentResult`	`fraudResult(FraudResult fraudResult)`
`static PaymentResult`	`fromJson(String jsonString)`	Create an instance of PaymentResult given an JSON string
`Map<String,String>`	`getAdditionalData()`	Contains additional information about the payment.
`String`	`getAuthCode()`	Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment.
`Amount`	`getDccAmount()`	Get dccAmount
`String`	`getDccSignature()`	Cryptographic signature used to verify `dccQuote`.
`FraudResult`	`getFraudResult()`	Get fraudResult
`String`	`getIssuerUrl()`	The URL to direct the shopper to.
`String`	`getMd()`	The payment session.
`String`	`getPaRequest()`	The 3D request data for the issuer.
`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.
`PaymentResult.ResultCodeEnum`	`getResultCode()`	The result of the payment.
`int`	`hashCode()`
`PaymentResult`	`issuerUrl(String issuerUrl)`
`PaymentResult`	`md(String md)`
`PaymentResult`	`paRequest(String paRequest)`
`PaymentResult`	`pspReference(String pspReference)`
`PaymentResult`	`putAdditionalDataItem(String key, String additionalDataItem)`
`PaymentResult`	`refusalReason(String refusalReason)`
`PaymentResult`	`resultCode(PaymentResult.ResultCodeEnum resultCode)`
`void`	`setAdditionalData(Map<String,String> additionalData)`
`void`	`setAuthCode(String authCode)`
`void`	`setDccAmount(Amount dccAmount)`
`void`	`setDccSignature(String dccSignature)`
`void`	`setFraudResult(FraudResult fraudResult)`
`void`	`setIssuerUrl(String issuerUrl)`
`void`	`setMd(String md)`
`void`	`setPaRequest(String paRequest)`
`void`	`setPspReference(String pspReference)`
`void`	`setRefusalReason(String refusalReason)`
`void`	`setResultCode(PaymentResult.ResultCodeEnum resultCode)`
`String`	`toJson()`	Convert an instance of PaymentResult 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_AUTH_CODE
```
public static final String SERIALIZED_NAME_AUTH_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DCC_AMOUNT
```
public static final String SERIALIZED_NAME_DCC_AMOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DCC_SIGNATURE
```
public static final String SERIALIZED_NAME_DCC_SIGNATURE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FRAUD_RESULT
```
public static final String SERIALIZED_NAME_FRAUD_RESULT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ISSUER_URL
```
public static final String SERIALIZED_NAME_ISSUER_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MD
```
public static final String SERIALIZED_NAME_MD
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PA_REQUEST
```
public static final String SERIALIZED_NAME_PA_REQUEST
```
    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_RESULT_CODE
```
public static final String SERIALIZED_NAME_RESULT_CODE
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - PaymentResult
```
public PaymentResult()
```
- Method Detail
  - additionalData
```
public PaymentResult additionalData(Map<String,String> additionalData)
```
  - putAdditionalDataItem
```
public PaymentResult 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)
```
  - authCode
```
public PaymentResult authCode(String authCode)
```
  - getAuthCode
```
public String getAuthCode()
```
    Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty.
    
    Returns:
    
    authCode
  - setAuthCode
```
public void setAuthCode(String authCode)
```
  - dccAmount
```
public PaymentResult dccAmount(Amount dccAmount)
```
  - getDccAmount
```
public Amount getDccAmount()
```
    Get dccAmount
    
    Returns:
    
    dccAmount
  - setDccAmount
```
public void setDccAmount(Amount dccAmount)
```
  - dccSignature
```
public PaymentResult dccSignature(String dccSignature)
```
  - getDccSignature
```
public String getDccSignature()
```
    Cryptographic signature used to verify `dccQuote`. > This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).
    
    Returns:
    
    dccSignature
  - setDccSignature
```
public void setDccSignature(String dccSignature)
```
  - fraudResult
```
public PaymentResult fraudResult(FraudResult fraudResult)
```
  - getFraudResult
```
public FraudResult getFraudResult()
```
    Get fraudResult
    
    Returns:
    
    fraudResult
  - setFraudResult
```
public void setFraudResult(FraudResult fraudResult)
```
  - issuerUrl
```
public PaymentResult issuerUrl(String issuerUrl)
```
  - getIssuerUrl
```
public String getIssuerUrl()
```
    The URL to direct the shopper to. > In case of SecurePlus, do not redirect a shopper to this URL.
    
    Returns:
    
    issuerUrl
  - setIssuerUrl
```
public void setIssuerUrl(String issuerUrl)
```
  - md
```
public PaymentResult md(String md)
```
  - getMd
```
public String getMd()
```
    The payment session.
    
    Returns:
    
    md
  - setMd
```
public void setMd(String md)
```
  - paRequest
```
public PaymentResult paRequest(String paRequest)
```
  - getPaRequest
```
public String getPaRequest()
```
    The 3D request data for the issuer. If the value is **CUPSecurePlus-CollectSMSVerificationCode**, collect an SMS code from the shopper and pass it in the `/authorise3D` request. For more information, see [3D Secure](https://docs.adyen.com/classic-integration/3d-secure).
    
    Returns:
    
    paRequest
  - setPaRequest
```
public void setPaRequest(String paRequest)
```
  - pspReference
```
public PaymentResult 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 PaymentResult 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)
```
  - resultCode
```
public PaymentResult resultCode(PaymentResult.ResultCodeEnum resultCode)
```
  - getResultCode
```
public PaymentResult.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(PaymentResult.ResultCodeEnum resultCode)
```
  - 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 PaymentResult
  - fromJson
```
public static PaymentResult fromJson(String jsonString)
                              throws IOException
```
    Create an instance of PaymentResult given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PaymentResult
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to PaymentResult
  - toJson
```
public String toJson()
```
    Convert an instance of PaymentResult to an JSON string
    
    Returns:
    
    JSON string

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

Class PaymentResult

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ADDITIONAL_DATA

SERIALIZED_NAME_AUTH_CODE

SERIALIZED_NAME_DCC_AMOUNT

SERIALIZED_NAME_DCC_SIGNATURE

SERIALIZED_NAME_FRAUD_RESULT

SERIALIZED_NAME_ISSUER_URL

SERIALIZED_NAME_MD

SERIALIZED_NAME_PA_REQUEST

SERIALIZED_NAME_PSP_REFERENCE

SERIALIZED_NAME_REFUSAL_REASON

SERIALIZED_NAME_RESULT_CODE

openapiFields

openapiRequiredFields

Constructor Detail

PaymentResult

Method Detail

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

authCode

getAuthCode

setAuthCode

dccAmount

getDccAmount

setDccAmount

dccSignature

getDccSignature

setDccSignature

fraudResult

getFraudResult

setFraudResult

issuerUrl

getIssuerUrl

setIssuerUrl

md

getMd

setMd

paRequest

getPaRequest

setPaRequest

pspReference

getPspReference

setPspReference

refusalReason

getRefusalReason

setRefusalReason

resultCode

getResultCode

setResultCode

equals

hashCode

toString

validateJsonObject

fromJson

toJson