Wex Health and Benefits APIs

Sections

Theme switcher

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

Acceptstring

Controls the response media type. When application/json (the default), the response is a JSON document containing only metadata and the file content is not returned. When multipart/mixed, the response is a multipart payload in which the JSON metadata is the first part followed by the binary file content part.

Default value
application/json
Enum values:
application/jsonmultipart/mixed
Accept-Encodingstring

Optional. Standard HTTP Accept-Encoding header (RFC 9110 ยง12.5.3). The server honors gzip and br; any other codings listed are ignored. If the header is omitted, or none of the listed codings are honored, the response body is returned uncompressed (identity encoding).

Authorizationstring

Query Parameters

person_idstring Required

Required GUID of the person (participant) to validate receipt ownership

Path Parameters

receipt_idstring Required

The receipt GUID (ReceiptImageExternalId returned by the SaveReceipt endpoint)

Response

200
Object

Successfully retrieved receipt

Response Attributes

receipt_idstring | null

The unique identifier assigned to the receipt.

file_namestring | null

The name of the uploaded receipt file.

file_sizeinteger

The size of the receipt file in bytes.

content_typestring

The type of content in the receipt.

upload_datestring

The date the receipt was uploaded.

tracked_expense_numberstring | null

The number associated with the tracked expense related to the receipt.

claim_numbersarray | null

A list of claim numbers linked to the receipt.

Showย child attributes

metadataobject

Receipt object that contains information about a receipt, including the file name, size, content type, upload date, and associated claim numbers.

Showย child attributes

file_contentstring

The binary content of the uploaded receipt file.

download_urlstring

The URL to download the receipt file.

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?