Wex Health and Benefits APIs

Sections

Theme switcher

Get Claims Requiring Receipts

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

person_idstring Required

The GUID of the person (participant).

typestring Required

The receipts-needed bucket to retrieve.

page_sizeinteger

The number of claims requested. Pass 0 or omit to return all matching claims without pagination.

indexinteger

The starting index in the list of claims to be returned. Ignored when page_size is 0 (unpaged).

Response

200
Object

Successfully retrieved claims

Response Attributes

indexinteger

Current page index (i.e. page number minus one)

page_sizeinteger

Number of items per page

has_nextboolean

Indicated whether there are additional pages

itemsarray

A list of claims

Show child attributes

400
Object

Invalid request. Check query parameters.

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. Authentication failed.

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.

404
Object

Not Found.

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.

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?