Wex Health and Benefits APIs

Sections

Theme switcher

List Claim Details

Header Parameters

X-Request-Idstring

Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.

Query Parameters

employer_idarray

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

claim_statusarray

Restricts results to the given claim statuses, such as Paid, Pending, or Denied. Repeat the parameter to select several.

Show child attributes

service_date_fromstring

Earliest service date to include, in ISO 8601 format (for example, 2025-01-01).

service_date_tostring

Latest service date to include, in ISO 8601 format (for example, 2025-12-31).

plan_yearinteger

Restricts results to a specific plan year.

Minimum
2000
Maximum
2100
pageinteger

Zero-based page index.

page_sizeinteger

Maximum number of rows to return per page (1-100).

Minimum
1
Maximum
100

Response

200
Object

Claim details retrieved successfully

Response Attributes

itemsarray Required

Claim detail records for this page.

Show child attributes

paginationobject Required

Show child attributes

400
Object

Bad Request – Validation failed. The errors map keys mirror the snake_case JSON property names used in the request payload.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

401
Object

Unauthorized – Missing or invalid credentials.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

403
Object

Forbidden – Insufficient permissions.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

500
Object

Internal Server Error.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

default
Object

Unexpected error

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

Was this section helpful?

Base URL

Production:

Sandbox:

Language Box

GET

/

Select
1

Response

Was this section helpful?