Members

static, readonly GenderEnum :String

models/CustomerResponse.js, line 272

Allowed values for the gender property.

Properties:

Name	Type	Description
male	String	value: "male"
female	String	value: "female"

static, readonly StatusEnum :String

models/CustomerResponse.js, line 289

Allowed values for the status property.

Properties:

Name	Type	Description
active	String	value: "active"
revoked	String	value: "revoked"
suspended	String	value: "suspended"

inner address :module:models/AddressVo

models/CustomerResponse.js, line 211

inner audit_info :module:models/AuditInfoVo

models/CustomerResponse.js, line 261

inner comments :String

models/CustomerResponse.js, line 240

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 custom_fields :Object.<String, String>

models/CustomerResponse.js, line 215

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_accounts :module:models/CustomersCustomerAccountsResponse

models/CustomerResponse.js, line 245

inner customer_reference :String

models/CustomerResponse.js, line 220

The unique identifier in the client system for the customer.

inner date_of_birth :String

models/CustomerResponse.js, line 171

The date of birth of the customer. It should be in the full-date format as per ISO8601, namely, YYYY-MM-DD.

inner email :String

models/CustomerResponse.js, line 186

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.

inner first_name :String

models/CustomerResponse.js, line 151

The first name of the customer. Either first_name or last_name is required to create a customer.

inner funding_accounts :module:models/CustomersFundingAccountsResponse

models/CustomerResponse.js, line 249

inner gender :module:models/CustomerResponse.GenderEnum

models/CustomerResponse.js, line 166

The gender of the customer.

inner home_phone :String

models/CustomerResponse.js, line 196

The home phone number of the customer.

inner id :String

models/CustomerResponse.js, line 225

The unique identifier assigned by EBPP to the customer.

inner last_name :String

models/CustomerResponse.js, line 156

The last name of the customer. Either first_name or last_name is required to create a customer.

inner locale :String

models/CustomerResponse.js, line 181

The language in which the customer wants the alerts and notifications from EBPP. This is to be specified in the format,
< ISO-639-1 language code >_< ISO ALPHA-2 Country Code >.
For e.g., en_US indicates the language preference as US English, which is also the default value.

inner middle_name :String

models/CustomerResponse.js, line 161

The middle name of the customer.

inner mobile_phone :String

models/CustomerResponse.js, line 206

The mobile phone number of the customer.

inner payment_setups :module:models/CustomersPaymentSetupsResponse

models/CustomerResponse.js, line 257

inner payments :module:models/CustomersPaymentsResponse

models/CustomerResponse.js, line 253

inner registered_email :String

models/CustomerResponse.js, line 191

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.

inner ssn :String

models/CustomerResponse.js, line 176

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

inner status :module:models/CustomerResponse.StatusEnum

models/CustomerResponse.js, line 230

The status of the customer in EBPP.

inner url :String

models/CustomerResponse.js, line 235

This URL fetches the Customer details.

inner work_phone :String

models/CustomerResponse.js, line 201

The work phone number of the customer.

Methods

static constructFromObject(data, obj) → {module:models/CustomerResponse}

models/CustomerResponse.js, line 71

Constructs a CustomerResponse from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:

Name	Type	Description
data	Object	The plain JavaScript object bearing properties of interest.
obj	module:models/CustomerResponse	Optional instance to populate.

Returns:

module:models/CustomerResponse -

The populated CustomerResponse instance.