Package com.orbipay.paymentsapi.client.wrappers

Class Customers

  • public class Customers
extends Base

    • Constructor Detail

      • Customers

        public Customers()

    • Method Detail

      • getList

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

      • getTotalResultsCount

        public java.lang.String getTotalResultsCount()
        The total number of customers available matching the search 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

      • getPageSize

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

      • getCustomerReference

        public java.lang.String getCustomerReference()
        Unique ID assigned by the biller/client system for a given customer.
        Returns:
        customerReference

      • getSsn

        public java.lang.String getSsn()
        The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business.
        Returns:
        ssn

      • getEmail

        public java.lang.String getEmail()
        This field contains the customer’s email address within EBPP.
        Returns:
        email

      • getAccountNumber

        public java.lang.String getAccountNumber()
        Customer Account Number of the customer to get details of.
        Returns:
        accountNumber

      • forClient

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

      • videChannel

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

      • findBy

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

      • retrievedBy

        public Customers 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:
        Customers: The Instance of Customers.

      • get

        public Customers 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:
        Customers: The Instance of Customers.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case

      • get

        public Customers 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:
        Customers: The Instance of Customers.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case

      • getPage

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

      • getPage

        public Customers getPage​(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:
        Customers: The Instance of Customers.
        Throws:
        OrbipayApiException - The only Exception that is thrown in Exceptional case