The CustomerAccount wrapper module.
Members
-
inner account_holder_name :String
-
The name as specified on the account.
-
inner account_number :String
-
The number or reference that a customer uses to identify the customer's account.
-
inner address :Address
-
-
inner audit_info :AuditInfo
-
-
inner comments :String
-
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.
-
inner current_balance :String
-
The current balance on the customer's account with the biller.
-
inner current_statement_balance :String
-
The balance on the customer’s account with the biller as reported on the last statement.
-
inner custom_fields :Object
-
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 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.
-
inner customer_account_reference :String
-
The unique identifier in the client system for the customer account.
-
inner id :String
-
Id is a unique identifier assigned to the customer account in EBPP.
-
inner ID_CUSTOMER :String
-
The unique identifier assigned by EBPP to the customer.
-
inner ID_CUSTOMER_ACCOUNT :String
-
The unique identifier assigned by EBPP to the Customer Account.
-
inner minimum_payment_due :String
-
The minimum payment amount, as specified by the biller, that needs to be made against the customer’s account.
-
inner nickname :String
-
The nickname by which a customer might want to identify the account.
-
inner past_amount_due :String
-
The amount that is due from the past bills/statements on the customer’s account with the biller.
-
inner payment_due_date :String
-
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.
-
inner payoff_amount :String
-
This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
-
inner payoff_expiry_date :String
-
The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
-
inner statement_date :String
-
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.
-
inner status :String
-
The status of the customer's account in EBPP.
-
inner url :String
-
This URL fetches the Account details.
Methods
-
static constructFromObject(data, obj) → {module:wrappers/CustomerAccount}
-
Constructs a
CustomerAccountfrom a plain JavaScript object, optionally creating a new instance. Copies all relevant properties fromdatatoobjif supplied or a new instance if not.Parameters:
Name Type Description dataObject The plain JavaScript object bearing properties of interest.
objmodule:wrappers/CustomerAccount Optional instance to populate.
-
forClient(client_key) → {module:wrappers/CustomerAccount}
-
Parameters:
Name Type Description client_keyString The client_key of CustomerAccount.
-
forCustomer(ID_CUSTOMER) → {module:wrappers/CustomerAccount}
-
Parameters:
Name Type Description ID_CUSTOMERString The ID_CUSTOMER of CustomerAccount.
-
videChannel(channel) → {module:wrappers/CustomerAccount}
-
Parameters:
Name Type Description channelString The channel of CustomerAccount.
-
withAddress(address) → {module:wrappers/CustomerAccount}
-
Parameters:
Name Type Description addressAddress The address of CustomerAccount.
-
withBalances(current_balance, current_statement_balance) → {module:wrappers/CustomerAccount}
-
Parameters:
Name Type Description current_balanceString The current_balance of CustomerAccount.
current_statement_balanceString The current_statement_balance of CustomerAccount.
-
withCustomFields(custom_fields) → {module:wrappers/CustomerAccount}
-
Parameters:
Name Type Description custom_fieldsObject The custom_fields of CustomerAccount.
-
withDetails(account_holder_name, nickname, account_number, minimum_payment_due, past_amount_due, payment_due_date, statement_date) → {module:wrappers/CustomerAccount}
-
Parameters:
Name Type Description account_holder_nameString The account_holder_name of CustomerAccount.
nicknameString The nickname of CustomerAccount.
account_numberString The account_number of CustomerAccount.
minimum_payment_dueString The minimum_payment_due of CustomerAccount.
past_amount_dueString The past_amount_due of CustomerAccount.
payment_due_dateString The payment_due_date of CustomerAccount.
statement_dateString The statement_date of CustomerAccount.
-
withMemo(comments) → {module:wrappers/CustomerAccount}
-
Parameters:
Name Type Description commentsString The comments of CustomerAccount.
-
withPayoffDetails(payoff_amount, payoff_expiry_date) → {module:wrappers/CustomerAccount}
-
Parameters:
Name Type Description payoff_amountString The payoff_amount of CustomerAccount.
payoff_expiry_dateString The payoff_expiry_date of CustomerAccount.
-
withReference(customer_account_reference) → {module:wrappers/CustomerAccount}
-
Parameters:
Name Type Description customer_account_referenceString The customer_account_reference of CustomerAccount.
-
withStatus(status) → {module:wrappers/CustomerAccount}
-
Parameters:
Name Type Description statusString The status of CustomerAccount.