Card Transaction Event

The card transaction event is sent when a card transaction is approved or denied. This event type is only available to administrators. When subscribing to this event, use the following event source and event type in the setup of the subscription.

Source	com.alegeus.events.wca
Type	CardTransaction

This event contains the following fields that are wrapped in the Event Envelope:

tpaId string

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

Max Length: 6
employerId string

A unique identifier for the employer.

Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

Max Length: 18
employeeId string

The identifier for the participant who is associated with this card transaction.

Max Length: 30
dependentId string

A unique identifier for a dependent. This is only sent if the card transaction originated from a dependent's card.

Max Length: 30
cardProxyNumber string

The card proxy number associated with the card used for this transaction.

Max Length: 19
accountId string

A 10-digit unique identifier representing the benefit account for which this transaction was processed.

Max Length: 10
transactionId string

A tracking number generated by WCA used to identify the transaction. In cases of split transactions, this value will not be unique, as all related transactions will share the same transaction ID.

Max Length: 28
splitSequenceNumber integer

In the case of a split transaction, this is used to differentiate the individual line items. The related transactions will share the same transactionID but have unique splitSequenceNumber values.

origin object

The channel through which the card transaction was originated.

Code	Description
0	None
1	POSCardSwipe
2	POSKeyedIn
3	POSPhonedIn
4	POSMbiSubmitted
50	ManualScreen
51	ManualEFT
52	ManualAgent
53	ParticipantManualScreen
54	ParticipantMobileScreen
55	HZDirect
56	eClaimManagerManual
57	eClaimManagerTPS
58	WebServiceClaim

code enum<integer>

Contains the Code from the above table for this transaction.
description enum<string>

Contains the Description from the above table for this transaction.

transactionCode object

The type of transaction requested by the merchant, indicating how the transaction should be processed.

Code	Description
10	Purchase
11	PreAuth
12	ForcePost
14	Refund
24	Void

code enum<integer>

Contains the Code value from the above table.
description enum<string>

Contains the Description value from the above table.

transactionAmount string

The monetary value authorized for the transaction at the point of sale. In the case of a split transaction, this would reflect the authorized amount for an individual split.

Max Length: 19
lowFundAmount string

The monetary value that exceeded the account balance at the time of the transaction.

Max Length: 19
excludedAmount string

The monetary value that was either paid from other accounts (or applied to DTR account) or the amount eligible to be reimbursed which was reduced by an autosubstantiation rule.

Max Length: 19
deniedAmount string

The monetary value of a transaction that was attempted but not approved. In the case of a split transaction, this would reflect the denied amount for an individual split.

Max Length: 19
denialReason object

The reason for the denied amount.
- code string
  
  The reason code for the denied amount.
  
  Max Length: 4
- status string
  
  A human readable explanation of the denial reason.
  
  Max Length: 255
requestedAmount string

The monetary value requested from the merchant. In the case of a split transaction, this would the value considered across each split.

Max Length: 19

transactionStatus object

Indicates the current processing state or eligibility of the card transaction.

