com.adyen.model.checkout.PaymentsResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of adyen-java-api-library Show documentation
Show all versions of adyen-java-api-library Show documentation
Adyen API Client Library for Java
/*
* ######
* ######
* ############ ####( ###### #####. ###### ############ ############
* ############# #####( ###### #####. ###### ############# #############
* ###### #####( ###### #####. ###### ##### ###### ##### ######
* ###### ###### #####( ###### #####. ###### ##### ##### ##### ######
* ###### ###### #####( ###### #####. ###### ##### ##### ######
* ############# ############# ############# ############# ##### ######
* ############ ############ ############# ############ ##### ######
* ######
* #############
* ############
*
* Adyen Java API Library
*
* Copyright (c) 2018 Adyen B.V.
* This file is open source and available under the MIT license.
* See the LICENSE file for more info.
*/
package com.adyen.model.checkout;
import com.adyen.Util.DateUtil;
import com.adyen.model.FraudResult;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import static com.adyen.constants.ApiConstants.AdditionalData.AUTH_CODE;
import static com.adyen.constants.ApiConstants.AdditionalData.AVS_RESULT;
import static com.adyen.constants.ApiConstants.AdditionalData.BOLETO_BARCODE_REFERENCE;
import static com.adyen.constants.ApiConstants.AdditionalData.BOLETO_DATA;
import static com.adyen.constants.ApiConstants.AdditionalData.BOLETO_DUE_DATE;
import static com.adyen.constants.ApiConstants.AdditionalData.BOLETO_EXPIRATION_DATE;
import static com.adyen.constants.ApiConstants.AdditionalData.BOLETO_URL;
import static com.adyen.constants.ApiConstants.AdditionalData.CARD_BIN;
import static com.adyen.constants.ApiConstants.AdditionalData.CARD_HOLDER_NAME;
import static com.adyen.constants.ApiConstants.AdditionalData.CARD_SUMMARY;
import static com.adyen.constants.ApiConstants.AdditionalData.EXPIRY_DATE;
import static com.adyen.constants.ApiConstants.AdditionalData.MULTIBANCO_AMOUNT;
import static com.adyen.constants.ApiConstants.AdditionalData.MULTIBANCO_DEADLINE;
import static com.adyen.constants.ApiConstants.AdditionalData.MULTIBANCO_ENTITY;
import static com.adyen.constants.ApiConstants.AdditionalData.MULTIBANCO_REFERENCE;
import static com.adyen.constants.ApiConstants.AdditionalData.PAYMENT_METHOD;
import static com.adyen.constants.ApiConstants.AdditionalData.THREE_D_AUTHENTICATED;
import static com.adyen.constants.ApiConstants.AdditionalData.THREE_D_OFFERERED;
/**
* PaymentsResponse
*/
public class PaymentsResponse {
@SerializedName("additionalData")
private Map additionalData = null;
@SerializedName("details")
private List details = null;
@SerializedName("fraudResult")
private FraudResult fraudResult = null;
@SerializedName("paymentData")
private String paymentData = null;
@SerializedName("pspReference")
private String pspReference = null;
@SerializedName("redirect")
private Redirect redirect = null;
@SerializedName("refusalReason")
private String refusalReason = null;
@SerializedName("refusalReasonCode")
private String refusalReasonCode = null;
@SerializedName("resultCode")
private ResultCodeEnum resultCode = null;
@SerializedName("serviceError")
private ServiceError serviceError;
@SerializedName("authResponse")
private ResultCodeEnum authResponse;
@SerializedName("merchantReference")
private String merchantReference;
@SerializedName("outputDetails")
private Map outputDetails;
@SerializedName("authentication")
private Map authentication;
@SerializedName("threeDS2Result")
private ThreeDS2Result threeDS2Result;
@SerializedName("action")
private CheckoutPaymentsAction action;
public PaymentsResponse additionalData(Map additionalData) {
this.additionalData = additionalData;
return this;
}
public PaymentsResponse putAdditionalDataItem(String key, String additionalDataItem) {
if (this.additionalData == null) {
this.additionalData = new HashMap<>();
}
this.additionalData.put(key, additionalDataItem);
return this;
}
/**
* 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**.
*
* @return additionalData
**/
public Map getAdditionalData() {
return additionalData;
}
public void setAdditionalData(Map additionalData) {
this.additionalData = additionalData;
}
public String getAdditionalDataByKey(String key) {
if (additionalData == null) {
return null;
}
return additionalData.get(key);
}
public PaymentsResponse details(List details) {
this.details = details;
return this;
}
public PaymentsResponse addDetailsItem(InputDetail detailsItem) {
if (this.details == null) {
this.details = new ArrayList();
}
this.details.add(detailsItem);
return this;
}
public String getOutputDetailDataByKey(String key) {
if (outputDetails == null) {
return null;
}
return outputDetails.get(key);
}
/**
* When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.
*
* @return details
**/
public List getDetails() {
return details;
}
public void setDetails(List details) {
this.details = details;
}
public PaymentsResponse fraudResult(FraudResult fraudResult) {
this.fraudResult = fraudResult;
return this;
}
/**
* Get fraudResult
*
* @return fraudResult
**/
public FraudResult getFraudResult() {
return fraudResult;
}
public void setFraudResult(FraudResult fraudResult) {
this.fraudResult = fraudResult;
}
public PaymentsResponse paymentData(String paymentData) {
this.paymentData = paymentData;
return this;
}
/**
* When non-empty, contains a value that you must submit to the `/payments/details` endpoint.
*
* @return paymentData
**/
public String getPaymentData() {
return paymentData;
}
public void setPaymentData(String paymentData) {
this.paymentData = paymentData;
}
public PaymentsResponse pspReference(String pspReference) {
this.pspReference = pspReference;
return this;
}
/**
* 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.
*
* @return pspReference
**/
public String getPspReference() {
return pspReference;
}
public void setPspReference(String pspReference) {
this.pspReference = pspReference;
}
public PaymentsResponse redirect(Redirect redirect) {
this.redirect = redirect;
return this;
}
/**
* Get redirect
*
* @return redirect
**/
public Redirect getRedirect() {
return redirect;
}
public void setRedirect(Redirect redirect) {
this.redirect = redirect;
}
public PaymentsResponse refusalReason(String refusalReason) {
this.refusalReason = refusalReason;
return this;
}
/**
* 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.
*
* @return refusalReason
**/
public String getRefusalReason() {
return refusalReason;
}
public void setRefusalReason(String refusalReason) {
this.refusalReason = refusalReason;
}
public PaymentsResponse resultCode(ResultCodeEnum resultCode) {
this.resultCode = resultCode;
return this;
}
public String getRefusalReasonCode() {
return refusalReasonCode;
}
public void setRefusalReasonCode(String refusalReasonCode) {
this.refusalReasonCode = refusalReasonCode;
}
/**
* 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.
*
* @return resultCode
**/
public ResultCodeEnum getResultCode() {
return resultCode;
}
public void setResultCode(ResultCodeEnum resultCode) {
this.resultCode = resultCode;
}
public ServiceError getServiceError() {
return serviceError;
}
public void setServiceError(ServiceError serviceError) {
this.serviceError = serviceError;
}
public ResultCodeEnum getAuthResponse() {
return authResponse;
}
public void setAuthResponse(ResultCodeEnum authResponse) {
this.authResponse = authResponse;
}
public String getMerchantReference() {
return merchantReference;
}
public void setMerchantReference(String merchantReference) {
this.merchantReference = merchantReference;
}
public Map getOutputDetails() {
return outputDetails;
}
public void setOutputDetails(Map outputDetails) {
this.outputDetails = outputDetails;
}
/**
* Result of the 3D Secure 2 authentication.
*
* @return threeDS2Result
**/
public ThreeDS2Result getThreeDS2Result() {
return threeDS2Result;
}
public void setThreeDS2Result(ThreeDS2Result threeDS2Result) {
this.threeDS2Result = threeDS2Result;
}
public PaymentsResponse threeDS2Result(ThreeDS2Result threeDS2Result) {
this.threeDS2Result = threeDS2Result;
return this;
}
/**
* Action to be taken for completing the payment.
*
* @return action
**/
public CheckoutPaymentsAction getAction() {
return action;
}
public void setAction(CheckoutPaymentsAction action) {
this.action = action;
}
public PaymentsResponse action(CheckoutPaymentsAction action) {
this.action = action;
return this;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
PaymentsResponse paymentsResponse = (PaymentsResponse) o;
return Objects.equals(this.additionalData, paymentsResponse.additionalData)
&& Objects.equals(this.details, paymentsResponse.details)
&& Objects.equals(this.fraudResult,
paymentsResponse.fraudResult)
&& Objects.equals(this.paymentData, paymentsResponse.paymentData)
&& Objects.equals(this.pspReference, paymentsResponse.pspReference)
&& Objects.equals(this.redirect, paymentsResponse.redirect)
&& Objects.equals(this.refusalReason, paymentsResponse.refusalReason)
&& Objects.equals(this.refusalReasonCode, paymentsResponse.refusalReasonCode)
&& Objects.equals(this.resultCode, paymentsResponse.resultCode)
&& Objects.equals(this.serviceError, paymentsResponse.serviceError)
&& Objects.equals(this.authResponse, paymentsResponse.authResponse)
&& Objects.equals(this.merchantReference, paymentsResponse.merchantReference)
&& Objects.equals(this.outputDetails, paymentsResponse.outputDetails)
&& Objects.equals(this.authentication, paymentsResponse.authentication)
&& Objects.equals(this.threeDS2Result, paymentsResponse.threeDS2Result)
&& Objects.equals(this.action, paymentsResponse.action);
}
@Override
public int hashCode() {
return Objects.hash(additionalData, details, fraudResult, paymentData, pspReference, redirect, refusalReason, resultCode, serviceError, authResponse, merchantReference, outputDetails, authentication, threeDS2Result, action);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PaymentsResponse {\n");
sb.append(" additionalData: ").append(toIndentedString(additionalData)).append("\n");
sb.append(" details: ").append(toIndentedString(details)).append("\n");
sb.append(" fraudResult: ").append(toIndentedString(fraudResult)).append("\n");
sb.append(" paymentData: ").append(toIndentedString(paymentData)).append("\n");
sb.append(" pspReference: ").append(toIndentedString(pspReference)).append("\n");
sb.append(" redirect: ").append(toIndentedString(redirect)).append("\n");
sb.append(" refusalReason: ").append(toIndentedString(refusalReason)).append("\n");
sb.append(" refusalReasonCode: ").append(toIndentedString(refusalReasonCode)).append("\n");
sb.append(" resultCode: ").append(toIndentedString(resultCode)).append("\n");
sb.append(" serviceError: ").append(toIndentedString(serviceError)).append("\n");
sb.append(" authResponse: ").append(toIndentedString(authResponse)).append("\n");
sb.append(" merchantReference: ").append(toIndentedString(merchantReference)).append("\n");
sb.append(" outputDetails: ").append(toIndentedString(outputDetails)).append("\n");
sb.append(" authentication: ").append(toIndentedString(authentication)).append("\n");
sb.append(" threeDS2Result: ").append(toIndentedString(threeDS2Result)).append("\n");
sb.append(" action: ").append(toIndentedString(action)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
/**
* The result of the payment. Possible values:
* * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.
* * **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. For more information on handling a pending payment, refer to [Payments with pending status](https://docs.adyen.com/development-resources/payments-with-pending-status).
* * **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.
*/
@JsonAdapter(ResultCodeEnum.Adapter.class)
public enum ResultCodeEnum {
AUTHENTICATIONFINISHED("AuthenticationFinished"),
AUTHENTICATIONNOTREQUIRED("AuthenticationNotRequired"),
AUTHORISED("Authorised"),
CANCELLED("Cancelled"),
CHALLENGESHOPPER("ChallengeShopper"),
ERROR("Error"),
IDENTIFYSHOPPER("IdentifyShopper"),
PENDING("Pending"),
RECEIVED("Received"),
REDIRECTSHOPPER("RedirectShopper"),
REFUSED("Refused"),
PARTIALLYAUTHORISED("PartiallyAuthorised"),
PRESENTTOSHOPPER("PresentToShopper"),
UNKNOWN("Unknown"); //applicable for payments/details
private String value;
ResultCodeEnum(String value) {
this.value = value;
}
public static ResultCodeEnum fromValue(String text) {
for (ResultCodeEnum b : ResultCodeEnum.values()) {
if (String.valueOf(b.value).equals(text)) {
return b;
}
}
return null;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final ResultCodeEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public ResultCodeEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return ResultCodeEnum.fromValue(String.valueOf(value));
}
}
}
public String getCardBin() {
return getAdditionalDataByKey(CARD_BIN);
}
public String getCardHolderName() {
return getAdditionalDataByKey(CARD_HOLDER_NAME);
}
public String getCardSummary() {
return getAdditionalDataByKey(CARD_SUMMARY);
}
public String getPaymentMethod() {
return getAdditionalDataByKey(PAYMENT_METHOD);
}
public String getAvsResult() {
return getAdditionalDataByKey(AVS_RESULT);
}
public boolean get3DOffered() {
return String.valueOf("true").equals(getAdditionalDataByKey(THREE_D_OFFERERED));
}
public boolean get3DAuthenticated() {
return String.valueOf("true").equals(getAdditionalDataByKey(THREE_D_AUTHENTICATED));
}
public String getBoletoBarCodeReference() {
return getOutputDetailDataByKey(BOLETO_BARCODE_REFERENCE);
}
public String getBoletoData() {
return getOutputDetailDataByKey(BOLETO_DATA);
}
public String getAuthCode() {
return getAdditionalDataByKey(AUTH_CODE);
}
public Map getAuthentication() {
return authentication;
}
public void setAuthentication(Map authentication) {
this.authentication = authentication;
}
public Date getBoletoDueDate() {
String date = getOutputDetailDataByKey(BOLETO_DUE_DATE);
return DateUtil.parseYmdDate(date);
}
public Date getBoletoExpirationDate() {
String date = getOutputDetailDataByKey(BOLETO_EXPIRATION_DATE);
return DateUtil.parseYmdDate(date);
}
public String getBoletoUrl() {
return getOutputDetailDataByKey(BOLETO_URL);
}
public Date getExpiryDate() {
String expiryDate = getAdditionalDataByKey(EXPIRY_DATE);
return DateUtil.parseMYDate(expiryDate);
}
public String getMultibancoEntity() {
return getAdditionalDataByKey(MULTIBANCO_ENTITY);
}
public BigDecimal getMultibancoAmount() {
if (getAdditionalDataByKey(MULTIBANCO_AMOUNT) == null) {
return null;
}
return new BigDecimal(getAdditionalDataByKey(MULTIBANCO_AMOUNT));
}
public String getMultibancoDeadline() {
return getAdditionalDataByKey(MULTIBANCO_DEADLINE);
}
public String getMultibancoReference() {
return getAdditionalDataByKey(MULTIBANCO_REFERENCE);
}
}