Add HSA payment

https://api.wealthcare.com/participant/services/participant/hsa/payments/{tpaId}/{employerId}/{participantId}

This API operation is not for partner use. Please contact Alegeus with any questions.

Path parameters

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

Query parameters

decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

Request body

TpaId string

Unique identifier WCA assigns to you
EmployerId string

Unique identifier for employer
EmpeKey integer <int32>

Unique key identifier for employee
FlexAcctKey integer <int32>

Unique key identifier for flex account
ServiceStartDte string <date-time>

Beginning date of services for the transaction
ServiceEndDte string <date-time>

Ending date of services for the transaction
TxnCde integer <int32>

Code signifying which type of transaction is taking place { HSAOnlinePayment = 13 }
TxnOriginCde enum<string>

Origin of the transaction { Manual screen = 50 , Manual EFT = 51 , Manual agent = 52, Participant Manual Screen = 53 }

Possible values: None POSCardSwipe POSKeyedIn POSPhonedIn POSMbiSubmitted ManualScreen ManualEFT ManualAgent ParticipantManualScreen ParticipantMobileScreen HZDirect eClaimManagerManual eClaimManagerTPS WebServiceClaim
CardHolderDisplay boolean

Option to display the transaction in the participant portal { No = 0, Yes = 1 }
ClaimDesc string

Claim / provider description
ClaimStatus enum<string>

Status of claim

Possible values: All Entered_Not_Reviewed Reviewed_Receipt_Required Reviewed_Insufficient_Documentation Reviewed_Pending_Approval Approved Denied
TxnAmt number <double>

Amount of the payment per pay cycle
ClaimKey integer <int64>

Unique key identifier for claim
Notes string

Memo / Notes
TrackingNum string

You can assign and use a number to identify specific claims
ReimbModeCde enum<string>

Method for reimbursing an employee or provider for this transaction { Check = 1, DirectDeposit = 2 }

Possible values: Undefined None Check DirectDeposit ExternalCheck ExternalDirectDeposit Card Payroll
ManualClaimNum integer <int64>

A system generated number assigned to a manual claim once that claim is successfully submitted
ErrorCde integer <int32>

Error code
AcctStatusCde enum<string>

Status of the Card holder's account

Possible values: All New Active TempInactive PermInactive Terminated Enrollment
AcctTypeCde string

The digit code for type of benefit plan or account
DisplayDate string

Date displayed to the employer or employee
TxnOptions enum<string>

Transaction options

Possible values: None IncludeNoteInReceiptNotificationLetter ResolveRefund IncludeNoteInDenialLetter GenerateDenialLetter IsDuplicate DenialLetterReportKeyGenerated WasChargedBack IsAChargeback ChargebackWasReversed IsAChargebackReversal EligibleForPOSOffset ManualClaimFullyOffset ManualClaimPartiallyOffset ReimbLetterGenerated ReissueCheckPending PartialAuthInd PartialAuthorized HideOrigOnHoldTxn CheckVoided IiasMerchant CheckReissued TxnReissued OverrideSuspendActivity OnHoldFlg DenialOverride ReduceForBalanceMax BypassDeductibleRule PrimaryRolloverTxn FixedEmprFundingDeposit SplitTxn ByPassPercentCoverage EnforceParticipantEligibility EnforceAccountEligibility ManualClaimFullyDeductible PendingVerify CrossOverClaim SkipDuplicateClaimCheck PayProvider PendingLetter2 Reprocessed PendedWorkflow NachaGenearated CurrentReprocessed EmployerEnteredDeposits PayrollFundingDeposit FutureDeposited PendingDepositProcessed TxnWasReimbursed PendingExternalDepositVoid PriorYearContribution OverpaymentPartiallyResolved OverpaymentResolved CopayFirstApplied HideFromReports AutoDepositAgentDeposit ExcludeFromEmployerFunding PayrollNacha ForceExternalNacha OriginatedFromTPSEntry OriginatedFromEClaims CardProcessed SCTierAmountFeatureEnabled EmailSentForPayrollFunding
InsertDte string <date-time>

Insert date of the payment into the system
InsertUserIdKey integer <int32>

Unique key identifier for the user inputting the payment
UpdateDte string <date-time>

Last update date of payment
UpdateUserIdKey integer <int32>

Unique key for the last user to make changes to a payment
ProviderId string

Unique identifier of the provider
ProviderDesc string

Claim / provider description
PayProviderKey integer <int32>

Unique identifier for a pay provider
PatientIdNum string

Patient Id number
PatientIdNumSecure string

Encrypted patient id number
TaskSchName string

Name given to a scheduled task
TaskSchKey integer <int32>

Unique key identifier for task scheduling
RecurrenceFrequency enum<string>

Indicates whether the claim will be a recurring claim or not, and what the recurrence is

Possible values: All None Daily Weekly BiMonthly Monthly Quarterly Yearly SemiMonthly BiWeekly Once
DayOfWeek integer <int32>

Day of the week a recurring payment will be made
DayOfMonth integer <int32>

The date of which a recurring payment will be made
StartDte string <date-time>

The date for the first recurrence of the claim
EndDte string <date-time>

The date for the last recurrence of the claim
Standard boolean

Set to true for expenses
TaskSchTypeCde enum<string>

Type of task schedule { HSAOnlinePayment = 13 }

Possible values: None Report ReceiptNotify ReminderNotify DenialLetter ReimbursementLetter HsaEligExport HsaTxnExport HsaCardExport ReimbursementSchedule ParticipantCommunication EmployerFunding RecurringClaim HSAOnlinePayment HsaAchReturn HsaCheckReturn HsaLockboxReturn HsaTaxForm1099SA HsaTaxForm5498SA BalanceRepayment InterestDeposit InterestRedistributionDeposit
LastRunStatusCde enum<string>

The task result for the last time the task was run

Possible values: All None Incomplete Complete Failed CompleteWithNachaGeneration CompleteWithInvoiceGeneration
TaskScheduleOptions enum<string>

Task schedule options { None = 0, StopSchedule = 8, RecurringNumOfPaymentsSet = 16, CompleteSchedule = 32 }

Possible values: None EncryptFile ArchiveFile GenerateUsingODS StopSchedule RecurringNumOfPaymentsSet CompleteSchedule
RecurrenceStartDte string <date-time>

The date for the first recurrence of the claim
RecurrenceEndDte string <date-time>

The date for the last recurrence of the claim
NoOfPayments integer <int32>

Number of payments that have been made
TotalRecurrence integer <int32>

Number of payments that are to be made
PendingRecurrence integer <int32>

The number of recurrences left before the scheduled end date
RecurrenceNextRunDte string <date-time>

Next date that the recurrence will happen
Claimant string

Full name of the claimant
DataPartnerId string

Unique identifier for the Product Partner
LastRunDte string <date-time>

Date that the recurring payment was last run