/BankAccounts GET

Returns the user's registered bank accounts as a List Response.

URL

/BankAccounts

Verb

GET

Headers

Header	Data Type	Valid Values	Required	Description
Content-Type	string	application/json	YES	The format your data will be sent to our site.
X-DevKey	string	string	YES	The devkey assigned to the developer.
X-AccessToken	string	string	YES	The token acquired from a POST to Users/AccessToken.

Input

NOTE: Variables to place in the query string of the request.

Parameter	Data Type	Valid Values	Description
BankName	string	any string	A key phrase to search for in the bank's name
Nickname	string	any string	A key phrase to search for in the account's nickname
Sort	integer	0 - Sort by Status Asc 1 - Sort by Status Desc 2 - Sort by Nickname Asc 3 - Sort by Nickname Desc 4 - Sort by Bank Name Asc 5 - Sort by Bank Name Desc	The sort direction you want the feedback results to be.

Optional PagingParameters

Output

If the user id is not valid, you will receive a 404 NotFound and a Message Response indicating the reason.

If there are no errors with the input parameters, this call will respond with a 200 OK and the following data as serialized JSON

Parameter	Data Type	Valid Values	Description
AccountNumber	string	Masked number	The bank account's account number, masked with X's
AccountType	integer	An enumeration specifying the type of account	1 - Personal Checking 2 - Personal Savings 3 - Business Checking
BankName	string	Any string	The bank's name
Nickname	string	Any string	The nickname of the bank account
ObjectID	integer	positive #	The object ID of the bank account
RoutingNumber	string	Masked number	The bank account's routing number, masked with X's
Status	integer	An enumeration specifying the account's status	0 - New 1 - Pending Validation 2 - Invalid 3 - Valid
UserID	integer	positive #	The user ID of the account owner

Links

Rel	Description	Condition
details	Link to the bank account details and management page