TPA API | Administrative - SOAP

To help you with onboarding, data management, and other related tasks, this web service method allows you to retrieve data that spans across all employers in your WCA instance.

Service web methods
The following is a list of methods that is provided by the TPA service.
  • Calendars – Retrieve a comprehensive list of all your calendars.
  • TPAPartnerName – Retrieve product partner names associated with your WCA instance.

Service assumptions/business rules
The TPA service makes the following assumptions as well as enforces the following business rules.
  • Clients shall conform to the WS-I specifications unless otherwise agreed upon by Alegeus and the administrator.
  • Clients shall format SOAP messages in a document/literal format over HTTPS.
  • Clients shall have already created a valid user ID and password.
  • Clients shall have a valid session ID after being authenticated by the system. The session ID needs to be passed in the proper manner as described in the account manager service guide.
  • If the administrator uses the same user ID and password for all of their clients, the administrator is responsible for managing the security of the data.
  • Clients should validate data before submitting a request to this Service. This facilitates better performance and accurate processing on both systems.
  • Clients shall not attempt to use this service for batch processing of large amounts of data. The service is designed for synchronous calls that send or retrieve small chunks of data. If batch processing is required, then the EDI process should be used.
  • If any method fails, the service returns a SOAP fault describing the problem.

Calendars

To help you with onboarding, data management, and other related tasks, this web service method allows you to retrieve a comprehensive list of all your calendars. Simply submit a request with your TPA ID, and a list of your calendars is returned (including first deposit dates).

History
The calendars methods are listed below:

Request messages
  • GetCalendarsRequest
Response messages
  • GetCalendarsResponse

GetCalendar request/response messages
The GetCalendar method requires the following request and response messages (input and output data).

The table below includes the following request messages:
  • GetCalendarRequest
  • TpaIdStringrequired
    Administrator’s unique ID in WCA
    First Available Version:GetCalendarRequest
    Max Length:6
  • GetCalendarResponse
  • TpaIdString
    Administrator’s unique ID in WCA
    First Available Version:GetCalendarRequest
  • CalendarIDString
    Unique ID assigned to the calendar in WCA
    First Available Version:GetCalendarRequest
  • CalendarNameString
    Calendar name in WCA
    First Available Version:GetCalendarRequest
  • PayCycleTypeString
    Pay cycle type for auto deposits:
    Annual
    Monthly
    Weekly
    NoAutoDeposit
    BiWeekly
    SemiMonthly
    First Available Version:GetCalendarRequest
  • CalendarTypeString
    Calendar type
    First Available Version:GetCalendarRequest
  • CalendarStatusString
    Status of calendar: active, inactive
    First Available Version:GetCalendarRequest
  • CalendarOptionsString
    Calculate only, auto deposit, reporting only
    First Available Version:GetCalendarRequest
  • LastDepositDteString
    Last deposit date
    First Available Version:GetCalendarRequest
  • FirstDepositDteString
    First deposit date
    First Available Version:GetCalendarRequest


TPAPartnerName

The TPAPartnerName SOAP web service allows you to easily obtain product partner names associated with your WCA instance. Providing access to preferred product partner configurations can speed up the process of setting up new HSA plans when onboarding new employers.

History
The TPAPartnerName methods are listed below:

Request messages
  • TPAPartnerNameRequest
Response messages
  • TPAPartnerNameResponse

TPAPartnerName request/response messages

The TPAPartnerName method requires the following request and response messages (input and output data).

The table below includes the following request messages:

  • TPAPartnerNameRequest
  • TpaIdStringrequired
    Administrator’s unique ID in WCA
    First Available Version:TPAPartnerNameRequest
    Max Length:6
  • TPAPartnerNameResponse
  • TpaIdString
    Administrator’s unique ID in WCA
    First Available Version:TPAPartnerNameResponse
  • PartnerNameString
    The name of a product partner associated with the administrator’s WCA instance.
    First Available Version:TPAPartnerNameResponse