Get transaction details
Get transaction details - Added TaxYear, Pre tax amount and Post tax amount
-
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
-
transactionid string
A unique identifier the transaction, generated by WCA when the transaction was first inserted
-
setldate string
Date the Transaction was finalized in WCA- Settlement Date
-
seqnum integer <int32>
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.
-
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 description, 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.
-
TxnTotalAmount number <double>
-
CopayAmount number <double>
-
CoinsuranceAmount number <double>
-
EmployeePaidAmount number <double>
-
PreviousPaidAmount number <double>
-
ReimbursableAmount number <double>
-
ExcludedReasonDesc string
-
TaxYear string
Tax Year
-
PreTaxAmt number <double>
Pre Tax Amount
-
PostTaxAmt number <double>
Post Tax Amount
-
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.
-
ErrorCode integer <int32>
Error Code
-
ErrorDesc string
Error Description
-
TrackingNumber string
Tracking Number
-
ExternalClaimID string
Unique ID of the external claims
-
ServiceCategoryTier integer <int32>
Service category tier if multiple SCC attached to it
-
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>
Amount applicable for creating claims
-
DeductibleAmtRequested number <double>
Requested amount will be used as the participant's deductible responsibility
-
DeductibleAmtReimbursed number <double>
Reimbursed amount will be used as the participant's deductible responsibility
-
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>
Requested amount will be used as the participant's Excess Amount responsibility
-
ExcessAmtReimbursed number <double>
Reimbursed amount will be used as the participant's Excess Amount responsibility
-
NotCoveredAmtRequested number <double>
Requested amount which was not covered by the insurance plan
-
NotCoveredAmtReimbursed number <double>
Reimbursed amount which was not covered by the insurance plan
-
AboveRCAmtRequested 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.
-
AboveRCAmtReimbursed 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.
-
InsurancePaidAmount number <double>
Amount paid for insurance
-
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>
Transaction Amount
-
TransactionCode integer <int32>
Code to identify the nature/type of transaction
-
TransactionStatus integer <int32>
Current status of the transaction
-
TransactionDate string <date-time>
Date when the transaction is made
-
ConvFeePayerCode integer <int32>
Convenience Fee Payer Code: None = 1, Tpa = 2, Employer = 3, Employee = 4
-
DisbursableBal number <double>
Amount disbursed till now for this account
-
IsDependent boolean
Indicates if a dependent is associated ` 1= Yes, 0 = No
-
EmpeDepID string
Employee's Dependent ID
-
OrgTransactionDate string <date-time>
Date when the original transaction occurred
-
SeqNum string
Sequence number to transaction when multiple transaction created
-
SettlementDate string
Date when the transaction settlement identified
-
SettlementSeqNum integer <int32>
In case of split transaction, this sequence number can identify the transaction uniquely among the set of transactions
-
TerminalCity string
Terminal City
-
TerminalState string
Terminal State
-
TerminalName string
Terminal Name
-
TerminalOwnerName string
Terminal Owner Name
-
TerminalID string
Terminal ID
-
TransactionKey string
Unique identifier key to store the transaction
-
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>
Balance due amount
-
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
A unique text ID of the subtype
-
TransactionDesc string
Quick description which can show the purpose of the transaction
-
DeniedAmount number <double>
Amount denied in FX claim
-
ExcludedAmount number <double>
Amount not considered for reimbursement
-
ExcludedReason string
Reason to excluding the amount for a claim
-
LowFundsAmount number <double>
Indicate low fund balance in account
-
EligibleAmount number <double>
Amount eligible for FX claim
-
DeductibleAmount number <double>
Amount will be used as the participant's deductible responsibility
-
PendedAmount number <double>
Amount provided to create pending claims
-
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 transaction
-
ServiceEndDate string <date-time>
End date of the transaction
-
RecurrenceStartDate string <date-time>
Start date of the recurring claims
-
RecurrenceEndDate string <date-time>
End date of the recurring claim
-
RecurrenceFrequency string
Provides the information on how frequent the recurrent transaction occurs. Example: Daily, Weekly, Monthly
-
RecurrenceNextRunDate string <date-time>
Date when the next recurrence transaction will occurr
-
RecurrenceLastRunDate string <date-time>
Date when the last recurrence transaction occurred
-
RecurrenceMadeNum integer <int32>
It is equivalent to RecurrenceTotalNumber
-
RecurrencePendingNum integer <int32>
Number of recurrence transaction pending
-
HSACodeDesc string
Description related to the HSA plan
-
RemainingBalanceDue number <double>
Balance due amount from the employee account
-
IneligibleAmount number <double>
Ineligible amount is amount denied in card transaction
-
IneligibleReason string
Reason for ineligible amount in card transaction
-
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
Description for which way claims initiated
-
ReasonPendedForClaim string
Reason provided for pended claims
-
PendedCommentForClaim string
Description for creating pended claims
-
ReasonDeniedForClaim string
Reason provided for denied claims
-
DeniedCommentForClaim string
Comment given on denial of FX claim
-
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>
Unique identifier key to store the on hold information of a transaction
-
TaskScheduleKey integer <int32>
Unique identifier key to store the task schedule
-
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>
Amount of transaction which got reimbursed
-
TxnAmtOrig number <double>
Transaction amount enterd first time while creating claim
-
ApprovedAmount number <double>
Amount approved for the Transaction
-
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.
-