Participant APIs | REST

Version:
Download Open API Specification

Get the expected withdrawl date

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

Retrieve the expected withdrawal date for a participant's HSA contributions based on their unique identifiers and specified contribution date.

Request

  • 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 user whose feature information is being retrieved.

  • flexaccountkey integer <int32> Required

    Unique identifier for the participant's account, used to specify which account's withdrawal date is being requested.

  • contributiondate string <date-time> Required

    The date of the contribution in RFC3339 format (e.g., "2023-10-01T00:00:00Z"). This date is used to determine the expected withdrawal date.

  • prioryear boolean Required

    A boolean flag indicating whether to retrieve the expected withdrawal date for the prior year (true) or the current year (false).

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.

Response

AI Assistant Preview

Generating response...