Code	Description	Effect	Status
AAA1	Authorized by WealthCare Admin. Approved by you from an AUP1 status.	Transaction is no longer pending and is considered adjudicated.	Approved
AAA2	Authorized by WealthCare Admin. Approved by you from an AUP2, AUP4, AUP6, AUPA, AUPB, AUPC, AUPD status.	Transaction is no longer pending and is considered adjudicated.	Approved
AAA3	Authorized by WealthCare Admin. Approved by you from an AUP5 status.	Transaction is no longer pending and is considered adjudicated.	Approved
AAA4	Authorized by WealthCare Admin. Approved via an auto review process.	Transaction is no longer pending and is considered adjudicated.	Approved
AAA5	Authorized by WealthCare Admin. Approved via the Pharmacy Claims adjudication process.	Transaction is no longer pending and is considered adjudicated.	Approved
AAA6	Authorized by WealthCare Admin. Approved via the Pharmacy Claims adjudication process.	Transaction is no longer pending and is considered adjudicated.	Approved
AAA7	Authorized by WealthCare Admin. Approved by you and Pharmacy Claims are linked to the transaction.	Transaction is no longer pending and is considered adjudicated.	Approved
AAA8	Authorized by WealthCare Admin. Approved via RealTime TPS Matching	Transaction is adjudicated.	Approved
AAA9	Authorized by WealthCare Admin. Approved by you and all claims are unlinked	Transaction is no longer pending and is considered adjudicated.	Approved
AUPI	Authorized by WealthCare Admin. It has not yet been reviewed by you.	Transaction is in pending file as a new transaction. Default status for a Force-Post transaction.	New
AUP2	Authorized by WealthCare Admin. Changed from an AUP1 status to pending, additional information required.	Transaction is in pending file as a pending transaction.	Pending
AUP3	Authorized by WealthCare Admin. Changed from an AUP1, AUP2, AUP4, AUP5, AUP6, AUP7, AUPA, AUPB, AUPC, or AUPD status to indicate, Pending has been deemed ineligible, waiting for reimbursement from the employee.	Transaction is in pending file as an ineligible transaction.	Ineligible
AUP4	Authorized by WealthCare Admin. Failed auto review parameters and set to Pending, as you specified.	Transaction is in pending file as a pending transaction.	Pending
AUP5	Authorized by WealthCare Admin. Failed auto review parameters and set to New, as you specified.	Transaction is in pending file as a new transaction.	New
AUP6	Authorized WealthCare Admin. Pended by you from an AUP5 status.	Transaction is in pending file as a pending transaction.	Pending
AUP7	Authorized by WealthCare Admin. Pended by you and Pharmacy Claims are linked to the transaction.	Transaction is in pending file as a pending transaction.	Pending
AUP8	Authorized by WealthCare Admin. Transaction Set to Pending by Agent after set # of days passed at adjudication template level	Transaction is in pending file as a pending transaction.	Pending
AUP9	Authorized by WealthCare Admin. Pended by you and all claims are unlinked.	Transaction is in pending file as a pending transaction.	Pending
AUPA	Authorized by WealthCare Admin. Receipt notification letter #1 generated because of Step A in Receipt Notification process.	Transaction is in pending file as a pending transaction.	Pending
AUPB	Authorized by WealthCare Admin. Receipt Notification letter #2 generated because of Step B in Receipt Notification process	Transaction is in pending file as a pending transaction.	Pending
AUPC	Authorized by WealthCare Admin. Receipt notification letter #3 generated because of Step C in Receipt Notification process.	Transaction is in pending file as a pending transaction.	Pending
AUPD	Authorized by WealthCare Admin. Receipt notification letter #3 generated because of Step C in Receipt Notification process. Card temporarily inactivated by WealthCare Admin. Inactivate letter was sent.	Transaction is in pending file as a pending transaction.	Pending
AUPE	Authorized by WealthCare Admin. Receipt notification letter #3 generated because of Step C in Receipt Notification process. Auto-set to ineligible status. Ineligible letter was sent.	Transaction is in pending file as an Ineligible transaction.	Ineligible
AUPl	Authorized by WealthCare Admin. Receipt notification Insufficient Documentation letter generated in Receipt Notification process. Manually set to Insufficient Documentation status. Insufficient documentation letter was sent. Note: The last letter of the AUPl code is lower case "L", not the numeral one (1).	Transaction is in pending file as an Insufficient Documentation transaction.	Insufficient Documentation
AUPM	Authorized by WealthCare Admin. Ineligible Notification Letter generated because of first step in Ineligible Transaction Requests and Notifications process (letter sent upon Card transaction being manually adjudicated to ineligible status).	Transaction is in pending file as an Ineligible transaction.	Ineligible
AUPN	Authorized by WealthCare Admin. Card Deactivation Letter generated because of second step in Ineligible Transaction Requests and Notifications process (letter sent after predefined number of days after first step).	Transaction is in pending file as an Ineligible transaction.	Ineligible
AUPO	Authorized by WealthCare Admin. Approved Letter generated because of third step in Ineligible Transaction Requests and Notifications process (letter sent after transaction adjudicated to Approved).	Transaction is removed from the pending file and is considered adjudicated.	Approved
AUPP	Authorized by WealthCare Admin. Resolved Letter generated because of fourth step in Ineligible Transaction Requests and Notifications process (letter sent after transaction adjudicated to Resolved).	Transaction is removed from the pending file and is considered adjudicated.	Resolved
AUPQ	Authorized by WealthCare Admin. Ineligible Notification Letter generated because of second step in Ineligible Transaction Requests and Notifications process (letter sent upon Card transaction being manually adjudicated to ineligible status and first letter already distributed).	Transaction is in pending file as an Ineligible transaction.	Ineligible
RES1	Authorized by WealthCare Admin. Claim deemed ineligible by you. Employee refunded the money to you.	Transaction is removed from the pending file and is considered adjudicated.	Resolved
UUU1	Declined by WealthCare Admin due to Response Code 12 (invalid MTC code).	Transaction does not appear in the pending file, stays in the Card Log File.	Declined
UUU2	Declined by WealthCare Admin due to Response Code other than 12 (invalid MTC code).	Transaction does not appear in the pending file, stays in the Card Log File.	Declined
UUU3	Manual transaction declined by WealthCare Admin		Declined
ROAA	Manual transaction, automatically generated by WealthCare Admin when a Card transaction's status is changed to Resolved (RES1 or RES2). Not generated when transaction status is changed to RES3.	Transaction refunds the account with the amount of the Resolved transaction.	Approved
ROUU	Attempted manual transaction, automatically generated by WealthCare Admin when a Card transaction's status is changed to Resolved (RES1 or RES2). Attempted refund fails, typically due to Permanently Inactive status.	Attempted refund fails, typically due to Permanently Inactive status.	Declined

