Package com.orbipay.paymentsapi.client.wrappers

Class CustomerAccount

  • public class CustomerAccount
extends Base

    • Constructor Detail

      • CustomerAccount

        public CustomerAccount()

      • CustomerAccount

        public CustomerAccount​(java.lang.String ID_CUSTOMER_ACCOUNT)

    • Method Detail

      • getAccountHolderName

        public java.lang.String getAccountHolderName()
        The name as specified on the account.
        Returns:
        accountHolderName

      • getNickname

        public java.lang.String getNickname()
        The nickname by which a customer might want to identify the account.
        Returns:
        nickname

      • getAddress

        public Address getAddress()
        Get address
        Returns:
        address

      • getCustomerAccountReference

        public java.lang.String getCustomerAccountReference()
        The unique identifier in the client system for the customer account.
        Returns:
        customerAccountReference

      • getAccountNumber

        public java.lang.String getAccountNumber()
        The number or reference that a customer uses to identify the customer's account.
        Returns:
        accountNumber

      • getCurrentBalance

        public java.lang.String getCurrentBalance()
        The current balance on the customer's account with the biller.
        Returns:
        currentBalance

      • getCurrentStatementBalance

        public java.lang.String getCurrentStatementBalance()
        The balance on the customer’s account with the biller as reported on the last statement.
        Returns:
        currentStatementBalance

      • getMinimumPaymentDue

        public java.lang.String getMinimumPaymentDue()
        The minimum payment amount, as specified by the biller, that needs to be made against the customer’s account.
        Returns:
        minimumPaymentDue

      • getPastAmountDue

        public java.lang.String getPastAmountDue()
        The amount that is due from the past bills/statements on the customer’s account with the biller.
        Returns:
        pastAmountDue

      • getPaymentDueDate

        public java.lang.String getPaymentDueDate()
        The date by which the customer needs to clear the dues against the customer's account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
        Returns:
        paymentDueDate

      • getStatementDate

        public java.lang.String getStatementDate()
        The date on which the biller generates the statement for the customer's account. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
        Returns:
        statementDate

      • getId

        public java.lang.String getId()
        Id is a unique identifier assigned to the customer account in EBPP.
        Returns:
        id

      • getUrl

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

      • getStatus

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

      • 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

      • 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

      • getAuditInfo

        public AuditInfo getAuditInfo()
        Get auditInfo
        Returns:
        auditInfo

      • getIDCUSTOMERACCOUNT

        public java.lang.String getIDCUSTOMERACCOUNT()
        The unique identifier assigned by EBPP to the Customer Account.
        Returns:
        ID_CUSTOMER_ACCOUNT

      • getIDCUSTOMER

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

      • forClient

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

      • videChannel

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

      • withDetails

        public CustomerAccount withDetails​(java.lang.String accountHolderName,
                                   java.lang.String nickname,
                                   java.lang.String accountNumber,
                                   java.lang.String minimumPaymentDue,
                                   java.lang.String pastAmountDue,
                                   java.lang.String paymentDueDate,
                                   java.lang.String statementDate)
        Parameters:
        accountHolderName - : The accountHolderName is of type String.
        nickname - : The nickname is of type String.
        accountNumber - : The accountNumber is of type String.
        minimumPaymentDue - : The minimumPaymentDue is of type String.
        pastAmountDue - : The pastAmountDue is of type String.
        paymentDueDate - : The paymentDueDate is of type String.
        statementDate - : The statementDate is of type String.
        Returns:
        CustomerAccount: The Instance of CustomerAccount.

      • withBalances

        public CustomerAccount withBalances​(java.lang.String currentBalance,
                                    java.lang.String currentStatementBalance)
        Parameters:
        currentBalance - : The currentBalance is of type String.
        currentStatementBalance - : The currentStatementBalance is of type String.
        Returns:
        CustomerAccount: The Instance of CustomerAccount.

      • withReference

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

      • withStatus

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

      • withAddress

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

      • withCustomFields

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

      • withMemo

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

      • forCustomer

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

      • retrievedBy

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

      • renewedBy

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

      • get

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

      • get

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

      • renew

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

      • renew

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