Wex Health and Benefits APIs

Sections

Theme switcher

Create Or Update Bank Account

Header Parameters

Idempotency-Keystring Required

Required client-generated UUID v4 used to deduplicate retried mutating requests (POST, PUT, PATCH, DELETE). Requests without this header are rejected with 400 Bad Request. The first successful (2xx) response is cached for 24h and replays of the same key return the cached response without re-executing the operation.

X-Request-Idstring

Optional correlation ID associated with the request.

Query Parameters

consumer_idstring Required

The consumer (person ID) for the bank account

Body Parameters

routing_numberstring Required
Min length
1
Pattern
^\d{9}$
account_numberstring Required
Min length
4
Max length
17
account_usestring Required
account_typestring Required
generate_pre_noteboolean
bank_namestring Required
Max length
100
nicknamestring
Max length
50
account_idstring
addressobject

Show child attributes

Response

200
Object

Bank account successfully updated

Response Attributes

idstring Required
account_numberstring Required
statusstring Required
nicknamestring
account_usestring Required
account_typestring Required
bank_namestring Required
201
Object

Bank account successfully created

Response Attributes

idstring Required
account_numberstring Required
statusstring Required
nicknamestring
account_usestring Required
account_typestring Required
bank_namestring Required
400
Object

Invalid request or validation error

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
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

Consumer not found

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
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
titlestring
statusinteger
detailstring
instancestring
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.

default
Object

Unexpected error

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
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?

Base URL

Production:

Sandbox:

Language Box

POST

/

Select
1

Response

Was this section helpful?