Get Transaction History
-
tpaId string Required
A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
-
employerId string Required
Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
-
TransactionStatus_2015_02 enum<string>
Status of transaction. 1 = Approved 2 = Ineligible 3 = Pending 4 = ResolvedEmployeePay 5 = ResolvedPayrollDeduction 6 = New 7 = Denied 8 = Unknown 9 = ResolvedNoRefund 13 = Insufficient Documentation
Possible values:Approved
Ineligible
Pending
ResolvedEmployeePay
ResolvedPayrollDeduction
New
Denied
Unknown
ResolvedNoRefund
IneligiblePartiallyOffset
ResolvedOffsetbyManualClaim
UnauthorizedRefund
InsufficientDocumentation
Overpayment
NonPost
Returned
Resubmitted
All
-
WCHSATransactions enum<string>
Limits return to HSA Transactions 0 – Include 1 - Only 2 - Exclude
Possible values:Include
Only
Exclude
-
HSATransactionStatus enum<string>Possible values:
Processing
Posted
WCHSAAccountImpacting
-
AccountTypeCode string
Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.). Note that if this field is included, the AccountTypeEndDate and AccountTypeStartDate should also be included.
-
AccountTypeEndDate string
(YYYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field. Note that if the AccountTypeCode is used, than this field should also be included.
-
AccountTypeStartDate string
(YYYYMMDD)Date that funds are available for services. Note that if the AccountTypeCode is used, than this field should also be included.
-
CardNumber string
Benefit card number. You must provide either the card number or card proxy number or cardholder social security number or cardholder ID; all are not required. If either or both cardholder identifiers (SSN or ID) are provided in addition to card number (or proxy number), card number (or proxy number) is used.
-
DateOfServiceFrom string <date-time>
Beginning Date of Services for the transaction. The actual date that the cardholder had the service provided.
-
DateOfServiceTo string <date-time>
Ending Date of Services for the transaction. The actual date that the cardholder had the service provided.
-
CardholderId string
Required if this field is being used as the unique cardholder identifier and card number is not provided. Either this field or Cardholder SSN may be used for this purpose.
-
CardholderSocialSecurityNumber string
Required if this field is being used as the unique cardholder identifier and card number is not provided. Either this field or cardholder ID may be used for this purpose.
-
EmployerId string
Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
Min Length: 0 Max Length: 18 -
TransactionType enum<string>Possible values:
Deposit
POS
Manual
OtherDeposit
All
-
TpaId string
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.
-
VerboseMode boolean
0 (False) 1 (True) Optional, if set to true, the method may return more details as to why a query did not return any records.
-
PlanId string
Unique identifier that distinguishes this plan from all others you administer.
Min Length: 0 Max Length: 18 -
QueryIias boolean
Set this field to true to see values on the IIAS specific fields that are on the response.
-
DepositsEnteredBy enum<string>
Use this field to export Deposits entered by admin only, employer only or all Admin/Employer/All
Possible values:Admin
Employer
All
-
DependentId string
Required if this field is being used as the unique employee identifier and DependentSocialSecurityNumber is not provided. Either this field or Dependent SocialSecurity Number may be used for this purpose.
-
DependentSocialSecurityNumber string
Required if this field is being used as the unique employee identifier and DependentID is not provided. Either this field or DependentID may be used for this purpose.
-
ExternalClaimNumber string
This field is not used by WCA, It may be used to populate an external system claim number for recording keeping purposes.
-
CardProxy string
Alternative benefit debit card number. See CardNumber description for conditional requirements.
-
array <object>
-
DependentSSN string
Social Security Number of the Dependent associated with the transaction.
-
LinkTxnKey string
The transaction key of the transaction that this transaction is linked to. Linking occurs in situations where multiple transactions are needed to facilitate money transfer such as a card Authorization and card Post.
-
TxnKey string
Unique identifier of a transaction.
-
TransactionCode_2015_02 enum<string>
Transaction Code 0 = Unassigned, 11 = Purchase, 12 = PreAuth, 13 = ForcePost, 14 = Refund, 20 = EmployerDeposit, 21 = PrefundedDeposit, 22= AutoDeposit, 23 = Adjustment, 24 = Void, 25 = PrefundedDepositReset, 26 = BalanceSyncAdjustment, 27 = IndividualAmt, 28 = IndividualAmtReset, 29 = HsaImported, 30 = OtherDeposit, 31 = RolloverDeposit, 32 = FamilyRolloverDeposit, 33 = FamilyOther Deposit
Possible values:Unassigned
Purchase
PreAuth
ForcePost
Refund
EmployerDeposit
PrefundedDeposit
AutoDeposit
Adjustment
Void
PrefundedDepositReset
BalanceSyncAdjustment
IndividualAmt
IndividualAmtReset
HsaImported
OtherDeposit
RolloverDeposit
FamilyRolloverDeposit
FamilyOtherDeposit
ExternalFundingDeposit
HSATransfer
HSAOnlinePayment
Interest
Fee
BankerCustomTxn
HoldRelease
CardReimbursementDeposit
MaintenanceFee
PaperSurchargeFee
DormantAccountFee
InvestmentAccountFee
OnlinePaymentFee
AccountOpeningFee
ReturnedItemFee
ReturnedDepositFee
OverdraftFee
DebitCardIssuedToPrimaryFee
ReplacementPrimaryCardFee
DebitCardIssuedToAuthorizedSignerFee
ReplacementAuthorizedSignerDebitCardFee
ATMWithdrawalFee
POSPurchaseWithPINFee
CheckWithdrawalFee
ClosedAccountFee
ACHCredit
ACHDebit
CheckWithdrawal
Commission
DeathdISTRInYearOfDeath
DeathDistrAfterYearOfDeathEstate
DeathDistrAfterYearOfDeathNonSpouseNonEstate
AccountOpeningCredit
ReassociationAccountBalanceUpdate
AnnualElectionOverride
AdminRolloverDeposit
HSAAdvanceCreditToHSA
HSAAdvanceRecovered
-
HSAPostingDate string
The date the transaction posts to the HSA account.
-
HSACodeDescription string
HSA Code Description
-
HSACode integer <int32>
HSA Code
-
HSAReasonForNonPostDescription string
HSA Reason For Non-Post Description
-
HSAReasonForNonPostCode integer <int32>
HSA Reason For Non-Post Code
-
PostingType string
Posting Type
-
GLAccount string
GL Account
-
HoldAmount number <double>
Hold Amount
-
ExcludeFromEmployerFunding boolean
Allows administrators to exclude the transactions from WCA Employer Funding calculations. 0 (False) – Include in Employer Funding (Default) 1 (True) – Exclude from EmployerFunding
-
AccountTypeCode string
Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.).
-
AccountTypeEndDate string
(YYYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
-
AccountTypeStartDate string
(YYYYMMDD)Date that funds are available for services.
-
CardholderId string
Either the Employee or Dependent ID depending on which was used in the request.
-
CardholderSocialSecurityNumber string
Either the dependent or employee SSN number depending on what was used in the request.
-
CardNumber string
Flex card proxy number. Note: This field is only returned if it was used in the request.
-
DateOfServiceFrom string <date-time>
Beginning Date of Services for the transaction. The actual date that the cardholder had the service provided.
-
DateOfServiceTo string <date-time>
Ending Date of Services for the transaction. The actual date that the cardholder had the service provided.
-
DisplayDate string <date-time>
Date displayed to the employer/employee.
-
DisplayToCardholder boolean
0 (False) Do not display to Cardholder 1 (True) Display to Cardholder
-
EmpeAvailBal number <double>
Available Balance is the Disbursable Balance plus the Auth Hold Balance. If this account has multiple QLE Coverage Periods, this field will contain the current coverage period's balance. Note: For full-featured HRAs—HRX, HX1 …HX6—with family and individual amounts, this amount is the individual balance for the employee or dependent.
-
EmpeDisbBal number <double>
Disbursable Balance = Available Balance minus Auth Hold Balance. If this account has multiple QLE Coverage Periods, this field will contain the current coverage period's balance. Note : For full-featured HRAs—HRX, HX1 …HX6—with family and individual amounts, this amount is the individual balance for the employee or dependent.
-
EmpeDisbPtd number <double>
The disbursable balance paid to date.
-
EmpePreauthBal number <double>
Employee's pre-auth balance. Transactions that don't have a matching Force-post transaction from a merchant.
-
MerchantName string
Enter the name of the merchant as shown on the claim/receipt. UPDATE: This field is only able to accept the first 22 characters at this time due to a Mastercard/system limitation. Data truncates to only include first 22 characters from the left (right trucated).
-
MerchantTypeCode string
Also referred to as Merchant Category Code. Indicates the type of merchant submitting the transaction. The identifier is encoded into the terminal by the issuing bank and transmitted with every transaction. Note: If the transaction was accepted because of a terminal, merchant, or employee exception, the code is considered a converted MTC. The code is designated as MCC for MasterCard and SIC for Visa.
-
Note string
Specific note to tie to this transaction.
-
SequenceNumber integer <int32>
Sequential number assigned by the settlement system within a Settlement Date.
-
SettlementDate string
(YYYYMMDD)Date that the transactions was settled on. Settlement occurs typically at 3:45 PM CT so all transactions received that day before that time and all transactions received after 3:45 PM CT the previous day have the same settlement date.
-
StatusCode string
Refer to transaction status table below. Example AAA1
-
TrackingNumber string
You can assign and use a number to identify specific claims. Note: WCA does not use this number.
-
TransactionAdjudicationStatus enum<string> Required
Status of transaction. 1 = Approved, 2 = Ineligible, 3 = Pending, 4 = ResolvedEmployeePay, 5 = ResolvedPayrollDeduction, 6 = New, 7 = Denied, 8 = Unknown, 9 = ResolvedNoRefund, 13 = Insufficient Documentation
Possible values:Approved
Ineligible
Pending
ResolvedEmployeePay
ResolvedPayrollDeduction
New
Denied
Unknown
ResolvedNoRefund
IneligiblePartiallyOffset
ResolvedOffsetbyManualClaim
InsufficientDocumentation
EnteredNotReviewed
Reversed
ClaimReversal
Overpayment
OverpaymentPartiallyResolved
OverpaymentResolved
NonPost
Returned
Resubmitted
Processing
Posted
-
TransactionAmount number <double>
The transaction amount.
-
TransactionDate string <date-time>
Date of the transaction.
-
TransactionDeniedAmount number <double>
Denied transaction amount.
-
TxnAdjudDesc string
Description for transaction adjudication.
-
TotalAuthorizedAmountOriginal number <double>
Total amount of this transaction. Note: If this amount is more than the amount in the Transaction Amount field, this transaction has been split.
-
HetAmountOriginal number <double>
The Healthcare Eligible Total (HET) requested/provided by the merchant.
-
HetAmount number <double>
The HET amount applied to the account for this transaction. Note: If an administrator has selected the OTC amount on which to authorize IIAS transactions, the HET amount authorized field will be populated as well. This is because IIAS merchants do not transmit an OTC amount (OTC is a calculated amount done in WealthCare Admin) and Alegeus simply returns the OTC amount authorized back to the IIAS merchant in the HET amount authorized field
-
RxAmountOriginal number <double>
The Prescription Drug (Rx) amount requested/provided by the merchant.
-
RxAmount number <double>
The Rx amount applied to the account for this transaction.
-
DentalAmountOriginal number <double>
The Dental amount requested/provided by the merchant.
-
DentalAmount number <double>
The Dental amount applied to the account for this transaction.
-
VisionAmountOriginal number <double>
The Vision amount requested/provided by the merchant.
-
VisionAmount number <double>
The Vision amount applied to the account for this transaction.
-
PartialAuthIndicator boolean
0 (False) 1 (True) True or false depending on whether the merchant allows a partial authorization.
-
PartialAuthorized boolean
0 (False) 1 (True) Returns true or false depending on whether a partial authorization took place.
-
ErrorCode string
Error code.
-
TpsErrorCode integer <int32>
If the transaction is IIAS(Inventory Information Approval System) adjudicated, this has a 12 and 0 for real-time PBM(Pharmacy Benefits Management).
-
OffsetAmount number <double>
This field returns the Ineligible Amount – Offset Amount. This is the amount remaining after offsetting. For completely offset transactions, the amount will be 0.
-
DepositSubTypeId string
If using other (Other) Deposits feature and the transaction is an Other (Special) Deposit this field is populated with the sub-type deposit ID.
-
TransactionDesc string
If using other (Special) Deposits feature and the transaction is an Other (Special) Deposit this field is populated with the deposit description. Add deposits done via the auto-deposit (can use existing fields). Auto Deposit (22). Origination is 50, 51,52
-
DeductibleAmount number <double>
Amount of this claim that was applied to the deductible on this account.
-
BypassDeductibleIndicator boolean
0 (False) – Do not bypass (apply toward deductible as appropriate) 1 (True) – Bypass Deductible (claim not applicable to the deductible and was eligible to be paid) Indicates whether this transaction used deductible rules when it was applied to the account or if it was paid out directly (was not applicable to the deductible).
-
ReduceByBalanceMax boolean
0 (False) = All funds rolled according to fund rollover rules 1 (True) = Target Plan Fund Rollover amount reduced by balance Max This field applies only to fund rollover deposits.
-
FundRolloverType integer <int32>
0 = Non-rollover transaction 1 = Primary Fund Rollover 2 = Secondary Fund Rollover(FUTURE)
-
RolloverDepositsPtd number <double>
Deposits made Year to Date INTO this account via Fund Rollover. For an Individual/Family HRA plan, this is the Individual Fund information– If a Dependent ID is provided, then this is the Dependent’s individual Fund information.
-
FamilyRolloverDepositsPtd number <double>
Individual/Family HRA plans only. Deposits made Year to Date INTO this account via Fund Rollover.
-
ServiceCategoryCode string
The alphanumeric SCC assigned to a manual claim.
-
ServiceCategoryCodeDescription string
The description for the SCC.
-
ManualClaimNumber string
A system generated number assigned to a manual claim once that claim is successfully submitted. Consists of YYYYMMDD + INCREMENT, where INCREMENT is a sequential number. For example, if the first claim of the day was submitted on 19 March 2008, then the # would be 200803191. Note; Both the tracking number and Manual claim number appear on the latest version (July, 2008) of the Manual Claim Denial Letter.
-
EligibleAmt number <double>
WCA calculated as the Administrator submitted Approved Amount less the WCA determined Excluded Amount, This value is the amount of the claim that is eligible for payment and shown on the Transaction History screen.
-
ExcludedAmount number <double>
On a manual claim only, amount the system has deemed ineligible based on pre-configured business rules set up in the system by the administrator (example: amount excluded due to participant ineligible on service dates)
-
ExcludedErrorCode integer <int32>
The excluded error coded.
-
ExcludedErrorDescription string
The excluded error description.
-
LowFundAmount number <double>
Both manual and POS claims. The amount in excess of the account balance at the time of the Transaction. Low Funds Amount = Original transaction amount - denied amount – excluded amount – amount applied to deductible – ineligible offset amount.
-
FlexAcctId string
A unique identifier for the employee's account, generated by WCA when the account was first set up.
-
EligDte string
Account Eligible Date
-
TermDte string
Date the participant is no longer eligible for the plan type within WealthCare Admin.
-
TransactionPendedAmount number <double>
This will return the pended amount value for a manual claim.
-
PayProviderFlag string
Indicates whether the transaction was reimbursed to a provider or directly to the participant. 0 -Participant Reimbursed Claim 1 -Provider Reimbursed Claims
-
ProviderID string Required
WCA Provider ID
-
ProviderAddress1 string
Provider Address Line 1
-
ProviderAddress2 string
Provider Address Line 2
-
ProviderCity string
Provider Address City
-
ProviderState string
Provider Address State
-
ProviderZip string
Provider Address Zip Code
-
DependentId string
Unique identifier for the dependent.
-
PaymentId string
Represents the draft # issued by our Integrated Payment vendor.
-
PaymentClearedDate string
YYYYMMDD - The date the transaction’s check cleared the source of funds bank account. The payment cleared date may be entered by the administrator via the UI, or using EDI on the (FB) import record.
-
ExternalClaimNumber string
External Claim Number added to transactions to facilitate and track overpayments
-
PinNetworkIndicator boolean
0 (False) Signature Based 1 (True) PIN Based Will indicate whether the transaction is a PIN based or signature based transaction.
-