| Name | Description | Type | Additional information |
|---|---|---|---|
| AllBillingAccounts |
All the billing accounts the customer has requested access to. Includes accounts in Pending state and add-on accounts. |
Collection of BillingAccountResponseModel |
None. |
| BillerID |
The biller that this customer is associated with. |
int |
None. |
| BillingAccounts |
The active and principal billing accounts the customer is linked to. Does not include add-on accounts. |
Collection of BillingAccountResponseModel |
None. |
| Customer |
Customer profile details. |
CustomerModel |
None. |
| CustomerStatus |
Customer status |
CustomerStatus |
None. |
| CustomerToken |
Contains the token that uniquely identifies this customer in the system. The customerToken value must be URL encoded. |
string |
None. |
| CustomerType |
Customer type (one-time or enrolled). |
CustomerType |
None. |
| DefaultPaymentAccount |
Index of the default payment account for this customer. |
int |
None. |
| Deleted |
Specifies whether a customer has unenrolled |
boolean |
None. |
| DeniedAccountStatus |
Specifies whether a customer's billing account status has a denied license |
boolean |
None. |
| DisplayName |
Display version of the customer's name. Either CompanyName or First Name and Last Name. |
string |
None. |
| dtCreate |
Creation Date. |
date-time? |
None. |
| dtUpdate |
Update Date. |
date-time? |
None. |
| EnrollmentType |
Customer Enrollment Type (None, Consumer, System or Virtual/AutoDebit) |
CustomerEnrollmentType |
None. |
| ID |
Numeric Customer Identifier |
int |
None. |
| IsEnrolled |
Specifies whether this customer is enrolled or not. |
boolean |
None. |
| IsLockedOut |
Specifies whether this customer is locked out. |
boolean |
None. |
| IsMasterEntity |
Specifies whether this customer has enrolled against a master entity or a billing account. |
boolean |
None. |
| IsRTPEnabled |
Specifies whether this customer is enrolled with RTP |
boolean |
None. |
| LoginID |
Customer Login ID. |
string |
None. |
| MasterEntities |
The master entity relationships that the customer has access to. |
Collection of MasterEntityResponseModel |
None. |
| PaymentAccounts |
The payment accounts saved on this customer's profile. |
Collection of PaymentAccountResponseModel |
None. |
| PaymentPlans |
The payment plans set up for the customer. |
Collection of PaymentPlanResponseModel |
None. |
| RecurringPayments |
The recurring payments set up for this customer. |
Collection of RecurringPaymentResponseModel |
None. |
| Stopped |
Specifies whether this customer has been stopped from making payments. |
boolean |
None. |
| UnEnrolledDate |
The date when an enrolled customer was unenrolled. |
date-time? |
None. |