Members

inner account_number :String

wrappers/Customers.js, line 123

Customer Account Number of the customer to get details of.

inner Customer

wrappers/Customers.js, line 69

inner customer_reference :String

wrappers/Customers.js, line 108

Unique ID assigned by the biller/client system for a given customer.

inner email :String

wrappers/Customers.js, line 118

This field contains the customer’s email address within EBPP.

inner from_index :String

wrappers/Customers.js, line 88

The id of the object before which the previous set of objects are to be retrieved.

inner has_more_results :String

wrappers/Customers.js, line 78

true if there are more results or pages

inner page_size :String

wrappers/Customers.js, line 103

The maximum number of objects returned in the query.

inner query_id :String

wrappers/Customers.js, line 98

The query id of the object.

inner ssn :String

wrappers/Customers.js, line 113

The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business.

inner to_index :String

wrappers/Customers.js, line 93

The id of the object after which the next set of objects are to be retrieved.

inner total_results_count :String

wrappers/Customers.js, line 73

The total number of customers available matching the search criteria.

inner url :String

wrappers/Customers.js, line 83

This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter.

Methods

findBy(customer_reference, ssn, email, account_number, page_size, query_id, from_index, to_index) → {module:wrappers/Customers}

wrappers/Customers.js, line 158

Parameters:

Name	Type	Description
customer_reference	String	The customer_reference of Customers.
ssn	String	The ssn of Customers.
email	String	The email of Customers.
account_number	String	The account_number of Customers.
page_size	String	The page_size of Customers.
query_id	String	The query_id of Customers.
from_index	String	The from_index of Customers.
to_index	String	The to_index of Customers.

Returns:

module:wrappers/Customers -

The instance of Customers.

forClient(client_key) → {module:wrappers/Customers}

wrappers/Customers.js, line 133

Parameters:

Name	Type	Description
client_key	String	The client_key of Customers.

Returns:

module:wrappers/Customers -

The instance of Customers.

videChannel(channel) → {module:wrappers/Customers}

wrappers/Customers.js, line 142

Parameters:

Name	Type	Description
channel	String	The channel of Customers.

Returns:

module:wrappers/Customers -

The instance of Customers.