List Bank Accounts
Header Parameters
X-Request-Idstring
Optional correlation ID associated with the request.
Empty value:
True
Authorizationstring
Query Parameters
consumer_idstring Required
The consumer (person ID) to retrieve bank accounts for
account_usestring
An optional parameter that filters the bank accounts by their use. Options are: Unspecified, DirectDeposit, ReimbursementDebitCard, VebaWithdrawals, Other.
include_addressboolean
An optional parameter that includes bank account addresses in the response. Default is false.
Default value
false
Response
200
Object
The request was successful, and a list of bank accounts (which may be empty) is returned.
Response Attributes
itemsarray Required
Show child attributes
total_countinteger Required
The total number of bank accounts in the result set
400
Object
Invalid request or validation error
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
404
Object
The person with the specified person_id was not found.
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
500
Object
Internal server error.
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
default
Object
Unexpected error
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
Was this section helpful?
Response
Was this section helpful?