Accounts

API - V 2.5

Download Swagger Spec

The Accounts API is a set of basic services used to retrieve and manage the information related to any and all accounts held by a customer with a specific financial institution (FI).

An account represents a contract between a customer and a financial institution. A customer opens an account with a bank or credit union (such as a checking, savings, loan, or line of credit account) and enters into a contractual relationship with the FI.

  • Check account status and balance.
  • Ensure sufficent funds for purchases
  • Review posted transactions, such as checks and deposits.

  • Provide the account holder with a quick review of account status.
  • Send alerts based on balance limits.
  • Identify opportunities for upselling
  • Ensure validity of transfers

Value

The Accounts service enables customers to:

  • Check account status and balance
  • Ensure sufficient funds for purchases
  • Review posted transactions such as checks and deposits

It enables developers to:

  • Provide the customer with quick review of account status
  • Send alerts based on balance limits
  • Identify opportunities for up-selling
  • Ensure validity of transfers


What is Supported?


The Accounts API technical documentation in the API Specs describes all the endpoints (ways to call the API with different parameters to execute different actions). The following is a simplified list of what the API can be used to do:

Get accounts: Returns data from all accounts held by the customer with the FI

  • Returns Cross Accounts as well, by default
  • Can be filtered to return only accounts of a selected category (i.e. DEPOSIT, LOAN, etc.)
  • Accounts belonging to recipients of  intra-FI transfers, set up by the primary customer, can be requested
  • Accounts belonging to a particular Business Banking entity, known as a "location", can be requested
  • Business Banking accounts can be grouped together, retrieved per group, and certain specified groups returned

GET Account - Returns data from a single, requested account

Additional Product Details

Get Accounts Example Response

(NOTE: DIIS is the Digital Insight Interface Specification, the markup language used by our services to exchange data with host systems via our interfaces.)
Response Field Source Source Field
1 id generated
3 institutionUserId request JWT institutionUserId
4 institutionId request
5 description DIIS ADSC
6 accountNumber DIIS ANUM/XUANUM For external clients only the available last 4 digits of the accountNumer field would be exposed.
9 category DIIS / Mapped
10 type DIIS / Mapped
12 ownershipType DIIS
13 currentBalance DIIS BAL
14 availableBalance DIIS ABAL
20 status DIIS / Mapped ASTAT
21 allowedActions DIIS/Entitlements NXFR
22 routingNumber DIIS RTN
24 maturityDate DIIS MATDT
25 nextPaymentAmount DIIS LPAY
26 nextPaymentDate DIIS NXTPT
27 payOffAmount DIIS LPOFF
30 nickName DIIS / database DSC /<br>hb_nickname.nickName field
33 interestRate DIIS ARATE / ITRATE / LRATE
34 interestYearToDate DIIS INTYTD
64 escrowBalance DIIS ESCBAL
65 currentPrincipalBalance DIIS PBAL
71 minimumPayment DIIS MINPMT
72 lineOfCreditLimit DIIS LLIM
75 loanOriginationDate DIIS ORGDT
76 term DIIS LTERM / LTERMTYP / TERM / TERMTYP
77 pastPrincipalDueDate DIIS PDDTPR
78 lastPrincipalPaymentAmount DIIS LPRPAY
79 originalLoanAmount DIIS ORGAMT
89 micrNumber DIIS MICR
close

Sign in now!

Please sign up or sign in to add to watchlist

Sign in
close

Added to watchlist!

Your interest has been noted. An NCR Voyix Rep
will contact you with further details soon.