Package com.orbipay.paymentsapi.internal.api

Class RefundApi

  • public class RefundApi
extends java.lang.Object

    This class subject to change without prior notice, Please dont use this class directly.

    • Constructor Summary

      Constructors 
      Constructor Description
      RefundApi​(ApiClient apiClient)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ApiResponse<RefundResponse> createRefund​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, CreateRefundRequest createRefundRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Create Refund This API is used to initiate a refund.
      com.squareup.okhttp.Call createRefundAsync​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, CreateRefundRequest createRefundRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<RefundResponse> callback)
      Create Refund (asynchronously) This API is used to initiate a refund.
      com.squareup.okhttp.Call createRefundCall​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, CreateRefundRequest createRefundRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for createRefund
      ApiResponse<RefundResponse> createRefundWithHttpInfo​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT, java.lang.String ID_CUSTOMER, CreateRefundRequest createRefundRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Create Refund This API is used to initiate a refund.
      ApiClient getApiClient()  
      ApiResponse<RefundResponse> getRefund​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_REFUND, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Get Refund The API is used to retrieve the details of a refund by id.
      com.squareup.okhttp.Call getRefundAsync​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_REFUND, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ApiCallback<RefundResponse> callback)
      Get Refund (asynchronously) The API is used to retrieve the details of a refund by id.
      com.squareup.okhttp.Call getRefundCall​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_REFUND, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for getRefund
      ApiResponse<RefundResponse> getRefundWithHttpInfo​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_REFUND, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
      Get Refund The API is used to retrieve the details of a refund by id.
      ApiResponse<RefundsResponse> retrieveRefunds​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String idCustomer, java.lang.String confirmationNumber, java.util.List<java.lang.String> status, java.lang.String fromDate, java.lang.String toDate, java.lang.String pageSize, java.lang.String queryId, java.lang.String fromIndex, java.lang.String toIndex)
      Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP.
      com.squareup.okhttp.Call retrieveRefundsAsync​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String idCustomer, java.lang.String confirmationNumber, java.util.List<java.lang.String> status, java.lang.String fromDate, java.lang.String toDate, java.lang.String pageSize, java.lang.String queryId, java.lang.String fromIndex, java.lang.String toIndex, ApiCallback<RefundsResponse> callback)
      Retrieve Refunds (asynchronously) The API is used to retrieve the refunds made to a customer against payments processed through EBPP.
      com.squareup.okhttp.Call retrieveRefundsCall​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String idCustomer, java.lang.String confirmationNumber, java.util.List<java.lang.String> status, java.lang.String fromDate, java.lang.String toDate, java.lang.String pageSize, java.lang.String queryId, java.lang.String fromIndex, java.lang.String toIndex, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
      Build call for retrieveRefunds
      ApiResponse<RefundsResponse> retrieveRefundsWithHttpInfo​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, java.lang.String idCustomer, java.lang.String confirmationNumber, java.util.List<java.lang.String> status, java.lang.String fromDate, java.lang.String toDate, java.lang.String pageSize, java.lang.String queryId, java.lang.String fromIndex, java.lang.String toIndex)
      Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP.
      void setApiClient​(ApiClient apiClient)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RefundApi

        public RefundApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • createRefundCall

        public com.squareup.okhttp.Call createRefundCall​(java.lang.String channel,
                                                 java.lang.String clientKey,
                                                 java.lang.String product,
                                                 java.lang.String timestamp,
                                                 java.lang.String idempotentRequestKey,
                                                 java.lang.String requestorType,
                                                 java.lang.String ID_PAYMENT,
                                                 java.lang.String ID_CUSTOMER,
                                                 CreateRefundRequest createRefundRequest,
                                                 java.lang.String requestor,
                                                 java.lang.String xOPAYHeaders,
                                                 java.lang.String traceId,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException
        Build call for createRefund
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        createRefundRequest - JSON containing all the fields required to refund a payment. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • createRefund

        public ApiResponse<RefundResponse> createRefund​(java.lang.String channel,
                                                java.lang.String clientKey,
                                                java.lang.String product,
                                                java.lang.String timestamp,
                                                java.lang.String idempotentRequestKey,
                                                java.lang.String requestorType,
                                                java.lang.String ID_PAYMENT,
                                                java.lang.String ID_CUSTOMER,
                                                CreateRefundRequest createRefundRequest,
                                                java.lang.String requestor,
                                                java.lang.String xOPAYHeaders,
                                                java.lang.String traceId)
                                         throws ApiException
        Create Refund This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        createRefundRequest - JSON containing all the fields required to refund a payment. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        Returns:
        RefundResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createRefundWithHttpInfo

        public ApiResponse<RefundResponse> createRefundWithHttpInfo​(java.lang.String channel,
                                                            java.lang.String clientKey,
                                                            java.lang.String product,
                                                            java.lang.String timestamp,
                                                            java.lang.String idempotentRequestKey,
                                                            java.lang.String requestorType,
                                                            java.lang.String ID_PAYMENT,
                                                            java.lang.String ID_CUSTOMER,
                                                            CreateRefundRequest createRefundRequest,
                                                            java.lang.String requestor,
                                                            java.lang.String xOPAYHeaders,
                                                            java.lang.String traceId)
                                                     throws ApiException
        Create Refund This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        createRefundRequest - JSON containing all the fields required to refund a payment. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        Returns:
        ApiResponse<RefundResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createRefundAsync

        public com.squareup.okhttp.Call createRefundAsync​(java.lang.String channel,
                                                  java.lang.String clientKey,
                                                  java.lang.String product,
                                                  java.lang.String timestamp,
                                                  java.lang.String idempotentRequestKey,
                                                  java.lang.String requestorType,
                                                  java.lang.String ID_PAYMENT,
                                                  java.lang.String ID_CUSTOMER,
                                                  CreateRefundRequest createRefundRequest,
                                                  java.lang.String requestor,
                                                  java.lang.String xOPAYHeaders,
                                                  java.lang.String traceId,
                                                  ApiCallback<RefundResponse> callback)
                                           throws ApiException
        Create Refund (asynchronously) This API is used to initiate a refund. Any payment made using EBPP can be refunded. Customer cannot initiate a refund request. In other words, the Create Refund request will fail if the associated requestor_type is customer.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_PAYMENT - The unique identifier assigned by EBPP to the payment. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        createRefundRequest - JSON containing all the fields required to refund a payment. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getRefundCall

        public com.squareup.okhttp.Call getRefundCall​(java.lang.String channel,
                                              java.lang.String clientKey,
                                              java.lang.String product,
                                              java.lang.String timestamp,
                                              java.lang.String idempotentRequestKey,
                                              java.lang.String requestorType,
                                              java.lang.String ID_REFUND,
                                              java.lang.String ID_CUSTOMER,
                                              java.lang.String requestor,
                                              java.lang.String xOPAYHeaders,
                                              java.lang.String traceId,
                                              ProgressResponseBody.ProgressListener progressListener,
                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                       throws ApiException
        Build call for getRefund
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_REFUND - The unique identifier assigned by EBPP to the refund. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getRefund

        public ApiResponse<RefundResponse> getRefund​(java.lang.String channel,
                                             java.lang.String clientKey,
                                             java.lang.String product,
                                             java.lang.String timestamp,
                                             java.lang.String idempotentRequestKey,
                                             java.lang.String requestorType,
                                             java.lang.String ID_REFUND,
                                             java.lang.String ID_CUSTOMER,
                                             java.lang.String requestor,
                                             java.lang.String xOPAYHeaders,
                                             java.lang.String traceId)
                                      throws ApiException
        Get Refund The API is used to retrieve the details of a refund by id.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_REFUND - The unique identifier assigned by EBPP to the refund. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        Returns:
        RefundResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getRefundWithHttpInfo

        public ApiResponse<RefundResponse> getRefundWithHttpInfo​(java.lang.String channel,
                                                         java.lang.String clientKey,
                                                         java.lang.String product,
                                                         java.lang.String timestamp,
                                                         java.lang.String idempotentRequestKey,
                                                         java.lang.String requestorType,
                                                         java.lang.String ID_REFUND,
                                                         java.lang.String ID_CUSTOMER,
                                                         java.lang.String requestor,
                                                         java.lang.String xOPAYHeaders,
                                                         java.lang.String traceId)
                                                  throws ApiException
        Get Refund The API is used to retrieve the details of a refund by id.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_REFUND - The unique identifier assigned by EBPP to the refund. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        Returns:
        ApiResponse<RefundResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getRefundAsync

        public com.squareup.okhttp.Call getRefundAsync​(java.lang.String channel,
                                               java.lang.String clientKey,
                                               java.lang.String product,
                                               java.lang.String timestamp,
                                               java.lang.String idempotentRequestKey,
                                               java.lang.String requestorType,
                                               java.lang.String ID_REFUND,
                                               java.lang.String ID_CUSTOMER,
                                               java.lang.String requestor,
                                               java.lang.String xOPAYHeaders,
                                               java.lang.String traceId,
                                               ApiCallback<RefundResponse> callback)
                                        throws ApiException
        Get Refund (asynchronously) The API is used to retrieve the details of a refund by id.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        ID_REFUND - The unique identifier assigned by EBPP to the refund. (required)
        ID_CUSTOMER - The unique identifier assigned by EBPP to the customer. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • retrieveRefundsCall

        public com.squareup.okhttp.Call retrieveRefundsCall​(java.lang.String channel,
                                                    java.lang.String clientKey,
                                                    java.lang.String product,
                                                    java.lang.String timestamp,
                                                    java.lang.String idempotentRequestKey,
                                                    java.lang.String requestorType,
                                                    java.lang.String requestor,
                                                    java.lang.String xOPAYHeaders,
                                                    java.lang.String traceId,
                                                    java.lang.String idCustomer,
                                                    java.lang.String confirmationNumber,
                                                    java.util.List<java.lang.String> status,
                                                    java.lang.String fromDate,
                                                    java.lang.String toDate,
                                                    java.lang.String pageSize,
                                                    java.lang.String queryId,
                                                    java.lang.String fromIndex,
                                                    java.lang.String toIndex,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException
        Build call for retrieveRefunds
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        idCustomer - The unique identifier assigned by EBPP to the customer. (optional)
        confirmationNumber - The confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
        status - The status of the refund. This can take multiple values in the format key=value1&key=value2.... (optional)
        fromDate - The date from which refunds, matching the criteria specified, need to be retrieved. (optional)
        toDate - The date upto which refunds, matching the criteria specified, need to be retrieved. (optional)
        pageSize - The maximum number of objects returned in the query. (optional)
        queryId - query id of the Retrieve/Search Customers lookup. (optional)
        fromIndex - To fetch the next set of objects that start after this object (optional)
        toIndex - To fetch the previous set of objects that end at this object (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • retrieveRefunds

        public ApiResponse<RefundsResponse> retrieveRefunds​(java.lang.String channel,
                                                    java.lang.String clientKey,
                                                    java.lang.String product,
                                                    java.lang.String timestamp,
                                                    java.lang.String idempotentRequestKey,
                                                    java.lang.String requestorType,
                                                    java.lang.String requestor,
                                                    java.lang.String xOPAYHeaders,
                                                    java.lang.String traceId,
                                                    java.lang.String idCustomer,
                                                    java.lang.String confirmationNumber,
                                                    java.util.List<java.lang.String> status,
                                                    java.lang.String fromDate,
                                                    java.lang.String toDate,
                                                    java.lang.String pageSize,
                                                    java.lang.String queryId,
                                                    java.lang.String fromIndex,
                                                    java.lang.String toIndex)
                                             throws ApiException
        Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        idCustomer - The unique identifier assigned by EBPP to the customer. (optional)
        confirmationNumber - The confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
        status - The status of the refund. This can take multiple values in the format key=value1&key=value2.... (optional)
        fromDate - The date from which refunds, matching the criteria specified, need to be retrieved. (optional)
        toDate - The date upto which refunds, matching the criteria specified, need to be retrieved. (optional)
        pageSize - The maximum number of objects returned in the query. (optional)
        queryId - query id of the Retrieve/Search Customers lookup. (optional)
        fromIndex - To fetch the next set of objects that start after this object (optional)
        toIndex - To fetch the previous set of objects that end at this object (optional)
        Returns:
        RefundsResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrieveRefundsWithHttpInfo

        public ApiResponse<RefundsResponse> retrieveRefundsWithHttpInfo​(java.lang.String channel,
                                                                java.lang.String clientKey,
                                                                java.lang.String product,
                                                                java.lang.String timestamp,
                                                                java.lang.String idempotentRequestKey,
                                                                java.lang.String requestorType,
                                                                java.lang.String requestor,
                                                                java.lang.String xOPAYHeaders,
                                                                java.lang.String traceId,
                                                                java.lang.String idCustomer,
                                                                java.lang.String confirmationNumber,
                                                                java.util.List<java.lang.String> status,
                                                                java.lang.String fromDate,
                                                                java.lang.String toDate,
                                                                java.lang.String pageSize,
                                                                java.lang.String queryId,
                                                                java.lang.String fromIndex,
                                                                java.lang.String toIndex)
                                                         throws ApiException
        Retrieve Refunds The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        idCustomer - The unique identifier assigned by EBPP to the customer. (optional)
        confirmationNumber - The confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
        status - The status of the refund. This can take multiple values in the format key=value1&key=value2.... (optional)
        fromDate - The date from which refunds, matching the criteria specified, need to be retrieved. (optional)
        toDate - The date upto which refunds, matching the criteria specified, need to be retrieved. (optional)
        pageSize - The maximum number of objects returned in the query. (optional)
        queryId - query id of the Retrieve/Search Customers lookup. (optional)
        fromIndex - To fetch the next set of objects that start after this object (optional)
        toIndex - To fetch the previous set of objects that end at this object (optional)
        Returns:
        ApiResponse<RefundsResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • retrieveRefundsAsync

        public com.squareup.okhttp.Call retrieveRefundsAsync​(java.lang.String channel,
                                                     java.lang.String clientKey,
                                                     java.lang.String product,
                                                     java.lang.String timestamp,
                                                     java.lang.String idempotentRequestKey,
                                                     java.lang.String requestorType,
                                                     java.lang.String requestor,
                                                     java.lang.String xOPAYHeaders,
                                                     java.lang.String traceId,
                                                     java.lang.String idCustomer,
                                                     java.lang.String confirmationNumber,
                                                     java.util.List<java.lang.String> status,
                                                     java.lang.String fromDate,
                                                     java.lang.String toDate,
                                                     java.lang.String pageSize,
                                                     java.lang.String queryId,
                                                     java.lang.String fromIndex,
                                                     java.lang.String toIndex,
                                                     ApiCallback<RefundsResponse> callback)
                                              throws ApiException
        Retrieve Refunds (asynchronously) The API is used to retrieve the refunds made to a customer against payments processed through EBPP. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. The results are sorted in descending order of the refund_date followed by the last_modified_time.
        Parameters:
        channel - The channel through which the API is invoked. (required)
        clientKey - The unique identifier assigned by EBPP to the client. (required)
        product - The product identifier corresponding to the API. (required)
        timestamp - The timestamp for the moment when the API request is created. (required)
        idempotentRequestKey - The unique token that clients can generate and maintain in order to identify an API request. (required)
        requestorType - Type of the requestor of the API. (required)
        requestor - The identifier for the requestor of the API. (optional)
        xOPAYHeaders - Intended for the future use. (optional)
        traceId - The unique reference that can be used for tracing and debugging an API call. (optional)
        idCustomer - The unique identifier assigned by EBPP to the customer. (optional)
        confirmationNumber - The confirmation number provided to the customer for the refund or for the corresponding successful payment. (optional)
        status - The status of the refund. This can take multiple values in the format key=value1&key=value2.... (optional)
        fromDate - The date from which refunds, matching the criteria specified, need to be retrieved. (optional)
        toDate - The date upto which refunds, matching the criteria specified, need to be retrieved. (optional)
        pageSize - The maximum number of objects returned in the query. (optional)
        queryId - query id of the Retrieve/Search Customers lookup. (optional)
        fromIndex - To fetch the next set of objects that start after this object (optional)
        toIndex - To fetch the previous set of objects that end at this object (optional)
        callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object