Package com.orbipay.paymentsapi.client.wrappers

Class Refunds

  • public class Refunds
extends Base

    • Field Summary

      • Fields inherited from class com.orbipay.paymentsapi.client.wrappers.Base

        baseMap

    • Constructor Summary

      Constructors 
      Constructor Description
      Refunds()  

    • Constructor Detail

      • Refunds

        public Refunds()

    • Method Detail

      • getList

        public java.util.List<Refund> getList()
        Get list
        Returns:
        list

      • getTotalResultsCount

        public java.lang.String getTotalResultsCount()
        total number of payments available with matching criteria
        Returns:
        totalResultsCount

      • getHasMoreResults

        public java.lang.String getHasMoreResults()
        true if there are more results or pages
        Returns:
        hasMoreResults

      • getUrl

        public java.lang.String getUrl()
        This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter.
        Returns:
        url

      • getFromIndex

        public java.lang.String getFromIndex()
        The id of the object before which the previous set of objects are to be retrieved.
        Returns:
        fromIndex

      • getToIndex

        public java.lang.String getToIndex()
        The id of the object after which the next set of objects are to be retrieved.
        Returns:
        toIndex

      • getQueryId

        public java.lang.String getQueryId()
        The query id of the object.
        Returns:
        queryId

      • getIdCustomer

        public java.lang.String getIdCustomer()
        The unique identifier assigned by EBPP to the customer.
        Returns:
        idCustomer

      • getConfirmationNumber

        public java.lang.String getConfirmationNumber()
        The confirmation number provided to the customer for the refund or for the corresponding successful payment.
        Returns:
        confirmationNumber

      • getStatus

        public java.util.List<java.lang.String> getStatus()
        The status of the refund. This can take multiple values in the format key=value1&key=value2....
        Returns:
        status

      • getFromDate

        public java.lang.String getFromDate()
        The date from which refunds, matching the criteria specified, need to be retrieved.
        Returns:
        fromDate

      • getToDate

        public java.lang.String getToDate()
        The date upto which refunds, matching the criteria specified, need to be retrieved.
        Returns:
        toDate

      • getPageSize

        public java.lang.String getPageSize()
        The maximum number of objects returned in the query.
        Returns:
        pageSize

      • forClient

        public Refunds forClient​(java.lang.String clientKey)
        Overrides:
        forClient in class Base
        Parameters:
        clientKey - : The clientKey is of type String.
        Returns:
        Refunds: The Instance of Refunds.

      • videChannel

        public Refunds videChannel​(java.lang.String channel)
        Overrides:
        videChannel in class Base
        Parameters:
        channel - : The channel is of type String.
        Returns:
        Refunds: The Instance of Refunds.

      • findBy

        public Refunds findBy​(MultiMap<java.lang.String> RefundsFilterMap)
        Parameters:
        RefundsFilterMap - : The RefundsFilterMap is of type com.orbipay.paymentsapi.client.MultiMap.
        Returns:
        Refunds: The Instance of Refunds.

      • forCustomer

        public Refunds forCustomer​(java.lang.String idCustomer)
        Parameters:
        idCustomer - : The idCustomer is of type String.
        Returns:
        Refunds: The Instance of Refunds.

      • retrievedBy

        public Refunds retrievedBy​(java.lang.String requestor,
                           java.lang.String requestorType)
        Parameters:
        requestor - : The requestor is of type String.
        requestorType - : The requestorType is of type String.
        Returns:
        Refunds: The Instance of Refunds.

      • get

        public Refunds get​(InvocationContext invocationContext,
                   java.lang.String liveMode)
            throws OrbipayApiException
        Parameters:
        invocationContext - : The invocationContext is of type InvocationContext.
        liveMode - : The liveMode is of type String
        Returns:
        Refunds: The Instance of Refunds.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case

      • get

        public Refunds get​(InvocationContext invocationContext,
                   java.lang.String liveMode,
                   java.lang.String apiEndPoint)
            throws OrbipayApiException
        Parameters:
        invocationContext - : The invocationContext is of type InvocationContext.
        liveMode - : The liveMode is of type String
        apiEndPoint - : The apiEndPoint is of type String.
        Returns:
        Refunds: The Instance of Refunds.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case