Wex Health and Benefits APIs

Sections

Theme switcher

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

Path Parameters

claim_numberstring Required

The unique identifier of the claim to associate the receipt with.

Body Parameters

external_idstring Required

Gets or sets the external identifier for the receipt.

file_namestring Required

Gets or sets the name of the file being uploaded.

mime_typestring Required

Gets or sets the MIME type of the file being uploaded. Accepts a WEX.Benefits.Claims.Domain.Enums.DocumentContentType enum name (e.g. "Pdf", "Jpeg", "Png") or the enum's numeric value as a string.

Min length
1
is_ai_reviewedboolean

Gets or sets a value indicating whether the receipt is AI reviewed.

is_auto_adjudicationboolean

Gets or sets a value indicating whether the receipt should be automatically adjudicated.

content_lengthinteger

Gets or sets the content length of the file being uploaded.

receipt_statusinteger

Gets or sets the status of the receipt.

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_onstring

Gets or sets the date and time when the receipt was last updated.

updated_sourceinteger

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

Response

204
Object

Successfully saves 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 save 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 saved receipt information.

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?