Customer Information and Registration

API - V 2.5

Download Swagger Spec

To fetch customer's accounts

API to fetch Accounts registration information like account number, accounts status, account's transactions and more.

ENDPOINTS

get

/v1/customers/{customerId}:accounts

Header parameters

Collapse

Expand

correlationId

string

required

UUID that uniquely identifies the request. This id allows the request to be traced through the entire request and reponse flow.

Authorization

string

required

Standard OAuth 2.0 access token. A string composed of 'Bearer' + '(space)' + '{token}'

Path parameters

Collapse

Expand

customerId

string

required

Unique identifier of financial institution customer

Responses

Collapse

Expand

Response Body

[{"accountHidden":true,"accountNumber":9900002001,"accountStatus":{"open":false,"closed":false,"negativeBalance":false,"delinquent":false,"inCollection":false,"overLimit":false,"writtenOff":false,"creditBalance":false,"paymentCoupon":false,"retirementPlan":false,"retPlanOwnedByDeceased":false,"approved":false,"notApproved":false,"deleted":false,"verified":false},"accountType":{"DIAccountType":"SAVINGS","fiRawAccountType":0,"fiAccountType":0,"description":"Money Market"},"achCount":0,"balance":{"availableBalance":{"amount":105,"currencyCode":"USD"},"currentBalance":{"amount":105,"currencyCode":"USD"}},"billPayAccountNumber":"string","billPayId":"string","category":"DEPOSIT","currentYearEligibleContribution":{"amount":105,"currencyCode":"USD"},"currentYearMaxContribution":{"amount":105,"currencyCode":"USD"},"description":"string","diAccountType":0,"escrowPriorYearToDate":{"amount":105,"currencyCode":"USD"},"escrowYearToDate":{"amount":105,"currencyCode":"USD"},"fiAccountTypeDesc":"checking","fiRawAccountType":0,"fiAccountType":0,"customerId":"bfdf0fe66b334326b9f89f42c5af445c","fiId":271234,"historyAllowed":true,"hostAccountType":"string","id":"df0fe66b3","interestPriorYearToDate":{"amount":105,"currencyCode":"USD"},"interestRate":0,"lastDepositAmount":{"amount":105,"currencyCode":"USD"},"lastDividendAmount":{"amount":105,"currencyCode":"USD"},"lastInterestPaymentAmount":{"amount":105,"currencyCode":"USD"},"lastInterestPaymentDate":"string","lastStatementStartDate":"string","lastStatementEndDate":"string","lastYearEligibleContribution":{"amount":105,"currencyCode":"USD"},"lastYearMaxContribution":{"amount":105,"currencyCode":"USD"},"micrNumber":"string","nickName":"string","nonQualifiedRate":0,"overDraftBillPayValue":"string","overDraftExternalMortgageAccountValue":"string","rdcAccountValue":0,"overdraftAccountNumber":"string","overdraftAvailableAmount":{"amount":105,"currencyCode":"USD"},"overdraftLimit":{"amount":105,"currencyCode":"USD"},"ownershipType":"PRIMARY","posCount":0,"primaryHolderId":"string","primaryHolderName":"string","regDLimits":{"maxTransferCount":1,"maxCheckCount":2,"maxRegDCount":1,"hostTransferCount":2,"hostCheckCount":2},"rewardsCount":0,"taxPriorYearToDate":{"amount":105,"currencyCode":"USD"},"taxYearToDate":{"amount":105,"currencyCode":"USD"},"tier1BalanceDesc":"string","tier1QualifiedRate":0,"tier2BalanceDesc":"string","tier2QualifiedRate":0,"totalFundsAvailable":{"amount":105,"currencyCode":"USD"},"tpvReference":"string","transferRestriction":"EXCLUDE_ALL","accountTransactions":[{"accountId":123456,"amount":{"amount":105,"currencyCode":"USD"},"amountToEscrow":{"amount":105,"currencyCode":"USD"},"amountToInterest":{"amount":105,"currencyCode":"USD"},"amountToPrincipal":{"amount":105,"currencyCode":"USD"},"checkImageIdentifier":"string","checkImageLocator":"string","checkNumber":0,"checkNumberStr":"string","creditTransaction":true,"depositSlipIdentifier":"string","description":"string","effectiveDate":"string","fee":{"amount":105,"currencyCode":"USD"},"fiId":"string","id":"string","ledgerBalance":{"amount":105,"currencyCode":"USD"},"memo":"string","micr":"string","isPending":false,"persistentTnum":false,"transactionDate":"string","transactionId":"string","transactionNumber":"string","transactionType":"string"}]}]

CURL REQUEST

curl -X 'GET' \ 
 'https://api.candescent.com/digitalbanking/ux-users/v1/customers/{customerId}:accounts' \ 
 -H 'authorization: Bearer 18FaavwuGejYXBhj7grtrP57ZbCX' \ 
 -H 'correlationid: f8187c63-678f-4f0c-9263-46723794661a' \ 
 -H 'accept: application/json' \

Get Response