Administrative APIs | REST

Version:
Download Open API Specification

Get Transaction Info

https://api.wealthcare.com/system/Services/Transaction/Adjudication/{tpaId}/TransactionInfo/Details

This operation returns information about a given transaction.

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

  • settlementDate string <date-time> Required

    Format is YYYYMMDD. Date the transactions 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.

  • settlementSequenceNumber integer <int32> Required

    WCA assigns a sequence number within the settlement date for every transaction that it receives. Using the settlement date and the settlement sequence number is a way to uniquely identify a transaction within the system.

  • verboseMode boolean

    Optional, if set to true, the method may return more details as to why a query did not return any records.

  • AccountTypeCode string

    Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)

  • CheckNumber integer <int32>

    The check/trace

  • DisplayDate string <date-time>

    format is yyyy-mm-dd. The date displayed to the employer/employee for the transaction

  • MerchantName string

    Name assigned to the Merchant ID, which appears on the transaction. If this field is blank and is for a Card transaction, WealthCare Admin populates it with the description for the Original Merchant Type Code (MTC) field. All refund codes, whether for Card or manual transactions, are listed under Transaction Code 14. This change affects only Card transactions. Thus, if the Merchant Name field is blank, the MTC description will appear only for the Card transactions. This field will be populated for charge backs as follows when a Code 14 Card Refund has been identified as a charge back transaction: Initial charge back - 'PROV CRED - merchant name' Reversal - 'CRED REVS - merchant name'

  • ServiceEndDate string <date-time>

    Format is yyyy-mm-dd. Ending Date of Services for the transaction. The actual date that the cardholder had the service provided.

  • ServiceStartDate string <date-time>

    Format is yyyy-mm-dd. Beginning Date of Services for the transaction. The actual date that the cardholder had the service provided.

  • SettlementDate string

    Format is YYYYMMDD. Date the transactions 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.

  • SettlementSequenceNumber integer <int32>

    WCA assigns a sequence number within the settlement date for every transaction that it receives. Using the settlement date and the settlement sequence number is a way to uniquely identify a transaction within the system.

  • StatusCode string

    A code used to provide more detail about the transaction. Refer to the Transaction Status Code table for more information.

  • TransactionStatus enum<string>

    Status of the transaction.

    Possible values: Approved Ineligible Pending ResolvedEmployeePay ResolvedPayrollDeduction New Denied Unknown ResolvedNoRefund IneligiblePartiallyOffset ResolvedOffsetbyManualClaim InsufficientDocumentation EnteredNotReviewed Reversed ClaimReversal Overpayment OverpaymentPartiallyResolved OverpaymentResolved NonPost Returned Resubmitted
  • TransactionAmount number <double>

    Amount of this transaction.

  • TransactionDate string <date-time>

    Format is yyyy-mm-dd. Date of the transaction.

  • TpaId string

    A unique identifier for your administrator instance, generated by WCA when the instance was first set up. The API will use the TPA ID associated with the username making the call if not sent.

  • RemainingAmount number <double>

    If using offset capability, this will be the offset amount. This is the amount remaining after offsetting. For completely offset transactions, the amount will be 0.

  • DocumentTrackingNumbers string

    WCA generated unique number to identify receipt notification or reminder letter documents in which this transaction was shown. Each tracking number is separated by a pipe (|) character.

  • PayProviderFlag string

    Indicates whether the transaction should be reimbursed to a provider or directly to the participant. No = Reimbursement should go to participant. Yes = Reimbursement should go to provider.

  • ProviderID string

    identifier for the Provider, as entered into WCA when the provider was created

  • PatientID string

    The provider’s patient account number

  • ProviderAddress1 string

    Address line 1 associated with the provider’s mailing address

  • ProviderAddress2 string

    Address line 2 associated with 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

  • ProviderZip string

    Zip Code associated with the provider’s mailing address

  • ProviderPhone string

    The phone number for the provider