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
.png)
Gets the specified account for the given user.
ENDPOINTS
get
/accounts/{accountId}
Header parameters
Collapse
Accept
string
no
The content type of the response. Only application/json and application/xml are supported. Defaults to application/json.
Content-Type
string
required
The content type of the request. Only application/json and application/xml are supported.
authorization
string
required
A JWT that authorizes this request.
transactionId
string
required
A unique identifier for this request.
Body parameters
Collapse
Query parameters
Collapse
crossAccount
boolean
no
Excludes cross user accounts from the response when false.
viewName
string
no
Filters the returned fields based on the proided view name. Can be: - `s` - Small view - `m` - Medium view
Path parameters
Collapse
accountId
string
required
The ID of the account to retrieve.
Responses
Collapse
200
Success
400
Bad request
401
Unauthorised
403
Forbidden
404
No data found
500
Server error
CURL REQUEST
curl -X 'GET' \
'https://api.candescent.com/digitalbanking/db-accounts/v1/accounts/{accountId}' \
-H 'transactionid: SOME_STRING_VALUE' \
-H 'authorization: SOME_STRING_VALUE' \
-H 'content-type: SOME_STRING_VALUE' \
-H 'accept: SOME_STRING_VALUE' \ RESPONSE
{"id":"string","description":"string","institutionUserId":"string","institutionId":"string","accountNumber":"string","nickName":"string","type":{"value":"SAVINGS","fiAccountType":0,"description":"string"},"category":"DEPOSIT","primaryHolderName":"string","currentBalance":{"currencyCode":"AED","amount":0},"availableBalance":{"currencyCode":"AED","amount":0},"status":{"open":true,"closed":true,"negativeBalance":true,"delinquent":true,"inCollection":true,"overLimit":true,"writtenOff":true,"creditBalance":true,"paymentCoupon":true,"retirementPlan":true,"retPlanOwnedByDeceased":true,"approved":true,"notApproved":true,"deleted":true,"verified":true},"allowedActions":{"summary":true,"transferFrom":true,"transferTo":true,"isHistoryEnabled":true,"isHistoryEntitled":true},"routingNumber":"string","interestRate":0.1,"interestYearToDate":{"currencyCode":"AED","amount":0},"micrNumber":"string","maturityDate":"2019-08-24","term":"DAYS","escrowBalance":{"currencyCode":"AED","amount":0},"currentPrincipalBalance":{"currencyCode":"AED","amount":0},"nextPaymentAmount":{"currencyCode":"AED","amount":0},"nextPaymentDate":"2019-08-24","payOffAmount":{"currencyCode":"AED","amount":0},"calculatedPayOffAmount":{"currencyCode":"AED","amount":0},"unappliedFundsBalance":{"currencyCode":"AED","amount":0},"minimumPayment":{"currencyCode":"AED","amount":0},"lineOfCreditLimit":{"currencyCode":"AED","amount":0},"loanOriginationDate":null,"pastPrincipalDueDate":null,"lastPrincipalPaymentAmount":{"currencyCode":"AED","amount":0},"originalLoanAmount":{"currencyCode":"AED","amount":0}}
{"code":"string","message":"string"}
{"code":"string","message":"string"}
{"code":"string","message":"string"}
{"code":"string","message":"string"}
{"code":"string","message":"string"}
