Accounts

Accounts APIs retrieve and manage customer account information. An account is the contract between a customer and the financial institution (checking, savings, loan, line of credit, etc.).

End-user benefits

• Check account status and balance in real time.
• Use account lists to drive intra-FI transfer recipient flows.

Integration capabilities

• Retrieve accounts with ODATA $filter by id, nickname, type, account number, and category (DEPOSIT, LOAN, INVESTMENT, TIERED_LOAN, CROSS_USER_ACCOUNT).
• Returns cross accounts by default; control detail with viewName and related query options.
• Business Banking: use institutionCustomerId to look up accounts for a specific location (see Retrieve Customer Profile API for more details).

Response field filtering (viewname.external)

Responses are filtered to an allow-list from viewname.external. Omit query parameter viewName on list or single-account retrieval to return every top-level property in that list.

Default allow-list

id, institutionUserId, institutionCustomerId, institutionId, description, accountNumber, nickName, type, category, currentBalance, availableBalance, status, allowedActions, routingNumber, interestRate, interestYearToDate, micrNumber, maturityDate, term, escrowBalance, currentPrincipalBalance, nextPaymentAmount, nextPaymentDate, payOffAmount, calculatedPayOffAmount, minimumPayment, lineOfCreditLimit, loanOriginationDate, pastPrincipalDueDate, lastPrincipalPaymentAmount, originalLoanAmount, tpvReference, lastStatementBalance, primaryHolderName.

Scopes

Scope	Description
accounts:read	Read accounts

Required headers

Header	Description
Authorization	Bearer token (V2 authentication)
transactionId	Unique identifier for request tracking

Error codes (ACC_*)

Code	Message	HTTP Status Code
ACC_00002	Given password is invalid	401
ACC_00005	Error processing filter expression	400
ACC_00011	Validation Error	400
ACC_00012	Data not found	404
ACC_00013	Validation Error occurred	500
ACC_00014	The CIF number is required, but was not found	500
ACC_00015	InstitutionId provided is invalid or blank	400
ACC_00016	InstitutionUserType provided is invalid or blank	400
ACC_00017	InstitutionCustomerId provided is invalid or blank	400
ACC_00018	InstitutionId from Query param and JWT do not match	400
ACC_00019	InstitutionUserType from Query param and JWT do not match	400
ACC_00020	InstitutionCustomerId from Query param and JWT do not match	400
ACC_00021	UserId provided is invalid or blank	400
ACC_00022	UserId from Query param and JWT do not match	400
ACC_00023	InstitutionUserId provided is invalid or blank	400
ACC_00024	InstitutionUserId from Query param and JWT do not match	400
ACC_00025	InstitutionUserRole provided is invalid or blank	400
ACC_00026	InstitutionUserRole from Query param and JWT do not match	400
ACC_00101	User not found	404
ACC_00300	Utility DB is not available	503
ACC_00408	BB User is missing User Id in the request	400
ACC_00409	Invalid User Type Header for Business Banking User	400
ACC_00410	A location is required for BB users	400
ACC_00500	Requested service or feature is switched off	403
ACC_00501	Couchbase System is unavailable	503
ACC_00600	ServiceType parameter is invalid. Valid values are IB/BB	400
ACC_00601	Invalid JWT token	401
ACC_00602	Unauthorized access	403
ACC_00702	Subuser Id is empty	400
ACC_00704	InstitutionId is invalid or its incorrectly configured	500
ACC_00705	Member number is not valid.	400
ACC_99988	Server can only handle JSON request. Other media types are not supported	400
ACC_99989	RequestBody size exceeds limit.	400
ACC_99990	Client error	400
ACC_99991	Request callingAppId header is too long	400
ACC_99992	One or more request query params are invalid or not provided	400
ACC_99993	Server cannot handle this request	Varies
ACC_99994	Invalid query param	400
ACC_99995	Request should only contain printable ASCII characters	400
ACC_99996	Request header is too long	400
ACC_99997	Request transactionId header is too long	400
ACC_99998	Request is missing a transactionId header	400
ACC_99999	Error in Accounts Service	500

Endpoints

Fetch Account Information

Fetch account registration information like account number, accounts status, account's transactions and more.

Get Account by ID

Returns detailed information for a specific financial account that the authenticated user

List Accounts

Returns a list of financial accounts that the authenticated user is entitled to access.

List Legacy Accounts

Retrieves all accounts associated with a customer for the specified Financial Institution and Customer ID.