Wex Health and Benefits APIs

Sections

Theme switcher

Upload Receipt

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 unique identifier of the person to associate the receipt with.

Body Parameters

receipt_typestring Required

Gets or sets the type of the receipt.

receipt_type_identifierstring Required

Gets or sets the identifier for the receipt type.

file_namestring Required

Gets or sets the name of the uploaded file.

file_sizeinteger

Gets or sets the size of the uploaded file in bytes.

file_contentstring Required

Gets or sets the content of the uploaded file as a byte array.

created_bystring Required

Gets or sets the user who created the receipt.

created_sourceinteger

Gets or sets the source from which the receipt was created.

updated_sourceinteger

Gets or sets the source from which the receipt was updated.

Response

204
Object

Successfully uploads the receipt information and associates it with the claim. No response body is returned.

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.

403
Object

Forbidden. User not authorized to upload receipts.

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

404
Object

Not Found. No Consumer found for respective Claim.

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.

200
Object

Successfully uploaded receipt information. Returns the ReceiptImageExternal GUID.

Response Attributes

receipt_image_external_idstring

The public-safe GUID generated for the persisted ReceiptImageExternal row.

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?