code string

Contains the Code value from the above table.

Max Length: 4
status enum<string>

Contains the Status value from the above table.

error object
- code integer
  
  The error code for the transaction.
- description string
  
  Refers to the error description for the transaction.
  
  Max Length: 255
serviceDate string<date>

The start date of service for this transaction.

Date Format: yyyy-MM-dd

transactionDate string<date-time>

The date and time the transaction information was received from the merchant for authorization.

Date Format:	yyyy-MM-ddThh:mm:ss.fffz
Time Zone:	UTC

serviceCategory string

Based on the MCC, this field indicates the service category used for processing this transaction. Service categories are configured by the administrator in WCA.

Max Length: 10
serviceCategoryTier string

Based on the MCC, this field indicates the service category tier to which the service category belongs. Service category tiers are configured by the administrator in WCA.

Max Length: 10
isItemLevelAdjudication boolean

If true, this card transaction has at least one item that qualified for item level adjudication.
isIIAS boolean

If true, the merchant indicated to use IIAS for authorizing this transaction.
merchant object
- merchantName string
  
  The name of the merchant where the card transaction took place.
  
  Max Length: 50
- merchantId string
  
  An identifier for the merchant originating the transaction, designated by the merchant's payment processor or acquiring bank.
  
  Max Length: 15
- mcc string
  
  A 4-digit merchant category code used to classify the business of the merchant originating the transaction.
  
  Max Length: 4
- terminalId string
  
  An identifier for the specific terminal at the merchant used to originate the transaction.
  
  Max Length: 16
settlement object
- settlementDate string<date>
  
  The date that this transaction will be settled on.
  
  Date Format: yyyy-MM-dd
- settlementSequenceNumber integer
  
  The settlement sequence number for this transaction.
plan object
- planId string
  
  A unique identifier for the plan associated with the account used for processing the transaction. The Plan ID is set by the administrator when the plan is first configured in WCA.
  
  Max Length: 18
- startDate string<date>
  
  Based on the plan configuration, the date in which funds are first available for accounts associated with the plan.
  
  Date Format: yyyy-MM-dd
- endDate string<date>
  
  Based on the plan configuration, the date after which funds are not available to pay for services for accounts associated with the plan.
  
  Date Format: yyyy-MM-dd
isReversal boolean

If true, this card transaction represents a reversal of a previous transaction.
linkTransactionKey string

A unique identifier that links this reversal, refund or post transaction to the original transaction it is associated with.

Max Length: 28

{
  "tpaId": "T00881",
  "employerId": "HSAOW",
  "employeeId": "LOxton",
  "dependentId": null,
  "cardProxyNumber": "1100230410757386",
  "accountId": "0000000949",
  "transactionId": "1130000005-20250501-11484347",
  "splitSequenceNumber": 1,
  "origin": {
    "code": 2,
    "description": "POSKeyedIn"
  },
  "transactionCode": {
    "code": 11,
    "description": "PreAuth"
  },
  "requestedAmount": "10.0000",
  "transactionAmount": "10.0000",
  "lowFundAmount": "0.0000",
  "excludedAmount": "0.0000",
  "deniedAmount": "0.0000",
  "denialReason": {
    "code": null,
    "description": null
  },
  "transactionStatus": {
    "code": "AAA4",
    "status": "Approved"
  },
  "error": null,
  "serviceDate": "2025-05-01",
  "transactionDate": "2025-05-01T11:48:43.047Z",
  "serviceCategory": null,
  "serviceCategoryTier": null,
  "isItemLevelAdjudication": false,
  "isIIAS": false,
  "merchant": {
    "merchantName": "PRIMARY CARE DOC",
    "merchantId": "BBB",
    "mcc": "8011",
    "terminalId": "B28541866"
  },
  "settlement": {
    "settlementDate": "2025-05-01",
    "settlementSequenceNumber": 30000005
  },
  "plan": {
    "planId": "FSA",
    "startDate": "2025-02-01",
    "endDate": "2026-02-01"
  },
  "isReversal": false,
  "linkTransactionKey": null
}

