Wex Health and Benefits APIs

Sections

Theme switcher

List Spending Accounts

Header Parameters

Authorizationstring

Query Parameters

consumer_idstring

Filter by consumer ID (Required if plan_id is not provided)

plan_idstring

Filter by plan ID (Required if consumer_id is not provided)

plan_year_idstring

Filter by plan year ID

account_typearray

Filter by spending account type

Max items
2

Show child attributes

page_sizeinteger

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

Minimum
1
Maximum
100
Default value
20
pageinteger

Zero-based page index.

Default value
0

Response

200
Object

Spending accounts retrieved successfully

Response Attributes

itemsarray Required
Max items
100

Show child attributes

paginationobject Required

Show child attributes

400
Object

Bad request - validation error or required parameters missing (e.g., missing both consumer_id and plan_id)

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

errorobject

Show child attributes

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 | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

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 | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

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 | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

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?

GET

/

Select
1

Response

Was this section helpful?