Administrative APIs | REST

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

Optional flag to indicate whether to return detailed information about the employer. Defaults to false, returning only essential data.

Automatically reissue cards N days prior to expiration.

Card stock ID for the card stock to assign for this employer. Must exactly match the card stock ID in WCA. Note: For add/update, if left blank, the default card stock is used

This field is used to associate a Brand ID to the employer group. Brand ID must first be configured on the admin > settings > branding page in WCA.

When an online payment is made to fulfill a balance due, there is a standard two business day waiting period before a deactivated benefit debit card can be reactivated. If you wish, you can use this field to set a maximum online payment which will bypass the waiting period and immediately reactivate the card. Note: Leaving this field blank or setting it to '0' ensures all transactions are subject to the waiting period.

Employer-level customer service phone number.

Employee user defined field.

Employee user defined field.

Employee user defined field.

Employee user defined field.

Employee user defined field.

Employee user defined field.

Employee user defined field.

Employee user defined field.

Employee user defined field.

User defined field label at plan level.

Specifies which address new cards are mailed to.

Confirms if the employer group offers the debit card.

Specifies whether cards are automatically activated when a cardholder first uses the card.

First line of the employer group's address.

Second line of the employer group's address, if needed.

Specifies which address new cards are mailed to.

Pre-approved card 2nd line text. If does not match existing text listed in BPS, it is not used.

City associated with the employer group's address.

Indicates whether the employer has employee co-pay amounts enabled.

Country code for the employer. Only 'US' is supported at this time.

The direct deposit method used by the employer group.

The email address associated with the employer group.

Name of field used by employers at the employee level. (i.e. Birthdate, Location)

Select true if this is a test employer.

Only 6 characters allowed on INSERT. Excludes the three character Employer ID Prefix (as shown on Administrator Demographic screen in BPS), because it is added automatically on INSERT.

Complete employer group name. This is the name used on reports generated by the system.

Phone number associated with employer including area code.

Tax ID number for the employer.

Name of field to be used by administrator at the group level. (i.e. Region, Tax ID Number)

Data input to satisfy the field created by the Employer Defined Field. (i.e. North, 00031515)

Fax number associated with employer including area code.

Number of enrollees the employer group expects to bring to the system. This assists Alegeus Technologies with determining card inventory requirements.

Indicates whether the employer has employee recurring expense amounts enabled.

Email addresses separated by semicolon used to notify when group setup is completed and Employer is ready to load employees.

Two letter state abbreviation associated with the group’s address.

The administrator’s ID. This is unique for each administrator.

Zip code associate with employer group's address.

Optional, Name used to specify text that appears on the back of the cardholder’s card.

Possible values are Payment and Combo.

This is the Thermal Logo (Front) description that was created in the user interface.

This field is used to set the minimum reimbursement amount for Reimbursement Processing.