{
  "tpaId": "T00881",
  "employerId": "HSAOW",
  "employeeId": "LOxton",
  "dependentId": null,
  "cardProxyNumber": "1100230410757386",
  "accountId": "0000000949",
  "transactionId": "1230000007-20250501-12040242",
  "splitSequenceNumber": 1,
  "origin": {
    "code": 1,
    "description": "POSCardSwipe"
  },
  "transactionCode": {
    "code": 12,
    "description": "ForcePost"
  },
  "requestedAmount": "2.0000",
  "transactionAmount": "2.0000",
  "lowFundAmount": "0.0000",
  "excludedAmount": "0.0000",
  "deniedAmount": "0.0000",
  "denialReason": {
    "code": null,
    "description": null
  },
  "transactionStatus": {
    "code": "AUP1",
    "status": "New"
  },
  "error": null,
  "serviceDate": "2025-05-01",
  "transactionDate": "2025-05-01T12:07:44.067Z",
  "serviceCategory": null,
  "serviceCategoryTier": null,
  "isItemLevelAdjudication": false,
  "isIIAS": false,
  "merchant": {
    "merchantName": "MASS GENERAL",
    "merchantId": "MGH",
    "mcc": "8062",
    "terminalId": "M27934357"
  },
  "settlement": {
    "settlementDate": "2025-05-01",
    "settlementSequenceNumber": 30000007
  },
  "plan": {
    "planId": "FSA",
    "startDate": "2025-02-01",
    "endDate": "2026-02-01"
  },
  "isReversal": false,
  "linkTransactionKey": "1230000007-20250501-12040240"
}

{
  "tpaId": "T00881",
  "employerId": "HSAOW",
  "employeeId": "LOxton",
  "dependentId": null,
  "cardProxyNumber": "1100230410757386",
  "accountId": "0000000949",
  "transactionId": "1130000003-20250501-11384558",
  "splitSequenceNumber": 1,
  "origin": {
    "code": 2,
    "description": "POSKeyedIn"
  },
  "transactionCode": {
    "code": 11,
    "description": "PreAuth"
  },
  "requestedAmount": "10.0000",
  "transactionAmount": "10.0000",
  "lowFundAmount": "0.0000",
  "excludedAmount": "0.0000",
  "deniedAmount": "0.0000",
  "denialReason": {
    "code": null,
    "description": null
  },
  "transactionStatus": {
    "code": "UUU2",
    "status": "Denied"
  },
  "error": null,
  "serviceDate": "2025-05-01",
  "transactionDate": "2025-05-01T11:38:45.057Z",
  "serviceCategory": null,
  "serviceCategoryTier": null,
  "isItemLevelAdjudication": false,
  "isIIAS": false,
  "merchant": {
    "merchantName": "SEAWORLD",
    "merchantId": "AAA",
    "mcc": "7998",
    "terminalId": "A53192551"
  },
  "settlement": {
    "settlementDate": "2025-05-01",
    "settlementSequenceNumber": 30000003
  },
  "plan": {
    "planId": "FSA",
    "startDate": "2025-02-01",
    "endDate": "2026-02-01"
  },
  "isReversal": false,
  "linkTransactionKey": null
}

{
  "tpaId": "T00881",
  "employerId": "HSAOW",
  "employeeId": "LOxton",
  "dependentId": null,
  "cardProxyNumber": "1100230410757386",
  "accountId": "0000000949",
  "transactionId": "1230000013-20250501-14593565",
  "splitSequenceNumber": 1,
  "origin": {
    "code": 0,
    "description": "None"
  },
  "transactionCode": {
    "code": 12,
    "description": "ForcePost"
  },
  "requestedAmount": "10.0000",
  "transactionAmount": "10.0000",
  "lowFundAmount": "0.0000",
  "excludedAmount": "0.0000",
  "deniedAmount": "0.0000",
  "denialReason": {
    "code": null,
    "description": null
  },
  "transactionStatus": {
    "code": "AUP2",
    "status": "Pending"
  },
  "error": null,
  "serviceDate": "2025-05-01",
  "transactionDate": "2025-05-01T14:59:35.067Z",
  "serviceCategory": null,
  "serviceCategoryTier": null,
  "isItemLevelAdjudication": false,
  "isIIAS": false,
  "merchant": {
    "merchantName": "MEDICAL DISP.",
    "merchantId": "DISP",
    "mcc": "2833",
    "terminalId": "D90535351"
  },
  "settlement": {
    "settlementDate": "2025-05-01",
    "settlementSequenceNumber": 30000013
  },
  "plan": {
    "planId": "FSA",
    "startDate": "2025-02-01",
    "endDate": "2026-02-01"
  },
  "isReversal": false,
  "linkTransactionKey": null
}

Card Transaction Event

AI Assistant Preview

AI Assistant ^Preview