Participant APIs | REST

Version:
Download Open API Specification

Insert contribution

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

Insert a new contribution for a specific participant identified by TPA ID, Employer ID, and Participant ID. This operation is used to record contributions to Health Savings Accounts (HSAs) and is essential for managing participant funding.

Request

Path parameters

Path parameters page anchor
  • tpaId string Required

    A unique identifier used to identify your admin instance. This value is system generated when 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

    Unique identifier for the participant whose features are being queried.

Query parameters

Query parameters page anchor
  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted and 0 for decrypted; defaults to 0 if not specified.

Request body

Request body page anchor
  • TpaId string

    Unique identifier assigned to the administrator

  • PendingContributionKey integer <int64>

    Unique key identifier for pending contribution

  • FlexAcctKey integer <int32>

    Unique key identifier for flex account

  • DepositTypeCdeEnumeration integer <int32>

    Enumeration of DepositTypeCde: Payroll = 1, Prefunded = 2, IndividualAmt = 3, IndividualAmtReset = 4, AnnualElection = 5, OtherDeposit = 6, FamilyOtherDeposit = 7, Rollover = 8, ExternalFunding = 9, HSATransfer = 10, AnnualElectionOverride = 11, AdminRolloverDeposit = 13, HSAIncentiveDeposit = 14

  • Notes string

    Additional notes for pending contributions

  • CardholderDisplayBoolean integer <int32>

    Option to display the contribution to the cardholder (No = 0, Yes = 1(Default))

  • DisplayDte string

    Date displayed to the employer or employee. Defaults to current date unless a date is provided

  • EffectiveDte string

    The date the pending contribution is applied to the account

  • DepositAmtTotal number <double>

    Employee + Employer amount

  • DepositAmtEmpe number <double>

    Amount deposited by the employee

  • AccessRolloverBucketsBoolean integer <int32>

    Legacy Field. Not in use

  • TxnOptionsEnumeration integer <int64>

    Enumeration of transaction options (None = 0, IncludeNoteInReceiptNotificationLetter = 1, ResolveRefund = 2, IncludeNoteInDenialLetter = 4, GenerateDenialLetter = 8, IsDuplicate = 16, DenialLetterReportKeyGenerated = 32, WasChargedBack = 64, IsAChargeback = 128, ChargebackWasReversed = 256, IsAChargebackReversal = 512, EligibleForPOSOffset = 1024, ManualClaimFullyOffset = 2048, ManualClaimPartiallyOffset = 4096, ReimbLetterGenerated = 8192, ReissueCheckPending = 16384, PartialAuthInd = 32768, PartialAuthorized = 65536, HideOrigOnHoldTxn = 131072, CheckVoided = 262144, IiasMerchant = 524288, CheckReissued = 1048576, TxnReissued = 2097152, OverrideSuspendActivity = 4194304, OnHoldFlg = 8388608, DenialOverride = 16777216, ReduceForBalanceMax = 33554432, BypassDeductibleRule = 67108864, PrimaryRolloverTxn = 134217728, FixedEmprFundingDeposit = 268435456, SplitTxn = 536870912, ByPassPercentCoverage = 1073741824, EnforceParticipantEligibility = 2147483648, EnforceAccountEligibility = 4294967296, ManualClaimFullyDeductible = 8589934592, PendingVerify = 17179869184, CrossOverClaim = 34359738368, SkipDuplicateClaimCheck = 68719476736, PayProvider = 137438953472, PendingLetter2 = 274877906944, Reprocessed = 549755813888, PendedWorkflow = 1099511627776, NachaGenearated = 2199023255552, CurrentReprocessed = 4398046511104, EmployerEnteredDeposits = 8796093022208, PayrollFundingDeposit = 17592186044416, FutureDeposited = 35184372088832, PendingDepositProcessed = 70368744177664, TxnWasReimbursed = 140737488355328, PendingExternalDepositVoid = 281474976710656, PriorYearContribution = 562949953421312, OverpaymentPartiallyResolved=1125899906842624, OverpaymentResolved = 2251799813685248, CopayFirstApplied = 4503599627370496, HideFromReports = 9007199254740992, AutoDepositAgentDeposit = 18014398509481984, ExcludeFromEmployerFunding = 36028797018963968, PayrollNacha = 72057594037927936, ForceExternalNacha = 144115188075855872, OriginatedFromTPSEntry = 288230376151711744, OriginatedFromEClaims = 576460752303423488, CardProcessed = 1152921504606846976, SCTierAmountFeatureEnabled = 2305843009213693952, EmailSentForPayrollFunding = 461168601842738790)

  • DuplicateDepCheckBoolean integer <int32>

    If set to yes, WCA will fail the deposit if it matches an existing deposit’s Effective Date and amount. 0 = No 1 = Yes, validate on effective date and amount 2 = Yes, validate on tracking number

  • PendingContribStatusEnumeration integer <int32>

    Enumeration of Pending Contribution Statuses (None = 0, Pending = 1, InProcess = 2, Failed = 3, PendingApproval = 4, PendingAccountOpening = 5, FailedDuplicateDeposit = 6, FailedActivityValidation = 7)

  • PendingContributionYearEnumeration integer <int32>

    Enumeration of Pending Contribution Years (None = 0, PriorYear = 1, CurrentYear = 2)

  • ExternalBankAcctKey integer <int64>

    Unique key for external bank account

  • ConfirmationNumber string

    System generated number for external contributions

  • ExternalAccountDebitDte string <date-time>

    Date the pending contribution will begin processing against the HSA account and the external bank account will be debited

  • ExternalBankAccount object
    • TpaId string

      Unique identifier assigned to the administrator

    • ExtBankAcctKey integer <int64>

      Unique key identifier for external bank account

    • BankAccountName string

      Name associated with the logical bank account Must be unique within the administrator

    • BankAcctNickName string

      Name given to external bank account to easily identify by

    • BankAcctTypeCdeEnumeration integer <int32>

      Defaults to 1 if left blank (None = 0, Checking = 1, Savings = 2, General Ledger = 3)

    • BankAccountNumber string

      Bank account number Required if account usage includes ACH

    • BankRoutingNumber string

      Bank account routing number Required if account usage includes ACH

    • BankAccountStatusCdeEnumeration integer <int32>

      (New = 0, Confirmed = 1, PendingValidation = 2, ValidationRequired = 3, FixAccount = 4)

    • ConfirmDte string <date-time>

      Date the employee provided the microtransaction amounts to confirm the account is valid

    • DataPartnerId string

      Unique identifier for the Product Partner

