new module:models/SimplePaymentCustomerResponse(id, status)
This class subject to change without prior notice, Please dont use this class directly.
Constructs a newSimplePaymentCustomerResponse.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | The unique identifier assigned by EBPP to the customer. |
status |
module:models/SimplePaymentCustomerResponse.StatusEnum | The status of the customer in EBPP. |
Members
-
static, readonly GenderEnum :String
-
Allowed values for the
genderproperty.Properties:
Name Type Description maleString value: "male"
femaleString value: "female"
-
static, readonly StatusEnum :String
-
Allowed values for the
statusproperty.Properties:
Name Type Description activeString value: "active"
disabledString value: "disabled"
voluntary_cancellationString value: "voluntary_cancellation"
revokedString value: "revoked"
suspendedString value: "suspended"
inactiveString value: "inactive"
-
inner address :module:models/AddressVo
-
-
inner audit_info :module:models/AuditInfoVo
-
-
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 custom_fields :Object.<String, String>
-
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.
-
inner customer_reference :String
-
The unique identifier in the client system for the customer.
-
inner date_of_birth :String
-
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
-
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
-
The first name of the customer.
-
inner gender :module:models/SimplePaymentCustomerResponse.GenderEnum
-
The gender of the customer.
-
inner home_phone :String
-
The home phone number of the customer.
-
inner id :String
-
The unique identifier assigned by EBPP to the customer.
-
inner last_name :String
-
The last name of the customer.
-
inner locale :String
-
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
-
The middle name of the customer.
-
inner mobile_phone :String
-
The mobile phone number of the customer.
-
inner registered_email :String
-
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
-
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/SimplePaymentCustomerResponse.StatusEnum
-
The status of the customer in EBPP.
-
inner url :String
-
This URL fetches the Customer details.
-
inner work_phone :String
-
The work phone number of the customer.
Methods
-
static constructFromObject(data, obj) → {module:models/SimplePaymentCustomerResponse}
-
Constructs a
SimplePaymentCustomerResponsefrom 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:models/SimplePaymentCustomerResponse Optional instance to populate.
Returns:
module:models/SimplePaymentCustomerResponse -The populated
SimplePaymentCustomerResponseinstance.