PaymentsResponse (Adyen Java API Library 2.6.0 API)

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

public class PaymentsResponse
extends Object

PaymentsResponse

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PaymentsResponse.ResultCodeEnum
The result of the payment.

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

Constructor Summary

Constructors
Constructor and Description

PaymentsResponse()

Constructors
Constructor and Description
`PaymentsResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PaymentsResponse`	`action(CheckoutPaymentsAction action)`
`PaymentsResponse`	`addDetailsItem(InputDetail detailsItem)`
`PaymentsResponse`	`additionalData(Map<String,String> additionalData)`
`PaymentsResponse`	`details(List<InputDetail> details)`
`boolean`	`equals(Object o)`
`PaymentsResponse`	`fraudResult(FraudResult fraudResult)`
`boolean`	`get3DAuthenticated()`
`boolean`	`get3DOffered()`
`CheckoutPaymentsAction`	`getAction()` Action to be taken for completing the payment.
`Map<String,String>`	`getAdditionalData()` This field contains additional data, which may be required to return in a particular payment response.
`String`	`getAdditionalDataByKey(String key)`
`String`	`getAuthCode()`
`Map<String,String>`	`getAuthentication()`
`PaymentsResponse.ResultCodeEnum`	`getAuthResponse()`
`String`	`getAvsResult()`
`String`	`getBoletoBarCodeReference()`
`String`	`getBoletoData()`
`Date`	`getBoletoDueDate()`
`Date`	`getBoletoExpirationDate()`
`String`	`getBoletoUrl()`
`String`	`getCardBin()`
`String`	`getCardHolderName()`
`String`	`getCardSummary()`
`List<InputDetail>`	`getDetails()` When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.
`Date`	`getExpiryDate()`
`FraudResult`	`getFraudResult()` Get fraudResult
`String`	`getMerchantReference()`
`BigDecimal`	`getMultibancoAmount()`
`String`	`getMultibancoDeadline()`
`String`	`getMultibancoEntity()`
`String`	`getMultibancoReference()`
`String`	`getOutputDetailDataByKey(String key)`
`Map<String,String>`	`getOutputDetails()`
`String`	`getPaymentData()` When non-empty, contains a value that you must submit to the `/payments/details` endpoint.
`String`	`getPaymentMethod()`
`String`	`getPspReference()` Adyen's 16-digit unique reference associated with the transaction/the request.
`Redirect`	`getRedirect()` Get redirect
`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()`
`PaymentsResponse`	`paymentData(String paymentData)`
`PaymentsResponse`	`pspReference(String pspReference)`
`PaymentsResponse`	`putAdditionalDataItem(String key, String additionalDataItem)`
`PaymentsResponse`	`redirect(Redirect redirect)`
`PaymentsResponse`	`refusalReason(String refusalReason)`
`PaymentsResponse`	`resultCode(PaymentsResponse.ResultCodeEnum resultCode)`
`void`	`setAction(CheckoutPaymentsAction action)`
`void`	`setAdditionalData(Map<String,String> additionalData)`
`void`	`setAuthentication(Map<String,String> authentication)`
`void`	`setAuthResponse(PaymentsResponse.ResultCodeEnum authResponse)`
`void`	`setDetails(List<InputDetail> details)`
`void`	`setFraudResult(FraudResult fraudResult)`
`void`	`setMerchantReference(String merchantReference)`
`void`	`setOutputDetails(Map<String,String> outputDetails)`
`void`	`setPaymentData(String paymentData)`
`void`	`setPspReference(String pspReference)`
`void`	`setRedirect(Redirect redirect)`
`void`	`setRefusalReason(String refusalReason)`
`void`	`setRefusalReasonCode(String refusalReasonCode)`
`void`	`setResultCode(PaymentsResponse.ResultCodeEnum resultCode)`
`void`	`setServiceError(ServiceError serviceError)`
`void`	`setThreeDS2Result(ThreeDS2Result threeDS2Result)`
`PaymentsResponse`	`threeDS2Result(ThreeDS2Result threeDS2Result)`
`String`	`toString()`

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

- Constructor Detail
  - PaymentsResponse
```
public PaymentsResponse()
```
- Method Detail
  - additionalData
```
public PaymentsResponse additionalData(Map<String,String> additionalData)
```
  - putAdditionalDataItem
```
public PaymentsResponse 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)
```
  - details
```
public PaymentsResponse details(List<InputDetail> details)
```
  - addDetailsItem
```
public PaymentsResponse addDetailsItem(InputDetail detailsItem)
```
  - getOutputDetailDataByKey
```
public String getOutputDetailDataByKey(String key)
```
  - getDetails
