NameDescriptionTypeAdditional information
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

None.

Address2

Customer address line 2

string

None.

BillDueDays

int?

None.

BillPastDueDays

int?

None.

City

Customer address city

string

None.

CompanyName

Company name for user. Required if the Biller is configured to use Consolidated names.

string

None.

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

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.

DisplayName

Display version of the customer's name. Either CompanyName or First Name and Last Name.

string

None.

Email

Primary Email Address

string

None.

Email2

Customer's second email address

string

None.

Email3

Customer's third email address

string

None.

EmailAddress

string

Obsolete. Do not use.

ExternalUserID

Unique user ID that identifies this customer in an external system.

string

None.

FirstName

Customer's first name. Required if the Biller is configured for Separate names.

string

None.

ID

int

None.

IsEnrolled

Specifies whether this customer is enrolled or not.

boolean

None.

IsMasterEntity

Specifies whether this customer has enrolled against a master entity or a billing account.

boolean

None.

IsSSOCustomer

boolean

None.

IsSSOUser

boolean

Obsolete. Do not use.

LastName

Customer's last name. Required if the Biller is configured for Separate names

string

None.

MiddleName

Customer's middle name

string

None.

MobilePhone

Customer's mobile phone number.

string

None.

NameFirst

string

Obsolete. Do not use.

NameLast

string

Obsolete. Do not use.

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

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

None.

Stopped

Specifies whether this customer has been stopped from making payments.

boolean

None.

Telephone

string

Obsolete. Do not use.

TelephoneCell

string

Obsolete. Do not use.

Zip

Customer's postal/zip code.

string

None.