Class SessionResultResponse


  • public class SessionResultResponse
    extends Object
    SessionResultResponse
    • Constructor Detail

      • SessionResultResponse

        public SessionResultResponse()
    • Method Detail

      • additionalData

        public SessionResultResponse additionalData​(Map<String,​String> additionalData)
        Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**.
        Parameters:
        additionalData - Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**.
        Returns:
        the current SessionResultResponse instance, allowing for method chaining
      • getAdditionalData

        public Map<String,​String> getAdditionalData()
        Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**.
        Returns:
        additionalData Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**.
      • setAdditionalData

        public void setAdditionalData​(Map<String,​String> additionalData)
        Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**.
        Parameters:
        additionalData - Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**.
      • id

        public SessionResultResponse id​(String id)
        A unique identifier of the session.
        Parameters:
        id - A unique identifier of the session.
        Returns:
        the current SessionResultResponse instance, allowing for method chaining
      • getId

        public String getId()
        A unique identifier of the session.
        Returns:
        id A unique identifier of the session.
      • setId

        public void setId​(String id)
        A unique identifier of the session.
        Parameters:
        id - A unique identifier of the session.
      • payments

        public SessionResultResponse payments​(List<Payment> payments)
        A list of all authorised payments done for this session.
        Parameters:
        payments - A list of all authorised payments done for this session.
        Returns:
        the current SessionResultResponse instance, allowing for method chaining
      • getPayments

        public List<Payment> getPayments()
        A list of all authorised payments done for this session.
        Returns:
        payments A list of all authorised payments done for this session.
      • setPayments

        public void setPayments​(List<Payment> payments)
        A list of all authorised payments done for this session.
        Parameters:
        payments - A list of all authorised payments done for this session.
      • reference

        public SessionResultResponse reference​(String reference)
        The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status.
        Parameters:
        reference - The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status.
        Returns:
        the current SessionResultResponse instance, allowing for method chaining
      • getReference

        public String getReference()
        The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status.
        Returns:
        reference The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status.
      • setReference

        public void setReference​(String reference)
        The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status.
        Parameters:
        reference - The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status.
      • status

        public SessionResultResponse status​(SessionResultResponse.StatusEnum status)
        The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.
        Parameters:
        status - The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.
        Returns:
        the current SessionResultResponse instance, allowing for method chaining
      • getStatus

        public SessionResultResponse.StatusEnum getStatus()
        The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.
        Returns:
        status The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.
      • setStatus

        public void setStatus​(SessionResultResponse.StatusEnum status)
        The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.
        Parameters:
        status - The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.
      • equals

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

        public int hashCode()
        Overrides:
        hashCode in class Object
      • fromJson

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

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