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.

Allows you to provide a custom description which displays when the deductible is not met on an account.

Ignored unless life event management is enabled.

Enable deadline for claims to apply to current tax year vs. next tax year?

Indicates which date type is used to determine whether a claim is before or after the tax year deadline.

Indicates and sets the pretax limit available at the plan level to determine pre-tax amount and post-tax amounts for the claim’s approved amounts.

This option allows you to enable dependent care coverage continuation for DCA plan types.

If plan is set up to allow claims crossover autopay, this field specifies whether claims will autopay when a balance due exists on the account.

If enabled, the custom plan description configured for each plan or subgroup will display within the coverage period details section of WCP.

Dormancy means participants can receive deposits, but they will not be able to use the funds for claims or card transactions. If dormancy is enabled, service category codes and merchant category codes should not be assigned. By enabling this setting, balance labels on WCP/WCM, transaction denial codes, participant communications and reporting may be impacted.

Helpful description of plan usage (in HTML format) to appear in WealthCare Portal. Note: If subgroup is provided on the record, setting will be applied to the specified subgroup. If subgroup is not provided on the record, setting will be applied to the base plan.

Hides employer contribution information in WealthCare Portal and WealthCare Mobile.

Helpful description of plan usage to appear in WCM.

Hides deductible status messaging in WCP/WCM.

A unique identifier for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.

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

Unique identifier to distinguish this plan from others.

Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)

Plan's start date. YYYYMMDD format.

Plan's end date. YYYYMMDD format.

Plan's run out date. YYYYMMDD format.

Plan's grace period end date. YYYYMMDD format.

Determines if this account type uses spending limits. Spending limits restricts the amount of money that can be deposited into or withdrawn from an account on a monthly or yearly basis.

Maximum amount to be deposited, during the spending Limit period.

Maximum amount to be withdrawn, during the spending limit period.

Indicates if this account type allows partial payments of Manual Transactions.

Corresponds to the Hold Account Funding UI option in WCA. Set this flag to True to discontinue any future scheduled auto deposits. Setting this flag to False enables auto deposits and catching up on any missed auto deposits, even those that occurred while this flag was set to True.

Indicates who will pay the convenience fee.

Convenience amount charged for each POS transaction. This field is only used if the employee is paying the fee.

Maximum amount exchanged per transaction under the plan.

Maximum amount to be paid in total over the plan's date range.

Set this field if the administrator wishes to use the default plan functionality.

Determines if the plan will have a rollover.

Determines which attributes will be rolled over.

The account fee for the product partner.

The setup fee for the product partner.

Determines if the product partner issues checkbooks.

Product partner employer group ID.

Product partner administrator ID.

Product partner product ID.

Determines if IIAS is being used.

Determines which IIAS options are being enabled.

Coverage tier ID that you want to be attached to this plan as the ID appears in WCA. This has to have already been created by admin before running this service. Leave blank if not using coverage tiers.

Default coverage tier type ID for the plan. Leave blank if not using coverage tiers.

How life events will be calculated. Only required if life event management is enabled.

Used for SpecialDeposits functionality. Determines which Other Deposit Subtype IDs will be used.

Percentage of claim amount that should be paid from the funds in the employee’s account attached to this plan. Plan “Allow Partial Manual Transactions” must be set to “Yes” in order to utilize this feature. Whole dollar amounts >= 0 and <= 100 are accepted. For example, 50 is allowed. The default value is 100%.

This amount indicates the maximum balance that is allowed for the Individual Amount within the participant’s account after funds have been rolled from another account into this account. The Fund Rollover amount will be limited such that the Individual amount balance after funds have rolled into this account does not exceed the Fund Rollover Individual Balance Max specified. Only set for individual amount in an Individual/Family HRA account.

This amount indicates the maximum balance that is allowed in a Participant’s account after funds have been rolled from another account into this account. The Fund Rollover amount will be limited such that the balance after funds have rolled into this account does not exceed the Fund Rollover Balance Max specified. For example, a participant’s balance is $600 in the target account and the Fund Rollover Balance Max is set to $1000. If the source fund has $750 of eligible funds to roll into this account, the rollover amount will be limited to $400 rather than rolling the full $750 so that the balance in the participant’s account to which funds are being rolled is $1000. This amount is also used for the family amount in an Individual/Family HRA account and for the Interest Bearing feature in WCA.

ID of calendar to use as the participant auto deposit default calendar for this plan. To use, enable “Multiple Payroll Calendars” feature at the administrator level and setup your calendars/IDs.

Calendar ID provided sets the Fixed Employer Funding deposit cycle for all participants associated with the plan. To use, enable “Fixed Employer Funding” feature at the administrator level.

If using a Fixed Employer Funding Calendar, then this amount is the amount to be deposited per pay period to the participant’s account. If not using a Fixed Employer Funding Calendar, then this amount is the single deposit amount to be credited to an employee account after the account and card (for card enabled employers) are created.

For HRX plans only. The individual amount per pay period funded by employers.

Determines what the minimum annual election amount entered for the employee can be.

Determines what the maximum annual election amount entered for the employee can be.

Determines if employee contribution limit will be enforced.

Determines amount of runout days for terminated employees during a plan year.

Tracking Number which is returned with the response.

Use this field to indicate whether or not the plan will reimburse amounts applied to the deductible tracking plan type (DTR). If the account is setup to reimburse amounts applied to the DTR plan, the DTR plan must be a higher priority plan and the claim must be submitted using Service Category Codes (SCCs) to make sure the manual claim splits properly.

Use this field to indicate whether or not the plan will allow auto pay provider reimbursements.

This field will specify a default account setting for participants enrolled in a plan using auto provider pay.

Determines if merchant substantiation will be enabled on the plan.

Custom description of the plan.

Indicates whether an existing plan’s various plan dates should be updated or not.

The value provided in this field will replace the plan’s existing Start Date if Update Plan Dates Flag = 1.

The value provided in this field will replace the plan’s existing End Date if Update Plan Dates Flag = 1.

The value provided in this field will replace the plan’s existing Run out End Date if Update Plan Dates Flag = 1.

The value provided in this field will replace the plan’s existing Grace Period Date if Update Plan Dates Flag = 1.

This setting dictates whether an account on this plan will show to the participant in WCP/WCM or if it will be returned on Participant API responses.

ID associated with external HSA investments.

Determines if claims processing will be restricted.

Indicates if plan should be linked to HRA.

Plan ID of HRA plan to be linked.

Account type of HRA plan to be linked.

Start date associated with the HRA plan to be linked.

End date associated with the HRA plan to be linked.

Determines whether the option to edit QLE Amount is disabled.

Determines whether the plan will allow on hold transactions.

Indicates whether deposits over the Employee’s Annual election amount will be partially accepted.

Specifies which proration schedule will be used, indicates that the plan supports prorated employer funding with the specified schedule.

Stores the value of the user defined field created at the plan level.WealthCare Admin does not use the field.

Determines if this account type uses spending limits. Spending limits restricts the amount of money that can be deposited into or withdrawn from an account on a monthly or yearly basis.

This will define how the carryover limit is measured.

Specifies the minimum available balance amount needed to be eligible for carryover. Values must be 0 or greater.

Specifies the carryover cap.

Specifies the percentage used for the carryover limit.