Package com.orbipay.paymentsapi.client.wrappers

Class Customer

  • public class Customer
extends Base

    • Constructor Detail

      • Customer

        public Customer()

      • Customer

        public Customer​(java.lang.String ID_CUSTOMER)

    • Method Detail

      • getFirstName

        public java.lang.String getFirstName()
        The first name of the customer. Either first_name or last_name is required to create a customer.
        Returns:
        firstName

      • getLastName

        public java.lang.String getLastName()
        The last name of the customer. Either first_name or last_name is required to create a customer.
        Returns:
        lastName

      • getMiddleName

        public java.lang.String getMiddleName()
        The middle name of the customer.
        Returns:
        middleName

      • getGender

        public java.lang.String getGender()
        The gender of the customer.
        Returns:
        gender

      • getDateOfBirth

        public java.lang.String getDateOfBirth()
        The date of birth of the customer. It should be in the full-date format as per ISO8601, namely, YYYY-MM-DD.
        Returns:
        dateOfBirth

      • 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

      • getLocale

        public java.lang.String getLocale()
        The language in which the customer wants the alerts and notifications from EBPP. This is to be specified in the format,<br><i>< <b>ISO-639-1 language code</b> >_< <b>ISO ALPHA-2 Country Code</b> ></i>.<br> For e.g., <b>en_US</b> indicates the language preference as US English, which is also the default value.
        Returns:
        locale

      • getEmail

        public java.lang.String getEmail()
        The email address of the customer to which notifications from EBPP will be sent. This will default to the registered_email while creating a customer.
        Returns:
        email

      • getRegisteredEmail

        public java.lang.String getRegisteredEmail()
        The email address of the customer registered with the client. This may be used to uniquely identify the customer if the client is set up accordingly in EBPP.
        Returns:
        registeredEmail

      • getHomePhone

        public java.lang.String getHomePhone()
        The home phone number of the customer.
        Returns:
        homePhone

      • getWorkPhone

        public java.lang.String getWorkPhone()
        The work phone number of the customer.
        Returns:
        workPhone

      • getMobilePhone

        public java.lang.String getMobilePhone()
        The mobile phone number of the customer.
        Returns:
        mobilePhone

      • getAddress

        public Address getAddress()
        Get address
        Returns:
        address

      • getCustomFields

        public java.util.Map<java.lang.String,​java.lang.String> getCustomFields()
        The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = \"mailto: support@billerpayments.com\">support@billerpayments.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests.
        Returns:
        customFields

      • getCustomerReference

        public java.lang.String getCustomerReference()
        The unique identifier in the client system for the customer.
        Returns:
        customerReference

      • getId

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

      • getStatus

        public java.lang.String getStatus()
        The status of the customer in EBPP.
        Returns:
        status

      • getUrl

        public java.lang.String getUrl()
        This URL fetches the Customer details.
        Returns:
        url

      • getComments

        public java.lang.String getComments()
        Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.
        Returns:
        comments

      • getCustomerAccounts

        public CustomerAccounts getCustomerAccounts()
        Get customerAccounts
        Returns:
        customerAccounts

      • getFundingAccounts

        public FundingAccounts getFundingAccounts()
        Get fundingAccounts
        Returns:
        fundingAccounts

      • getPayments

        public Payments getPayments()
        Get payments
        Returns:
        payments

      • getPaymentSetups

        public PaymentSetups getPaymentSetups()
        Get paymentSetups
        Returns:
        paymentSetups

      • getAuditInfo

        public AuditInfo getAuditInfo()
        Get auditInfo
        Returns:
        auditInfo

      • getIDCUSTOMER

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

      • forClient

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

      • videChannel

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

      • withDetails

        public Customer withDetails​(java.lang.String firstName,
                            java.lang.String lastName,
                            java.lang.String middleName,
                            java.lang.String dateOfBirth,
                            java.lang.String ssn,
                            java.lang.String gender,
                            java.lang.String registeredEmail)
        Parameters:
        firstName - : The firstName is of type String.
        lastName - : The lastName is of type String.
        middleName - : The middleName is of type String.
        dateOfBirth - : The dateOfBirth is of type String.
        ssn - : The ssn is of type String.
        gender - : The gender is of type String.
        registeredEmail - : The registeredEmail is of type String.
        Returns:
        Customer: The Instance of Customer.

      • withReference

        public Customer withReference​(java.lang.String customerReference)
        Parameters:
        customerReference - : The customerReference is of type String.
        Returns:
        Customer: The Instance of Customer.

      • withStatus

        public Customer withStatus​(java.lang.String status)
        Parameters:
        status - : The status is of type String.
        Returns:
        Customer: The Instance of Customer.

      • withContactInfo

        public Customer withContactInfo​(java.lang.String email,
                                java.lang.String homePhone,
                                java.lang.String workPhone,
                                java.lang.String mobilePhone)
        Parameters:
        email - : The email is of type String.
        homePhone - : The homePhone is of type String.
        workPhone - : The workPhone is of type String.
        mobilePhone - : The mobilePhone is of type String.
        Returns:
        Customer: The Instance of Customer.

      • withLocale

        public Customer withLocale​(java.lang.String locale)
        Parameters:
        locale - : The locale is of type String.
        Returns:
        Customer: The Instance of Customer.

      • withAccounts

        public Customer withAccounts​(CustomerAccounts customerAccounts)
        Parameters:
        customerAccounts - : The customerAccounts is of type CustomerAccounts.
        Returns:
        Customer: The Instance of Customer.

      • withAddress

        public Customer withAddress​(Address address)
        Parameters:
        address - : The address is of type Address.
        Returns:
        Customer: The Instance of Customer.

      • withCustomFields

        public Customer withCustomFields​(java.util.Map<java.lang.String,​java.lang.String> customFields)
        Parameters:
        customFields - : The customFields is of type Map<String, String>.
        Returns:
        Customer: The Instance of Customer.

      • withMemo

        public Customer withMemo​(java.lang.String comments)
        Parameters:
        comments - : The comments is of type String.
        Returns:
        Customer: The Instance of Customer.

      • createdBy

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

      • retrievedBy

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

      • updatedBy

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

      • create

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

      • create

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

      • get

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

      • get

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

      • update

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

      • update

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