| Name | Description | Type | Additional information |
|---|---|---|---|
| AcceptedTermsOfService | boolean? |
None. |
|
| Address |
Customer address line. If Foreign address support is enabled, enter complete address in this field and leave Address2, City, State and Zip empty. |
string |
Matching regular expression pattern: ^[a-zA-Z0-9-.\,'\#\(\)\&\/\s]+$ String length: inclusive between 0 and 100 |
| Address2 |
Customer address line 2 |
string |
Matching regular expression pattern: ^[a-zA-Z0-9-. \,'\#\(\)\&]+$ String length: inclusive between 0 and 100 |
| BillDue | CustomerNotificationType |
None. |
|
| BillDueDays | int? |
Range: inclusive between 0 and 365 |
|
| BillPastDue | CustomerNotificationType |
None. |
|
| BillPastDueDays | int? |
Range: inclusive between 0 and 365 |
|
| City |
Customer address city |
string |
Matching regular expression pattern: ^[a-zA-Z '\.]+((\s|\-)[a-zA-Z '\.]+)?$ String length: inclusive between 0 and 50 |
| CompanyName |
Company name for user. Required if the Biller is configured to use Consolidated names. |
string |
Matching regular expression pattern: ^[a-zA-Z0-9,\`\&\@\.\!\-_\# ']+$ String length: inclusive between 0 and 128 |
| ConfirmEmail | string |
Matching regular expression pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$ String length: inclusive between 0 and 128 |
|
| Country |
Customer address country as an ISO 3-character code. If Foreign address support is enabled, enter 3 letter ISO country code. Defaults to USA if not provided. |
string |
String length: inclusive between 0 and 3 |
| DisableBillNotification | boolean |
None. |
|
|
Email address of account user. |
string |
Matching regular expression pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$ String length: inclusive between 0 and 128 |
|
| Email2 |
Customer's second email address |
string |
Matching regular expression pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$ String length: inclusive between 0 and 128 |
| Email3 |
Customer's third email address |
string |
Matching regular expression pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$ String length: inclusive between 0 and 128 |
| ExternalUserID |
Unique user ID that identifies this customer in an external system. |
string |
String length: inclusive between 0 and 256 |
| FirstName |
Customer's first name. Required if the Biller is configured for Separate names. |
string |
Matching regular expression pattern: ^[a-zA-Z0-9,\`\&'\.\-\:/ ']+((\s|\-)[a-zA-Z0-9,\`\&'\.\:/']+)?$ String length: inclusive between 0 and 32 |
| LastName |
Customer's last name. Required if the Biller is configured for Separate names |
string |
Matching regular expression pattern: ^[a-zA-Z0-9,\`\&'\.\-\:/ ']+((\s|\-)[a-zA-Z0-9,\`\&'\.\:/']+)?$ String length: inclusive between 0 and 32 |
| MiddleName |
Customer's middle name |
string |
Matching regular expression pattern: ^[a-zA-Z0-9,\`\&'\.\-\:/ ']+((\s|\-)[a-zA-Z0-9,\`\&'\.\:/']+)?$ String length: inclusive between 0 and 32 |
| MobilePhone |
Customer's mobile phone number. |
string |
String length: inclusive between 0 and 20 |
| PaperSuppression |
Optionally specifies whether the customer has opted for paper suppression. |
boolean? |
None. |
| Phone |
Customer's primary phone number. Required if Biller is configured as such, otherwise Optional. For USA/CAN addresses, the phone number format will be verified and coerced into ###-###-#### if possible. If the phone number cannot be converted into this format, an error will be generated. For non-USA/CAN addresses, this formatting will not be enforced. Determination of USA/CAN addresses is based on the Country field. |
string |
String length: inclusive between 0 and 20 |
| SendPinacleRFP | boolean |
None. |
|
| SMSEnrollOnlyMobile |
Mobile phone number for Enroll-Only SMS notifications |
string |
None. |
| SMSEnrollOnlyRegistrationStatus |
Status of whether the user has enrolled in Enroll-Only SMS notifications |
SMSEnrollOnlyRegistrationStatus |
None. |
| State |
Customer's address state code as a 2-character code. If provided, must be a 2 character US State, Territory, or Canadian province |
string |
String length: inclusive between 0 and 2 |
| Zip |
Customer's postal/zip code. |
string |
Matching regular expression pattern: (^(\d{5})(-?(\d{4}))?$)|(^([abceghjklmnprstvxyABCEGHJKLMNPRSTVXY]{1}\d{1}[a-zA-Z]{1})([ \-])*(\d{1}[a-zA-Z]{1}\d{1})$) String length: inclusive between 0 and 10 |