Introduction
Accounts
Update contact info
Money Movement
Disclosures
Banking Images
Authentication
Alerts
Banking Activity
Unlock User
Legacy Authentication
Reset Password
Experience Group
Customer Information
Transactions
E-Statement Reports
Gets transactions for the given account
ENDPOINTS
get
/v1/transactions
Header parameters
Collapse
callingAppId
string
no
The id of the app or service calling the transactions service.
Authorization
string
required
An OAuth2 access token (in JWT format) that authorizes this request. The transactions:read and accounts:read scopes are required to access this API. Must be in the format Bearer {JWT}
transactionId
string
required
An ID that identifies this request. A unique identifier should be generated for each request made.
Body parameters
Collapse
Query parameters
Collapse
retrieveFutureTransactions
boolean
no
When true, 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.
endDate
string
no
The end of the date range for which transactions will be retrieved (inclusive). If included, this date must be after or the same as the start date, otherwise the request will fail.
startDate
string
no
The start of the date range for which transactions will be retrieved (inclusive). If included, this date must be before or the same as the end date, otherwise the request will fail.
institutionCustomerId
string
no
The institution customer id that identifies the location for which transactions should be retrieved. Required for BB users.
accountId
string
required
The ID of the account for which transactions are being requested.
Responses
Collapse
200
Success
Response Body
[{"id":"string","institutionId":"string","institutionUserId":"string","accountId":"string","transactionNumber":"string","hostTransactionId":"string","transactionDate":"2019-08-24","effectiveDate":"2019-08-24","memo":"string","description":"string","amount":{"currencyCode":"AED","amount":0},"fee":{"currencyCode":"AED","amount":0},"amountToPrincipal":{"currencyCode":"AED","amount":0},"amountToEscrow":{"currencyCode":"AED","amount":0},"amountToInterest":{"currencyCode":"AED","amount":0},"ledgerBalance":{"currencyCode":"AED","amount":0},"checkNumber":"string","micrNumber":"string","type":"WITHDRAWAL","isCreditTransaction":true,"isExportable":true,"isPending":true,"transactionImage":{"imageIdentifier":"string","hostImageLocator":"string","imageType":"CHECK"}}]
400
Bad request
Response Body
{"code":"string","message":"string"}
401
Unauthorized
Response Body
{"code":"string","message":"string"}
403
Forbidden
Response Body
{"code":"string","message":"string"}
500
Server error
Response Body
{"code":"string","message":"string"}
CURL REQUEST
curl -X 'GET' \
'https://api.candescent.com/digitalbanking/db-transactions/v1/transactions' \
-H 'transactionid: SOME_STRING_VALUE' \
-H 'authorization: SOME_STRING_VALUE' \
-H 'callingappid: SOME_STRING_VALUE' \
-H 'accept: application/json' \ RESPONSE
[{"id":"string","institutionId":"string","institutionUserId":"string","accountId":"string","transactionNumber":"string","hostTransactionId":"string","transactionDate":"2019-08-24","effectiveDate":"2019-08-24","memo":"string","description":"string","amount":{"currencyCode":"AED","amount":0},"fee":{"currencyCode":"AED","amount":0},"amountToPrincipal":{"currencyCode":"AED","amount":0},"amountToEscrow":{"currencyCode":"AED","amount":0},"amountToInterest":{"currencyCode":"AED","amount":0},"ledgerBalance":{"currencyCode":"AED","amount":0},"checkNumber":"string","micrNumber":"string","type":"WITHDRAWAL","isCreditTransaction":true,"isExportable":true,"isPending":true,"transactionImage":{"imageIdentifier":"string","hostImageLocator":"string","imageType":"CHECK"}}]
{"code":"string","message":"string"}
{"code":"string","message":"string"}
{"code":"string","message":"string"}
{"code":"string","message":"string"}