Response

Response body

Response body page anchor
  • TpaId string

    Unique identifier assigned to the administrator

  • PendingContributionKey integer <int64>

    Unique key identifier for pending contribution

  • FlexAcctKey integer <int32>

    Unique key identifier for flex account

  • DepositTypeCdeEnumeration integer <int32>

    Enumeration of DepositTypeCde: Payroll = 1, Prefunded = 2, IndividualAmt = 3, IndividualAmtReset = 4, AnnualElection = 5, OtherDeposit = 6, FamilyOtherDeposit = 7, Rollover = 8, ExternalFunding = 9, HSATransfer = 10, AnnualElectionOverride = 11, AdminRolloverDeposit = 13, HSAIncentiveDeposit = 14

  • Notes string

    Additional notes for pending contributions

  • CardholderDisplayBoolean integer <int32>

    Option to display the contribution to the cardholder (No = 0, Yes = 1(Default))

  • DisplayDte string

    Date displayed to the employer or employee. Defaults to current date unless a date is provided

  • EffectiveDte string

    The date the pending contribution is applied to the account

  • DepositAmtTotal number <double>

    Employee + Employer amount

  • DepositAmtEmpe number <double>

    Amount deposited by the employee

  • AccessRolloverBucketsBoolean integer <int32>

    Legacy Field. Not in use

  • TxnOptionsEnumeration integer <int64>

    Enumeration of transaction options (None = 0, IncludeNoteInReceiptNotificationLetter = 1, ResolveRefund = 2, IncludeNoteInDenialLetter = 4, GenerateDenialLetter = 8, IsDuplicate = 16, DenialLetterReportKeyGenerated = 32, WasChargedBack = 64, IsAChargeback = 128, ChargebackWasReversed = 256, IsAChargebackReversal = 512, EligibleForPOSOffset = 1024, ManualClaimFullyOffset = 2048, ManualClaimPartiallyOffset = 4096, ReimbLetterGenerated = 8192, ReissueCheckPending = 16384, PartialAuthInd = 32768, PartialAuthorized = 65536, HideOrigOnHoldTxn = 131072, CheckVoided = 262144, IiasMerchant = 524288, CheckReissued = 1048576, TxnReissued = 2097152, OverrideSuspendActivity = 4194304, OnHoldFlg = 8388608, DenialOverride = 16777216, ReduceForBalanceMax = 33554432, BypassDeductibleRule = 67108864, PrimaryRolloverTxn = 134217728, FixedEmprFundingDeposit = 268435456, SplitTxn = 536870912, ByPassPercentCoverage = 1073741824, EnforceParticipantEligibility = 2147483648, EnforceAccountEligibility = 4294967296, ManualClaimFullyDeductible = 8589934592, PendingVerify = 17179869184, CrossOverClaim = 34359738368, SkipDuplicateClaimCheck = 68719476736, PayProvider = 137438953472, PendingLetter2 = 274877906944, Reprocessed = 549755813888, PendedWorkflow = 1099511627776, NachaGenearated = 2199023255552, CurrentReprocessed = 4398046511104, EmployerEnteredDeposits = 8796093022208, PayrollFundingDeposit = 17592186044416, FutureDeposited = 35184372088832, PendingDepositProcessed = 70368744177664, TxnWasReimbursed = 140737488355328, PendingExternalDepositVoid = 281474976710656, PriorYearContribution = 562949953421312, OverpaymentPartiallyResolved=1125899906842624, OverpaymentResolved = 2251799813685248, CopayFirstApplied = 4503599627370496, HideFromReports = 9007199254740992, AutoDepositAgentDeposit = 18014398509481984, ExcludeFromEmployerFunding = 36028797018963968, PayrollNacha = 72057594037927936, ForceExternalNacha = 144115188075855872, OriginatedFromTPSEntry = 288230376151711744, OriginatedFromEClaims = 576460752303423488, CardProcessed = 1152921504606846976, SCTierAmountFeatureEnabled = 2305843009213693952, EmailSentForPayrollFunding = 461168601842738790)

  • DuplicateDepCheckBoolean integer <int32>

    If set to yes, WCA will fail the deposit if it matches an existing deposit’s Effective Date and amount. 0 = No 1 = Yes, validate on effective date and amount 2 = Yes, validate on tracking number

  • PendingContribStatusEnumeration integer <int32>

    Enumeration of Pending Contribution Statuses (None = 0, Pending = 1, InProcess = 2, Failed = 3, PendingApproval = 4, PendingAccountOpening = 5, FailedDuplicateDeposit = 6, FailedActivityValidation = 7)

  • PendingContributionYearEnumeration integer <int32>

    Enumeration of Pending Contribution Years (None = 0, PriorYear = 1, CurrentYear = 2)

  • ExternalBankAcctKey integer <int64>

    Unique key for external bank account

  • ConfirmationNumber string

    System generated number for external contributions

  • ExternalAccountDebitDte string <date-time>

    Date the pending contribution will begin processing against the HSA account and the external bank account will be debited

  • ExternalBankAccount object
    • TpaId string

      Unique identifier assigned to the administrator

    • ExtBankAcctKey integer <int64>

      Unique key identifier for external bank account

    • BankAccountName string

      Name associated with the logical bank account Must be unique within the administrator

    • BankAcctNickName string

      Name given to external bank account to easily identify by

    • BankAcctTypeCdeEnumeration integer <int32>

      Defaults to 1 if left blank (None = 0, Checking = 1, Savings = 2, General Ledger = 3)

    • BankAccountNumber string

      Bank account number Required if account usage includes ACH

    • BankRoutingNumber string

      Bank account routing number Required if account usage includes ACH

    • BankAccountStatusCdeEnumeration integer <int32>

      (New = 0, Confirmed = 1, PendingValidation = 2, ValidationRequired = 3, FixAccount = 4)

    • ConfirmDte string <date-time>

      Date the employee provided the microtransaction amounts to confirm the account is valid

    • DataPartnerId string

      Unique identifier for the Product Partner

Copyright © 2026 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC

AI Assistant Preview

Generating response...