Get transaction details
Get transaction details
-
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.
-
participantId string Required
Participant Id
-
externalClaimId string Required
For an FX claim, this is the external identifier for the claim
-
decrypt integer <int32>
Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.
-
opt integer <int32>
If a returned transaction is for a dependent, this flag indicates whether to mask certain information on the transaction or not. 0: do not mask 1: mask provider information on dependent transaction. PRIVATE will be returned for the transaction description, transaction provider descripton, transaction provder ID, service category code, service category code description, and merchant name. 2: mask provider information on dependent transaction only if Dependency Privacy is enabled. PRIVATE will be returned for the transaction description, transaction provider description, transaction provder ID, service category code, service category code description, and merchant name.
-
array <object>
-
FXClaimStatus integer <int32>
For an FX claim, this will be a number 1 through 9 representing the status of the claim. The FXClaimStatusDesc field will include the corresponding description. 1 = Paid 2 = Approved 3 = Applied to Deductible 4 = Denied 5 = Eligible for Reimbursement 6 = Reversed 8 = Overpaid 9 = Partially Approved
-
FXClaimStatusDesc string
For an FX claim, this will be a human friendly description of the claim status, correpsonding to the FXClaimStatus field. 1 = Paid 2 = Approved 3 = Applied to Deductible 4 = Denied 5 = Eligible for Reimbursement 6 = Reversed 8 = Overpaid 9 = Partially Approved
-
FXClaimDisplayType integer <int32>
This indicates, for this specific TransactionDetailEx object, if the information is for the entire FX claim (1), for a single line of the FX claim (2), or for a reimbursement (3). Your response will include a TransactionDetailEx object for each claim line and then a TransactionDetailEx for the entire claim; a TransactionDetailEx object for a reimbursement will only be included if it is applicable to this particular FX claim. 0 = None 1 = Total 2 = Line 3 = Reimbursement
-
AdjustedClaimLine integer <int32>
-
RenderingProvider string
The provider who provided the service to the participant (this may be different than the billing provider name). It is recommended to use this field as the Provider Name to display.
-
RenderingProviderId string
Provider ID for the provider who performed the service for the participant.
-
OutOfPocketAmt number <double>
Amount the participant designated as paid Out Of Pocket for the claim and therefore the participant is not seeking reimbursements for this portion.
-
Claimant string
The family member for whom the claim applies
-
PatientID string
The provider’s patient account number.
-
PatientName string
The name of the patient associated with the claim.
-
ReimburseKey integer <int32>
Represents a system generated identifier for the reimbursement which can be used to retrieve the reimbursement details in a separate request.
-
PaymentId string
Represents the draft # issued by our Integrated Payment vendor.
-
PayoutMethod string
Represents the payment method used by the participant or our Integrated Payment vendor. Valid methods include Pending, Check, Direct Deposit, External Check, External Direct Deposit, Card, Payroll, ePay-ACH, ePay-Virtual Card, and ePay-eCheck.
-
TrackingNumber string
Tracking Number assigned by the system importing the transaction to WCA
-
ExternalClaimID string
For an FX claim, this is the external identifier for the claim
-
ServiceCategoryTier integer <int32>
The Service Categoriy Tier associated with the claim line.
-
ClaimLine integer <int32>
Refers to claim when multiple claim submitted
-
ServiceProcedureCode string
CPT, HCPCS or other service procedure type. This information is stored in the system for display to the administrator and participant It is not used by the system to determine whether a claim is eligible
-
BilledAmt number <double>
On an FX or TC claim or a participant added expense, this is the amount the provided billed to insurance. It is for information purposes only and is not used for adjudication. It is intended to help a participant match-up to the full billed amount for a service. For TC/FX Claims this is the summation of all claim lines.
-
AllowedAmt number <double>
On an FX or TC claim or a participant “save expense” for later, this is the amount allowed by insurance. It is for information purposes only and is not used for adjudication. For TC/FX Claims this is the summation of all claim lines.
-
DeductibleAmtRequested number <double>
The participant's deductible responsibility that was requested
-
DeductibleAmtReimbursed number <double>
The participant's deductible responsibility that was reimbursed
-
CoinsuranceAmtRequested number <double>
Amount requested by participant's coinsurance
-
CoinsuranceAmtReimbursed number <double>
Amount reimbursed to participant's coinsurance
-
CopayAmtRequested number <double>
Requested amount will be used as participant's copay responsibility
-
CopayAmtReimbursed number <double>
Reimbursed amount will be used as participant's copay responsibility
-
BenefitMaxMetAmtRequested number <double>
On an FX or TC, this is the requested amount that is being denied by the insurance company due to the benefit being maxed out in number of visits or limit (such as a limit of 20 Physical Therapy visits per year). WCA can be configured to reimburse this amount since it would otherwise be covered by insurance were it not for the limit.
-
BenefitMaxMetAmtReimbursed number <double>
On an FX or TC, this is the reimbursed amount that is being denied by the insurance company due to the benefit being maxed out in number of visits or limit (such as a limit of 20 Physical Therapy visits per year). WCA can be configured to reimburse this amount since it would otherwise be covered by insurance were it not for the limit.
-
ExcessAmtRequested number <double>
The participant's Excess Amount responsibility that was requested
-
ExcessAmtReimbursed number <double>
The participant's Excess Amount responsibility that was reimbursed
-
NotCoveredAmtRequested number <double>
The amount the insurance carrier deemed as "not covered" by insurance but was still requested. It can be used in adjudication as a participant reimbursable liability amount.
-
NotCoveredAmtReimbursed number <double>
The amount the insurance carrier deemed as "not covered" by insurance but was still reimbursed. It can be used in adjudication as a participant reimbursable liability amount.
-
AboveRCAmtRequested number <double>
On an FX or TC claim or a participant “save expense” for later, this is the requested amount above the usual and customary rate – for an out of network claim, it’s the amount the provider billed minus the insurance allowed amount. WCA can be configured to reimburse this amount by service category tier.
-
AboveRCAmtReimbursed number <double>
On an FX or TC claim or a participant “save expense” for later, this is the reimbursed amount above the usual and customary rate – for an out of network claim, it’s the amount the provider billed minus the insurance allowed amount. WCA can be configured to reimburse this amount by service category tier.
-
InsurancePaidAmount number <double>
This is the amount that the insurance provide paid of the billed amount for the service and is only used for display; no system business rules are performed using this amount.
-
PlanID string
Unique ID of the benefit plan
-
AccTypeCode string
The Account Type Code for the transaction, such as FSA, FS2, etc.
-
PlanStartDate string
Date when the plan starts
-
PlanEndDate string
Date when the plan ends
-
MerchantName string
Merchant Name of merchant associated with provider
-
MerchantID string
Unique identification ID for a provider or vendor
-
MCC string
Merchant category code used to create transaction
-
OriginalMCC string
MCC attached while initiating claim
-
Amount number <double>
The purpose of this field varies, depending on the Type Code. TC Claim (5) or Member Expense (4): Total Patient Responsibility Amount. Manual Claim (3): Original claim amount. If Denied or (pended and has pended comment): EligibleAmt + TxnAmtPended + TxnAmtDenied HSA Bill Pay (10): Txn Amount. FX Claims (1): Total Reimbursed Amount
-
TransactionCode integer <int32>
Code to identify the type of transaction. 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
-
TransactionStatus integer <int32>
Current status of the transaction. Valid values are 2 -Approved 4- Ineligible 8- Pending 16 - Resolved Employee Pay 32 - Resolved Payroll Deduction 64 - New 128 - Denied 256 - Unkown 512 - Resolved No Refund 1024 - Ineligible Partially Offset 2048 - Resolved Offset by Manual Claim 4096 - Unauthorized Refund 8192 - Insufficient Documentation 16384 - Entered but not reviewed 32768 - Reversed 65536 – Claim Reversal 131072 - Overpayment 262144 -Overpayment Partially Resolved 524288 – Overpayment Resolved 1048576 – Non-post 2097153 - Returned 4194304 - Resubmitted
-
TransactionDate string <date-time>
Date when the transaction is made
-
ConvFeePayerCode integer <int32>
Convenience Fee Payer Code. This indicates who paid a convenience fee. None = 1 (indicates no fee is set up) Tpa = 2 Employer = 3 Employee = 4
-
DisbursableBal number <double>
Disbursable Balance: The remaining balance in the account. For account types other than HSA, this is the “Disbursable Balance.” For HSAs, this is the “Available Balance”
-
IsDependent boolean
Indicates if a dependent is associated ` 1= Yes, 0 = No
-
EmpeDepID string
If the transaction is for the employee, this will be the Employee ID. If the transaction is for the dependent, this will be the Dependent ID.
-
OrgTransactionDate string <date-time>
Date when the original transaction occurred
-
SeqNum string
Unique number assigned to transactions in WCA
-
SettlementDate string
Date when the transaction settlement occurred
-
SettlementSeqNum integer <int32>
A unique identifier for the transaction generated by WCA during the settlement process.
-
TerminalCity string
-
TerminalState string
-
TerminalName string
-
TerminalOwnerName string
-
TerminalID string
-
TransactionKey string
Unique identifier applied to the Transaction in WCA.
-
CheckTraceNum string
If WCA has this information, this will be the check number for the reimbursement.
-
ReimbDate string
Date when the reimbursement occurred
-
ReimbMethod integer <int32>
Method used for reimbursement Undefined = -1, None = 0, Check = 1, DirectDeposit = 2, ExternalCheck = 3, ExternalDirectDeposit = 4,Card = 5, Payroll = 6
-
OffsetAmount number <double>
`The amount of the transaction that was eligible to be applied to a participant’s account but was used to offset a participant’s balance due for that account.
-
IsPartialAuth boolean
Indicates if the transaction is partially authorized. ` 1= Yes, 0 = No
-
Notes string
Notes entered by user related to the transaction
-
IsCheckReissued boolean
Indicates if the Check is reissued. 1 = Yes, 0 = No
-
SCC string
Service category code used to create transaction
-
SCCDesc string
Description to Service category code used to create transaction
-
DepositSubTypeID string
The sub-type code for an Other Deposit Sub-Type
-
TransactionDesc string
For claims, the SCC description + the Merchant name (Note: a
tag is included to separate the two fields). For Card transactions, the Merchant Name. For other transactions, the type of transaction -
DeniedAmount number <double>
The amount of the claim that was denied by the claims processor.
-
ExcludedAmount number <double>
The amount that was either paid from other accounts (or applied to DTR account) or the amount eligible to be reimburse was reduced by a business rule such as a Service Category %, Max Transaction amount or max total amount.
-
ExcludedReason string
The reason for the excluded amount on a claim. An excluded amount is due to a system business rule that reduces what is eligible for reimbursement such as an amount paid by a higher priority account or a max transaction amount.
-
LowFundsAmount number <double>
The amount that exceeded the participants balance at the time the transaction was processed.
-
EligibleAmount number <double>
The amount of the total claim minus the excluded, pending and denied amounts equals the Eligible Amount. Formula: Total Claim – Excluded Amount – Pended Amount – Denied Amount = Eligible Amount
-
DeductibleAmount number <double>
The amount that was applied to the Deductible for Deductible manager enabled plans.
-
PendedAmount number <double>
Amount of the claim that the claims processor needs additional information form the participant in order to approve or deny the claim Pended.
-
IsPayProvider boolean
Indicates if the transaction is associated with a pay provider. ` 1= Yes, 0 = No
-
CardProxyNum string
Proxy number of the card
-
ServiceStartDate string <date-time>
Start date of the service provided to the participant that the transaction is for
-
ServiceEndDate string <date-time>
Ending date of the service for the claim line provided to the participant
-
RecurrenceStartDate string <date-time>
For a recurring claim, indicates the start date for the recurrence
-
RecurrenceEndDate string <date-time>
For a recurring claim, indicates the end date for the recurrence
-
RecurrenceFrequency string
For a recurring claim, indicates the frequency of recurrence
-
RecurrenceNextRunDate string <date-time>
For a recurring claim, this is the date when the next recurring transaction will be made
-
RecurrenceLastRunDate string <date-time>
For a recurring claim, indicates the date when the last transaction of the series was made
-
RecurrenceMadeNum integer <int32>
For a recurring claim, this would be the total number of payments that are to be made
-
RecurrencePendingNum integer <int32>
For a recurring claim, this would be the number of payments remaining in the series
-
HSACodeDesc string
Refers to the IRS reporting category associated with the HSA account transaction, derived from the transaction type or the product partner HSA Status Code
-
RemainingBalanceDue number <double>
When a participant’s debit card transaction is marked as ineligible, or if a reimbursement is issued which is later reversed, the ineligible or reversed amount is tracked as a ‘balance due’ and the participant must pay it back. This field returns the amount the participant still owes.
-
IneligibleAmount number <double>
The Ineligible Amount of the transaction
-
IneligibleReason string
The reason the Ineligible Amount provided is ineligible.
-
OriginCode enum<string>
Origin Code indicates which way claims initiated - Mobile/Web Portal/eClaim
Possible values:None
POSCardSwipe
POSKeyedIn
POSPhonedIn
POSMbiSubmitted
ManualScreen
ManualEFT
ManualAgent
ParticipantManualScreen
ParticipantMobileScreen
HZDirect
eClaimManagerManual
eClaimManagerTPS
WebServiceClaim
-
OriginCodeDesc string
A human friendly description that corresponds to OriginCode
-
ReasonPendedForClaim string
Reason provided for pended claims
-
PendedCommentForClaim string
Text of any comments added to the claim when an amount was marked pended
-
ReasonDeniedForClaim string
Reason provided for denied claims
-
DeniedCommentForClaim string
Comment added to claim by claims processor explaining why it was denied
-
ProviderName string
Name of the pay provider
-
ProviderAddressLine1 string
First line of the provider’s mailing address
-
ProviderAddressLine2 string
Second line of the provider’s mailing address
-
ProviderCity string
City associated with the provider’s mailing address
-
ProviderState string
State associated with the provider’s mailing address
-
ProviderZipCode string
Zip Code associated with the provider’s mailing address
-
TxnHoldKey integer <int32>
A unique identifier key generated by WCA when a hold is created, used to identify the hold information
-
TaskScheduleKey integer <int32>
For a recurring claim, this is a unique identifier for task scheduling for a recurring payment
-
HSAHoldBalance number <double>
On hold amount balance of the HSA account
-
PostingDate string <date-time>
Date when the transaction is posted
-
CardNumber string
Card proxy number of the Participant
-
OrigTxnAmt number <double>
Origin Txn Amount is total of approved amt,pended amt and denied amt
-
OrigTxnOnholdDate string <date-time>
Date when the claim was put on hold
-
CheckTraceNumStatus string
Returns the status of a check reimbursemement. If transaction is an HSA Import, Auto Deposit, or Other deposit, this field will be empty. If the check trace number exists and has been reissued, this field return the check trace number + a superscript “r” (i.e., 1234r) If the check trace number exists and this was an external check, this field will return the check trace number + a superscript “e” (i.e., 1234e) If the transaction was submitted manually, and was not denied, this will return “Pending Reimbursement" If the transaction was submitted manually, was not denied, and the reimbursement method is card, this will return “Card” If the transaction was submitted manually, was not denied, and the reimbursement method is external check, this will return “Pending External Reimbursement” If the transaction was submitted manually, is fully offset, and fully deductible, this will return “Offset / Deductible” If the transaction was submitted manually and is fully offset and overpayment is resolved, this will return “Offset” If the transaction was submitted manually and is fully deductible, this will return “Deductible” If the transaction was submitted manually, is partially offset and the reimbursement method is external check or external direct deposit, this will return the check trace number with a superscript “e” + “ / Offset” (i.e., “1234e / Offset”) If the transaction was submitted manually, is partially offset, the reimbursement method is check or direct deposit, and the check has been reissued, this will return the check trace number with a superscript “r” + “ / Offset” (i.e., “1234r / Offset”) If the transaction was submitted manually, is partially offset, and a check trace number exists, this will return the check number + “ / Offset” (i.e., “1234 / Offset”) If the transaction was submitted manually, is partially offset, the reimbursement method is external check or external direct deposit, and a check trace number doesnot exist, this will return “Pending External Reimbursement / Offset” If the transaction was submitted manually, reimbursememt method is check, direct deposit, or payroll, the transaction is partially offset, the overpayment is partially resolved, and there is no check trace number, this will return “Pending Reimbursement / Offset” If the transaction was submitted manually, reimbursement is set to “None,” the transaction is partially offset, and the overpayment is partially resolved, this will return “None / Offset” If the transaction does not meet any of the above criteria but a check trace number exists, this will return the check trace number. Otherwise, this field will be empty.
-
ReimbAmt number <double>
Total Amount of transaction which got reimbursed
-
TxnAmtOrig number <double>
Transaction amount entered when the claim or transaction was first entered. The actual transaction amount may be different after adjustments.
-
ApprovedAmount number <double>
The Approved amount is the amount that was debited from (refund: credited to) for this adjudicated claim
-
ReceiptsInfo array <object>
Details of attached receipt for claims
-
TpaId string
A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
-
FileKey integer <int32>
A system generated ID used to identify the receipt file.
-
DocId string
A system generated ID created when a file is submitted through a document queue instead of by a participant.
-
DocDisplayName string
Document Display Name
-
OriginalFileName string
Original File Name
-
UploadDate string <date-time>
The date the receipt file was uploaded.
-
-