Package com.adyen.model.tapi

Class PaymentResult

  • public class PaymentResult
extends Object
    PaymentResult

    • Constructor Detail

      • PaymentResult

        public PaymentResult()

    • Method Detail

      • paymentType

        public PaymentResult paymentType​(PaymentType paymentType)
        paymentType
        Parameters:
        paymentType -
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getPaymentType

        public PaymentType getPaymentType()
        Get paymentType
        Returns:
        paymentType

      • setPaymentType

        public void setPaymentType​(PaymentType paymentType)
        paymentType
        Parameters:
        paymentType -

      • paymentInstrumentData

        public PaymentResult paymentInstrumentData​(PaymentInstrumentData paymentInstrumentData)
        paymentInstrumentData
        Parameters:
        paymentInstrumentData -
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getPaymentInstrumentData

        public PaymentInstrumentData getPaymentInstrumentData()
        Get paymentInstrumentData
        Returns:
        paymentInstrumentData

      • setPaymentInstrumentData

        public void setPaymentInstrumentData​(PaymentInstrumentData paymentInstrumentData)
        paymentInstrumentData
        Parameters:
        paymentInstrumentData -

      • amountsResp

        public PaymentResult amountsResp​(AmountsResp amountsResp)
        amountsResp
        Parameters:
        amountsResp -
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getAmountsResp

        public AmountsResp getAmountsResp()
        Get amountsResp
        Returns:
        amountsResp

      • setAmountsResp

        public void setAmountsResp​(AmountsResp amountsResp)
        amountsResp
        Parameters:
        amountsResp -

      • instalment

        public PaymentResult instalment​(Instalment instalment)
        instalment
        Parameters:
        instalment -
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getInstalment

        public Instalment getInstalment()
        Get instalment
        Returns:
        instalment

      • setInstalment

        public void setInstalment​(Instalment instalment)
        instalment
        Parameters:
        instalment -

      • currencyConversion

        public PaymentResult currencyConversion​(List<CurrencyConversion> currencyConversion)
        Information related to a currency conversion. A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt).
        Parameters:
        currencyConversion - Information related to a currency conversion. A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt).
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getCurrencyConversion

        public List<CurrencyConversion> getCurrencyConversion()
        Information related to a currency conversion. A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt).
        Returns:
        currencyConversion Information related to a currency conversion. A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt).

      • setCurrencyConversion

        public void setCurrencyConversion​(List<CurrencyConversion> currencyConversion)
        Information related to a currency conversion. A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt).
        Parameters:
        currencyConversion - Information related to a currency conversion. A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt).

      • merchantOverrideFlag

        public PaymentResult merchantOverrideFlag​(Boolean merchantOverrideFlag)
        Indicates that the Merchant forced the result of the payment to successful. Allows the Sale System to be sure that the payment has been forced.
        Parameters:
        merchantOverrideFlag - Indicates that the Merchant forced the result of the payment to successful. Allows the Sale System to be sure that the payment has been forced.
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getMerchantOverrideFlag

        public Boolean getMerchantOverrideFlag()
        Indicates that the Merchant forced the result of the payment to successful. Allows the Sale System to be sure that the payment has been forced.
        Returns:
        merchantOverrideFlag Indicates that the Merchant forced the result of the payment to successful. Allows the Sale System to be sure that the payment has been forced.

      • setMerchantOverrideFlag

        public void setMerchantOverrideFlag​(Boolean merchantOverrideFlag)
        Indicates that the Merchant forced the result of the payment to successful. Allows the Sale System to be sure that the payment has been forced.
        Parameters:
        merchantOverrideFlag - Indicates that the Merchant forced the result of the payment to successful. Allows the Sale System to be sure that the payment has been forced.

      • capturedSignature

        public PaymentResult capturedSignature​(CapturedSignature capturedSignature)
        capturedSignature
        Parameters:
        capturedSignature -
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getCapturedSignature

        public CapturedSignature getCapturedSignature()
        Get capturedSignature
        Returns:
        capturedSignature

      • setCapturedSignature

        public void setCapturedSignature​(CapturedSignature capturedSignature)
        capturedSignature
        Parameters:
        capturedSignature -

      • protectedSignature

        public PaymentResult protectedSignature​(String protectedSignature)
        Numeric value of a handwritten signature. Contains the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. The format before encryption is the encoded data structure CapturedSignature. The data structure before encryption includes the start and end tags for an XML encoding, the identifier and length bytes for an ASN.1 encoding, and the complete member ProtectedSignature for a JSON encoding.
        Parameters:
        protectedSignature - Numeric value of a handwritten signature. Contains the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. The format before encryption is the encoded data structure CapturedSignature. The data structure before encryption includes the start and end tags for an XML encoding, the identifier and length bytes for an ASN.1 encoding, and the complete member ProtectedSignature for a JSON encoding.
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getProtectedSignature

        public String getProtectedSignature()
        Numeric value of a handwritten signature. Contains the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. The format before encryption is the encoded data structure CapturedSignature. The data structure before encryption includes the start and end tags for an XML encoding, the identifier and length bytes for an ASN.1 encoding, and the complete member ProtectedSignature for a JSON encoding.
        Returns:
        protectedSignature Numeric value of a handwritten signature. Contains the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. The format before encryption is the encoded data structure CapturedSignature. The data structure before encryption includes the start and end tags for an XML encoding, the identifier and length bytes for an ASN.1 encoding, and the complete member ProtectedSignature for a JSON encoding.

      • setProtectedSignature

        public void setProtectedSignature​(String protectedSignature)
        Numeric value of a handwritten signature. Contains the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. The format before encryption is the encoded data structure CapturedSignature. The data structure before encryption includes the start and end tags for an XML encoding, the identifier and length bytes for an ASN.1 encoding, and the complete member ProtectedSignature for a JSON encoding.
        Parameters:
        protectedSignature - Numeric value of a handwritten signature. Contains the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. The format before encryption is the encoded data structure CapturedSignature. The data structure before encryption includes the start and end tags for an XML encoding, the identifier and length bytes for an ASN.1 encoding, and the complete member ProtectedSignature for a JSON encoding.

      • customerLanguage

        public PaymentResult customerLanguage​(String customerLanguage)
        The language of the customer that was used on the terminal screen or in text printed by the terminal. Format: two-character [ISO 639:2023](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
        Parameters:
        customerLanguage - The language of the customer that was used on the terminal screen or in text printed by the terminal. Format: two-character [ISO 639:2023](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getCustomerLanguage

        public String getCustomerLanguage()
        The language of the customer that was used on the terminal screen or in text printed by the terminal. Format: two-character [ISO 639:2023](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
        Returns:
        customerLanguage The language of the customer that was used on the terminal screen or in text printed by the terminal. Format: two-character [ISO 639:2023](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.

      • setCustomerLanguage

        public void setCustomerLanguage​(String customerLanguage)
        The language of the customer that was used on the terminal screen or in text printed by the terminal. Format: two-character [ISO 639:2023](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
        Parameters:
        customerLanguage - The language of the customer that was used on the terminal screen or in text printed by the terminal. Format: two-character [ISO 639:2023](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.

      • onlineFlag

        public PaymentResult onlineFlag​(Boolean onlineFlag)
        Indicate that the payment transaction processing has required the approval of a host. Allows the Sale System to know if the payment was online or offline.
        Parameters:
        onlineFlag - Indicate that the payment transaction processing has required the approval of a host. Allows the Sale System to know if the payment was online or offline.
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getOnlineFlag

        public Boolean getOnlineFlag()
        Indicate that the payment transaction processing has required the approval of a host. Allows the Sale System to know if the payment was online or offline.
        Returns:
        onlineFlag Indicate that the payment transaction processing has required the approval of a host. Allows the Sale System to know if the payment was online or offline.

      • setOnlineFlag

        public void setOnlineFlag​(Boolean onlineFlag)
        Indicate that the payment transaction processing has required the approval of a host. Allows the Sale System to know if the payment was online or offline.
        Parameters:
        onlineFlag - Indicate that the payment transaction processing has required the approval of a host. Allows the Sale System to know if the payment was online or offline.

      • authenticationMethod

        public PaymentResult authenticationMethod​(List<PaymentResult.AuthenticationMethodEnum> authenticationMethod)
        Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction. Possible values: * **Bypass** * **ManualVerification** * **MerchantAuthentication** * **OfflinePIN** * **OnlinePIN** * **PaperSignature** * **SecureCertificate** * **SecureNoCertificate** * **SecuredChannel** * **SignatureCapture** * **UnknownMethod**
        Parameters:
        authenticationMethod - Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction. Possible values: * **Bypass** * **ManualVerification** * **MerchantAuthentication** * **OfflinePIN** * **OnlinePIN** * **PaperSignature** * **SecureCertificate** * **SecureNoCertificate** * **SecuredChannel** * **SignatureCapture** * **UnknownMethod**
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getAuthenticationMethod

        public List<PaymentResult.AuthenticationMethodEnum> getAuthenticationMethod()
        Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction. Possible values: * **Bypass** * **ManualVerification** * **MerchantAuthentication** * **OfflinePIN** * **OnlinePIN** * **PaperSignature** * **SecureCertificate** * **SecureNoCertificate** * **SecuredChannel** * **SignatureCapture** * **UnknownMethod**
        Returns:
        authenticationMethod Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction. Possible values: * **Bypass** * **ManualVerification** * **MerchantAuthentication** * **OfflinePIN** * **OnlinePIN** * **PaperSignature** * **SecureCertificate** * **SecureNoCertificate** * **SecuredChannel** * **SignatureCapture** * **UnknownMethod**

      • setAuthenticationMethod

        public void setAuthenticationMethod​(List<PaymentResult.AuthenticationMethodEnum> authenticationMethod)
        Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction. Possible values: * **Bypass** * **ManualVerification** * **MerchantAuthentication** * **OfflinePIN** * **OnlinePIN** * **PaperSignature** * **SecureCertificate** * **SecureNoCertificate** * **SecuredChannel** * **SignatureCapture** * **UnknownMethod**
        Parameters:
        authenticationMethod - Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction. Possible values: * **Bypass** * **ManualVerification** * **MerchantAuthentication** * **OfflinePIN** * **OnlinePIN** * **PaperSignature** * **SecureCertificate** * **SecureNoCertificate** * **SecuredChannel** * **SignatureCapture** * **UnknownMethod**

      • validityDate

        public PaymentResult validityDate​(LocalDate validityDate)
        End of the validity period for the reservation, for the first reservation, and the reservation updates as well.
        Parameters:
        validityDate - End of the validity period for the reservation, for the first reservation, and the reservation updates as well.
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getValidityDate

        public LocalDate getValidityDate()
        End of the validity period for the reservation, for the first reservation, and the reservation updates as well.
        Returns:
        validityDate End of the validity period for the reservation, for the first reservation, and the reservation updates as well.

      • setValidityDate

        public void setValidityDate​(LocalDate validityDate)
        End of the validity period for the reservation, for the first reservation, and the reservation updates as well.
        Parameters:
        validityDate - End of the validity period for the reservation, for the first reservation, and the reservation updates as well.

      • paymentAcquirerData

        public PaymentResult paymentAcquirerData​(PaymentAcquirerData paymentAcquirerData)
        paymentAcquirerData
        Parameters:
        paymentAcquirerData -
        Returns:
        the current PaymentResult instance, allowing for method chaining

      • getPaymentAcquirerData

        public PaymentAcquirerData getPaymentAcquirerData()
        Get paymentAcquirerData
        Returns:
        paymentAcquirerData

      • setPaymentAcquirerData

        public void setPaymentAcquirerData​(PaymentAcquirerData paymentAcquirerData)
        paymentAcquirerData
        Parameters:
        paymentAcquirerData -

      • includeNullValues

        public PaymentResult includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.

      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.

      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.

      • equals

        public boolean equals​(Object o)
        Return true if this PaymentResult object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.

      • fromJson

        public static PaymentResult fromJson​(String jsonString)
                              throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of PaymentResult given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of PaymentResult
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PaymentResult

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of PaymentResult to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException