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.

Unique identifier for the employee.

Type of account that the deposit is going toward. Example: “FSA” or “DCA”

YYYYMMDD - Account Type end date as identified on the plan page in WCA.

YYYYMMDD - Account Type start date as identified on the plan page in WCA.

Date that the transaction is displayed to the employer/employee. Default to Today’s date unless date is listed.

Indicates whether or not the transaction will be displayed to the cardholder. 0 (False) = No 1 (True) = Yes Defaults to true (Yes).

Employee’s social security number.

Amount that the employer deposited.

Optional note to be attached to this transaction.

ID for the plan that the account receiving the deposit is under, this is viewable on the plan page in WCA.

This field is ignored unless the deposit type field is set to payroll (1), prefunded (2), or other deposit (6).If one of the three options above is submitted for the deposit type field, and the special deposit subtype is: Blank: System uses default deposit sub type. (default sub type = other deposit) Provided:If deposit type is ‘other deposit’ (6), then the special deposit subtype is accepted for use with the other deposit functionality. If deposit type is payroll (1) or prefunded (2), you can use the special deposit subtype field to submit a deposit code. If the code submitted matches one associated with the plan, then WCA will map the code to the corresponding deposit description. Note: Each sub-type must be "activated" for the employer plan through the user interface.

Type of deposit for the account. 1 - Payroll deposit, 2 - Prefunded, 3 - Individual or employee deposit for an Individual/Family HRA plan, 6 - Other deposit (‘employer deposit amount’ is required), 7 - Individual/family other deposit, 11 - Annual election override, 12 - Admin rollover, 13 - Carryover deposit, 14 - HSA incentive deposit ('employer deposit amount' is required) Note 1: If this field is set to 3, the amount entered in the field, employee deposit amount, is the total family amount. Note 2: If this field is set to 6 or 7, employer deposit amount is required. If set to 7, employer deposit amount is the total family amount. Note 3: If this field is set to 8, both negative and positive amounts are permitted. The amount of the deposit will affect the account’s other deposits, available balance, and disbursable balance values. Note 4: If this field is set to 11, regardless of whether the account is payroll or prefunded, the system will update the annual election. Note 5: If a payroll account is associated with a calendar, and the ‘Will you provide both contribution and annual election amounts?’ is enabled, the annual election override deposit type cannot be used. Note 6: If funding setup is incomplete, deposits submitted receive notification of the error via the RH record: Funding setup for this HSA plan is not complete. Payroll deposits loaded will not post to the HSA accounts. Please complete setup or contact your administrator. Note 7: For the carryover deposit type, the deposit transaction positively or negatively impacts the participant’s available and carryover balances on accounts with carryover enabled. Carryover must be enabled on the account and it must be eligible for carryover. You can use the ‘enforce participant effective dates’ and ‘enforce account eligibility date’ flags to insert the deposit during a period where the participant is not active. Note 8: If deposit type is set to 12 (admin rollover), WCA only looks for an amount in the 'employee amount' field and ignored the 'employer amount' field. Note 9: If deposit type is set to 14, then the account must be an HSA, employee amount must be 0, employer amount must be greater than 0, dependent SSN field must be empty

Family Member ID used for deposits to individual dependent balances.

Determines whether participant's eligibility date will be enforced. 0 (False) = No. WCA does not enforce Participant Eligibility Dates. 1 (True) = Yes(Default). The Service Start Date and Service End Dates must be within the Employee and/or Dependent’s eligibility and termination dates. Note 1: If Enforce Eligibility Dates is not included in the template, the eligibility dates are not enforced. Note 2: If the Eligibility Date is sent on the record and the Employee does not have Eligibility Date in the system, the Eligibility Dates will be ignored.

Determines whether participant account's effective date will be enforced. 0 (False) = No. WCA does not enforce Effective Dates 1 (True) = Yes (default). The Service Start Date and Service End Dates must be within the Employee and/or Dependent’s account effective and termination dates. Note: If this field is not in the II record template, the employee account effective dates will not be checked. If this field is in the II template, and a value of 1 is passed or the field is left blank, then WCA will enforce that the service date of the claim falls within the participant’s effective period for the benefit plan. Note 2:  Enforcing Account Effective Dates will also validate that the claim is submitted prior to the “Last Day to Submit Claims” for a participant. The last date to submit claims is calculated using the plan Run Out Date, Employee Termination Date, Account Termination Date and the Run Out Days for Terminating Employees specified on the benefit plan.

Employee's Account ID, which is viewable on the account page in WCA.

Tracking Number.  Client supplied and is returned on the response.

Tracking Number.  Client supplied and is returned on the response.

The disbursable balance on the account.

Error code that the claim received.