Participant 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.

Participant Id

Sequential number assigned by Alegeus settlement within a settlement date. Used to uniquely identify the transaction.

The settlement date of the transaction to which you wish to add a receipt

Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

This is a value to be generated by the system when the file is uploaded into WCA. Send 0 on the Upload Manual Claim Receipt request.

Refers to format of receipt file uploaded: Unknown = 0, Fixed = 1, CSV = 2, XML = 4, PDF = 8, QIF = 16, Excel = 32, JPEG/JPG = 64, GIF = 128, BMP =256, FixedNacha = 512, Delimited = 1024, Word = 2048, PNG = 4096, TIFF = 8192, ExtFileFormat = 16384

The file length, in bytes.

The MIME content type of the uploaded file.

The name of the receipt file, including the directory path.

A byte array representing the contents of the file for the reciept.

The string representation in Base 64 of the file content. You will need to decode this to display the image.

Date of the transaction

Indicates the type of transaction. Valid values are Deposit, POS, Other Deposit, Manual

For Claims - This must be Claim Description or Provider Name. For POS - This must be Merchant Name. For Product Partner Transactions - This must be the Description from the Description field.

The total amount of the transaction

This will be empty for non-HSA transactions. For HSA transactions, this will indicate the type of transaction used for IRS reporting (normal distribution, reverse distribution, non-reportable, etc.)

Indicates the transaction status. Valid values are Approved, Ineligible, Pending, Resolved Employee Pyay, Resolved Payroll Deduction, New, Denied Unkown, Resolved No Refund, Ineligible Partially Offset, Resolved Offset by Manual Claim, Unauthorized Refund, Insufficient Documentation

Returns true in the following situations: Transaction is a preauth and the transaction adjudication code is ineligible, insufficient documentation, denied, or ineligible partially offset. Transaction is a purchase, and there is a pended or denied amount, or the transaction adjudication status is denied Transaction is an admin rollover deposit and the transaction adjudication status is denied. Otherwise, returns false. You can use this field as an indicator to display more information to your participants to help them know what to do with pended or denied transaction activities.

A system generated ID used to identify the transaction. Also referred to as tnxkey on other APIs.

For Card transactions, this field contains the transaction sequence number received from the Card terminal. For transactions you perform through the WealthCare Admin UI, this field contains the sequence number WealthCare Admin assigns.

The settlement date of the transaction to which you wish to add a receipt

Option to indicate whether a transaction requires a receipt. A receipt may be uploaded if the transaction's adjudication code is in one of the following: AUP2, AUP3, AUP4, AUP6, AUP7, AUP8, AUP9, AUPA, AUPB, AUPC, AUPD, AUPE, AUPI, AUPM, AUPN, AUPO, AUPQ

Returns true if there is a receipt attached to the transaction; returns false if there is no receipt file for this transaction

Returns true if the receipt has expired. Returns false if the receipt is still active. If the document routing feature is not enabled, documents are retained for 30 days after the transaction has been adjudicated. If the document routing feature is enabled, documents are stored for three years and then archived

Receipts Info { Tpa Id, File Key, Document Id, Document Display Name, Original File Name, Upload Date }

The name of the Claimant

The date for the first recurrence of the service

The account type code for the benefit account the transaction is processed against.

Custom plan description if there is one; otherwise WCA's plan description

A system generated ID for the benefit account the claim is processed under.

The cardholder's name (Last Name, First Name format)