```
public List<InputDetail> getDetails()
```
    When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.
    
    Returns:
    
    details
  - setDetails
```
public void setDetails(List<InputDetail> details)
```
  - fraudResult
```
public PaymentsResponse fraudResult(FraudResult fraudResult)
```
  - getFraudResult
```
public FraudResult getFraudResult()
```
    Get fraudResult
    
    Returns:
    
    fraudResult
  - setFraudResult
```
public void setFraudResult(FraudResult fraudResult)
```
  - paymentData
```
public PaymentsResponse paymentData(String paymentData)
```
  - getPaymentData
```
public String getPaymentData()
```
    When non-empty, contains a value that you must submit to the `/payments/details` endpoint.
    
    Returns:
    
    paymentData
  - setPaymentData
```
public void setPaymentData(String paymentData)
```
  - pspReference
```
public PaymentsResponse 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)
```
  - redirect
```
public PaymentsResponse redirect(Redirect redirect)
```
  - getRedirect
```
public Redirect getRedirect()
```
    Get redirect
    
    Returns:
    
    redirect
  - setRedirect
```
public void setRedirect(Redirect redirect)
```
  - refusalReason
```
public PaymentsResponse 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 PaymentsResponse resultCode(PaymentsResponse.ResultCodeEnum resultCode)
```
  - getRefusalReasonCode
```
public String getRefusalReasonCode()
```
  - setRefusalReasonCode
```
public void setRefusalReasonCode(String refusalReasonCode)
```
  - 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)
```
  - getOutputDetails
```
public Map<String,String> getOutputDetails()
```
  - setOutputDetails
```
public void setOutputDetails(Map<String,String> outputDetails)
```
  - getThreeDS2Result
```
public ThreeDS2Result getThreeDS2Result()
```
    Result of the 3D Secure 2 authentication.
    
    Returns:
    
    threeDS2Result
  - setThreeDS2Result
```
public void setThreeDS2Result(ThreeDS2Result threeDS2Result)
```
  - threeDS2Result
```
public PaymentsResponse threeDS2Result(ThreeDS2Result threeDS2Result)
```
  - getAction
```
public CheckoutPaymentsAction getAction()
```
    Action to be taken for completing the payment.
    
    Returns:
    
    action
  - setAction
```
public void setAction(CheckoutPaymentsAction action)
```
  - action
```
public PaymentsResponse action(CheckoutPaymentsAction action)
```
  - 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()
```
  - getBoletoBarCodeReference
```
public String getBoletoBarCodeReference()
```
  - getBoletoData
```
public String getBoletoData()
```
  - getAuthCode
```
public String getAuthCode()
```
  - getAuthentication
```
public Map<String,String> getAuthentication()
```
  - setAuthentication
```
public void setAuthentication(Map<String,String> authentication)
```
  - getBoletoDueDate
```
public Date getBoletoDueDate()
```
  - getBoletoExpirationDate
```
public Date getBoletoExpirationDate()
```
  - getBoletoUrl
```
public String getBoletoUrl()
```
  - getExpiryDate
```
public Date getExpiryDate()
```
  - getMultibancoEntity
```
public String getMultibancoEntity()
```
  - getMultibancoAmount
```
public BigDecimal getMultibancoAmount()
```
  - getMultibancoDeadline
```
public String getMultibancoDeadline()
```
  - getMultibancoReference
```
public String getMultibancoReference()
```

Class PaymentsResponse

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PaymentsResponse

Method Detail

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

getAdditionalDataByKey

details

addDetailsItem

getOutputDetailDataByKey

getDetails

setDetails

fraudResult

getFraudResult

setFraudResult

paymentData

getPaymentData

setPaymentData

pspReference

getPspReference

setPspReference

redirect

getRedirect

setRedirect

refusalReason

getRefusalReason

setRefusalReason

resultCode

getRefusalReasonCode

setRefusalReasonCode

getResultCode

setResultCode

getServiceError

setServiceError

getAuthResponse

setAuthResponse

getMerchantReference

setMerchantReference

getOutputDetails

setOutputDetails

getThreeDS2Result

setThreeDS2Result

threeDS2Result

getAction

setAction

action

equals

hashCode

toString

getCardBin

getCardHolderName

getCardSummary

getPaymentMethod

getAvsResult

get3DOffered

get3DAuthenticated

getBoletoBarCodeReference

getBoletoData

getAuthCode

getAuthentication

setAuthentication

getBoletoDueDate

getBoletoExpirationDate

getBoletoUrl

getExpiryDate

getMultibancoEntity

getMultibancoAmount

getMultibancoDeadline

getMultibancoReference