List Hsa Contribution Details
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
Restricts results to the given employers. Repeat the parameter to select several. Every value is validated against the calling partner's authorized employer set, and a value outside it fails the request with 403.
Show child attributes
Restricts results to a single participant. The identifier is assigned by the employer and is not unique across employers, so employer_id must be supplied alongside it; otherwise the request fails with 400.
Restricts results to a single custodian-issued HSA account identifier.
Restricts results to the single contribution transaction with this key. Returns at most one record.
Restricts results to the given contribution tax years. Repeat the parameter to select several. Defaults to the current tax year when omitted.
Show child attributes
Restricts results to the given contribution type codes. Repeat the parameter to select several. Codes outside those the caller is entitled to see are rejected with 403.
Show child attributes
Restricts results to the given funding source codes. Repeat the parameter to select several. Codes outside those the caller is entitled to see are rejected with 403.
Show child attributes
Earliest processed date to include, inclusive of the whole day, in ISO 8601 format (for example, 2025-06-01). Defaults to 90 days before process_date_to when both dates are omitted.
Latest processed date to include, inclusive of the whole day, in ISO 8601 format (for example, 2025-06-30). The span between process_date_from and process_date_to may not exceed 366 days.
Earliest contribution date to include, inclusive of the whole day, in ISO 8601 format (for example, 2025-01-01). Filters on when the contribution was made rather than when it was processed.
Latest contribution date to include, inclusive of the whole day, in ISO 8601 format (for example, 2025-12-31). Filters on when the contribution was made rather than when it was processed.
Zero-based page index.
Maximum number of rows to return per page (1-100).
Response
Contribution detail records retrieved successfully
Response Attributes
The contribution detail records for this page.
Show child attributes
Show child attributes
Bad Request – Validation failed. The errors map keys mirror the snake_case JSON property names used in the request payload.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized – Missing or invalid credentials.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Forbidden – Insufficient permissions.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Not Found – Employee record does not exist.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal Server Error.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unexpected error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Base URL
Production:
Sandbox: