Wex Health and Benefits APIs

Sections

Theme switcher

Get Claim By Claim Number

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)

Path Parameters

claim_numberstring Required

The Claim number, an alphanumeric string, e.g. 11BPEB1210513P0000101

Response

200
Object

Successfully retrieved claim information

Response Attributes

claim_numberstring

A unique identifier assigned to the claim.

claim_amountnumber

The total amount of the claim submitted.

claim_statusstring

The current processing status of the claim.

submission_datestring | null

The date the claim was submitted.

start_date_of_servicestring | null

The first date services were provided for the claim.

end_date_of_servicestring | null

The last date services were provided for the claim.

processed_datestring | null

The date the claim was processed.

provider_namestring | null

The name of the provider associated with the claim.

paid_amountnumber

The amount reimbursed for the claim.

submitted_amountnumber

The original amount submitted for reimbursement.

is_ptpboolean

Indicates whether the claim is part of a pay-the-provider process.

denial_reasonsarray | null

The reason(s) the submitted claim was denied, if applicable.

Show child attributes

requests_for_more_informationarray | null

Request(s) for additional information for the submitted claim, if applicable.

Show child attributes

receipt_statusstring

The status of receipt submission for the claim.

denied_amountnumber

The total amount of the claim that was denied.

applied_copay_amountnumber

The portion of the claim amount applied to a copay.

applied_coinsurance_amountnumber

The portion of the claim amount applied to coinsurance.

applied_deductible_amountnumber

The portion of the claim amount applied to a deductible.

claim_sourcestring

The source of the claim submission.

scheduled_for_reimbursement_datestring | null

The date the claim is scheduled for reimbursement.

plan_year_namestring | null

The name of the plan year associated with the claim.

plan_year_start_datestring | null

The start date of the plan year for the claim.

plan_namestring | null

The name of the benefit plan for the claim.

final_filing_datestring | null

The last date a claim can be filed for the plan year.

expense_idinteger

The unique identifier for the expense associated with the claim.

receipt_status_dtstring | null

The date and time the receipt status was last updated for the claim.

categorystring | null

The high-level category of the expense related to this claim.

expense_typestring | null

The specific type of expense submitted for this claim.

issue_responsestring | null

The denial code description for the claim, populated only for denied claims.

offering_idinteger | null

The identifier of the benefit offering associated with the claim.

payeestring | null

The person or entity designated to receive payment for this claim.

plan_idstring | null

The identifier of the benefit plan to which this claim belongs.

pending_amountnumber

The portion of the claim amount currently pending adjudication.

claim_guidstring

The public-facing unique identifier (UUID) for the claim, sourced from the ClaimExternal table.

recipientstring

The person the service was for, sourced from dbo.Claim.service_recipient.

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. No claim found for supplied claim number.

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?