List Bank Accounts
Header Parameters
Optional correlation ID associated with the request.
Query Parameters
The consumer (person ID) to retrieve bank accounts for
An optional parameter that filters the bank accounts by their use. Valid values are: UNSPECIFIED, DIRECT_DEPOSIT, REIMBURSEMENT_DEBIT_CARD, VEBA_WITHDRAWALS, OTHER, HSA_CONTRIBUTION, HSA_DISTRIBUTION.
An optional parameter that includes bank account addresses in the response. Default is false.
Response
The request was successful, and a list of bank accounts (which may be empty) is returned.
Response Attributes
Show child attributes
The total number of bank accounts in the result set
Invalid request or validation error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
The person with the specified person_id was not found.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal server error.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unexpected error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Base URL
Production:
Sandbox: