Wex Health and Benefits APIs

Sections

Theme switcher

Get Payees For Participant

Header Parameters

X-Request-Idstring

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

Authorizationstring

Query Parameters

person_idstring Required

The GUID of the person (participant)

page_sizeinteger

The number of payees requested

Minimum
1
Maximum
1000
Default value
20
indexinteger

The starting index in the list of payees to be returned

Default value
0

Response

200
Object

Successfully retrieved payees

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

total_resultsinteger

The total number of payees matching the query across all pages. Used to calculate the total number of pages as ceil(total_results / page_size).

itemsarray | null

Show child attributes

400
Object

Invalid request. Check query parameters.

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.

Show child attributes

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

404
Object

Not Found.

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

A URI reference that identifies the problem type.

titlestring | null

A short, human-readable summary of the problem type.

statusinteger | null

The HTTP status code generated by the origin server.

detailstring | null

A human-readable explanation specific to this occurrence of the problem.

instancestring | null

A URI reference that identifies the specific occurrence of the problem.

invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

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?