Use Cases
The end user (in this scenario, the financial institution’s customer), wants to get a list of their details or details for a specific account from the system. This case includes the functions for retrieving contact, credential, product, and status information for FI customers registered to use Digital Banking.
Gets transactions for the given account
Get the list of transaction by accountId. This uses a token from password grant only. GET /db-transactions/v1/transactions
Request:
-
Query Parameters:
- accountId: The ID of the account for which transactions are being requested. This is a required query parameter.
- startDate: Date (yyyy-MM-dd). This is the start of the date range for which transactions will be retrieved (inclusive). Defaulted to end date minus an FI-configurable number of days (usually 30).
- endDate: Date (yyyy-MM-dd). This is the end of the date range for which transactions will be retrieved (inclusive). If the end date is today or in the future, pending transactions may be included in the response, regardless of whether the dates of these pending transactions lie in the requested date range.
- retrieveFutureTransactions: True/False. When true, this adds an FI-configurable number of days to today and sets this date as the end date. If an end date is sent in the request, this parameter will override it.
- institutionCustomerId: If the user is a BB user, this is the institution customer ID that identifies the location for which transactions should be retrieved.
-
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request
Section 2: Example Code
Here’s an excerpt from the Accounts service:
Gets transactions for the given account
Sample Response:
{
"transactions": [
{
"id": "wVQpyoHllR2nnzrTb06i5TpJxiMz6zBoJEZYQZtnr6M",
"institutionId": "03079",
"accountId": "lkaUm1sc4plDcg4g3wD49mryCiXe92u7NihqycCgV10",
"transactionNumber": "39000400",
"transactionDate": "2019-09-25",
"effectiveDate": "2019-09-25",
"memo": "Memo One",
"description": "Transaction One",
"amount": {
"currencyCode": "USD",
"amount": 100.0
},
"type": "WITHDRAWAL",
"isCreditTransaction": false,
"isExportable": true,
"isPending": true
},
{
"id": "pr8MAfoJdCacaBAOeKqZVkM6w-Aq-NcrT9Ni5p3FsqQ",
"institutionId": "03079",
"accountId": "lkaUm1sc4plDcg4g3wD49mryCiXe92u7NihqycCgV10",
"transactionNumber": "39000398",
"transactionDate": "2019-09-21",
"effectiveDate": "2019-09-21",
"memo": "Memo Two",
"description": "Transaction Two",
"amount": {
"currencyCode": "USD",
"amount": 300.0
},
"type": "WITHDRAWAL",
"isCreditTransaction": false,
"isExportable": true,
"isPending": false
}
]
}
