Examples
Sample Request
url: /ysl/accounts
methodType: GET
Header:
Authorization: Bearer 〈your-user-access-token〉
Api-version: 1.1
Sample Response - Get Accounts
{
"account":[
{
"CONTAINER":"bank",
"isManual":false,
"isAsset":true,
"lastUpdated":"2017-09-21T06:08:29Z",
"currentBalance":{
"amount":20000,
"currency":"USD"
},
"availableBalance":{
"amount":20000,
"currency":"USD"
},
"displayedName":"Timothy",
"id":2251053,
"balance":{
"amount":20000,
"currency":"USD"
},
"accountName":"Savings Account",
"accountNumber":"xxxx8823",
"aggregationSource":"USER",
"dataset":[
{
"lastUpdateAttempt":"2017-09-21T06:08:51Z",
"updateEligibility":"ALLOW_UPDATE",
"name":"BASIC_AGG_DATA",
"lastUpdated":"2017-09-21T06:08:51Z",
"additionalStatus":"AVAILABLE_DATA_RETRIEVED"
}
],
"providerName":"Wells Fargo",
"accountStatus":"ACTIVE",
"accountType":"SAVINGS",
"providerId":"5",
"includeInNetWorth":true,
"createdDate":"2017-09-21T06:08:26Z",
"providerAccountId":2204099
}
]
}
Transactions Aggregation Brings
- Description
- Type
- Date
- Amount
- Merchant Details
- Category and more...
Sample Request - Get Transactions
url: /ysl/transactions
methodType: GET
Header:
Authorization: Bearer 〈your-user-access-token〉
Api-version: 1.1
Sample Response - Get Transactions
{
"transaction":[
{
"CONTAINER":"bank",
"id":6199521803,
"amount":{
"amount":3680.29,
"currency":"USD"
},
"baseType":"DEBIT",
"categoryType":"EXPENSE",
"categoryId":17,
"category":"Loans",
"categorySource":"SYSTEM",
"highLevelCategoryId":10000004,
"createdDate":"2018-01-19T13:42:35Z",
"lastUpdated":"2018-01-19T13:42:35Z",
"description":{
"original":"ACH Withdrawal-Debit XXXXXXXX00 - PPD US BANK - LOAN A BILL PAYMT",
"simple":"U.S. Bank Loan"
},
"type":"PAYMENT",
"subType":"LOAN",
"isManual":false,
"date":"2019-03-10",
"transactionDate":"2019-03-10",
"postDate":"2019-03-10",
"status":"POSTED",
"accountId":1112165599,
"runningBalance":{
"amount":5974.21,
"currency":"USD"
},
"checkNumber":"998",
"merchant":{
"id":"u.s.bank",
"name":"U.S. Bank",
"source":"FACTUAL",
"categoryLabel":[
"Loans"
],
"address":{
"address1":"4160 Mission St",
"city":"San Francisco",
"state":"CA",
"country":"USA",
"zip":"94112"
}
}
}
]
}
Simple 3-Step Integration
Step 1: Register
Enroll new user with Yodlee or obtain a token for existing user
Sample Request - Register User
url: /user/register
methodType: POST
Header:
Authorization: Bearer 〈your-user-access-token〉
Api-Version : 1.1
Body:
{
"user": {
"loginName": "testUser",
"locale": "en_US"
"email": "sample@gmail.com"
}
}
Sample Response - Register User
{
"user": {
"id": 37440620,
"loginName": "testUser",
"name": {
"first": "FIRSTNAME",
"last": "LASTNAME"
},
"roleType": "INDIVIDUAL",
"preferences": {
"currency": "USD",
"timeZone": "PST",
"dateFormat": "MM/dd/yyyy"
}
}
}
Step 2: Add a user’s financial account(s)
Yodlee FastLink, an easy to use "add account" wizard, seamlessly handles the end-to-end user experience for adding accounts. FastLink is the only supported approach for linking your customers' accounts (linking with API calls is no longer supported).
Step 3: API access to accounts and transaction data
Our RESTful API will help you access data in minutes.
Sample Request - Get Accounts
url: /ysl/accounts
methodType: GET
Header:
Authorization: Bearer 〈your-user-access-token〉
Api-version: 1.1</code>
Sample Response - Get Accounts
{
"account":[
{
"CONTAINER":"bank",
"isManual":false,
"isAsset":true,
"lastUpdated":"2017-09-21T06:08:29Z",
"currentBalance":{
"amount":20000,
"currency":"USD"
},
"availableBalance":{
"amount":20000,
"currency":"USD"
},
"displayedName":"Timothy",
"id":2251053,
"balance":{
"amount":20000,
"currency":"USD"
},
"accountName":"Savings Account",
"accountNumber":"xxxx8823",
"aggregationSource":"USER",
"dataset":[
{
"lastUpdateAttempt":"2017-09-21T06:08:51Z",
"updateEligibility":"ALLOW_UPDATE",
"name":"BASIC_AGG_DATA",
"lastUpdated":"2017-09-21T06:08:51Z",
"additionalStatus":"AVAILABLE_DATA_RETRIEVED"
}
],
"providerName":"Wells Fargo",
"accountStatus":"ACTIVE",
"accountType":"SAVINGS",
"providerId":"5",
"includeInNetWorth":true,
"createdDate":"2017-09-21T06:08:26Z",
"providerAccountId":2204099
}
]
}
Sample Request - Get Transactions
url: /ysl/transactions
methodType: GET
Header:
Authorization: Bearer 〈your-user-access-token〉
Api-version: 1.1
Sample Response - Get Transactions
{
"transaction":[
{
"CONTAINER":"bank",
"id":6199521803,
"amount":{
"amount":3680.29,
"currency":"USD"
},
"baseType":"DEBIT",
"categoryType":"EXPENSE",
"categoryId":17,
"category":"Loans",
"categorySource":"SYSTEM",
"highLevelCategoryId":10000004,
"createdDate":"2018-01-19T13:42:35Z",
"lastUpdated":"2018-01-19T13:42:35Z",
"description":{
"original":"ACH Withdrawal-Debit XXXXXXXX00 - PPD US BANK - LOAN A BILL PAYMT",
"simple":"U.S. Bank Loan"
},
"type":"PAYMENT",
"subType":"LOAN",
"isManual":false,
"date":"2019-03-10",
"transactionDate":"2019-03-10",
"postDate":"2019-03-10",
"status":"POSTED",
"accountId":1112165599,
"runningBalance":{
"amount":5974.21,
"currency":"USD"
},
"checkNumber":"998",
"merchant":{
"id":"u.s.bank",
"name":"U.S. Bank",
"source":"FACTUAL",
"categoryLabel":[
"Loans"
],
"address":{
"address1":"4160 Mission St",
"city":"San Francisco",
"state":"CA",
"country":"USA",
"zip":"94112"
}
}
}
]
}