Documentation
Documentation
https://developer.yodlee.com/resources/yodlee/yodlee-api-overview/docs/overview
GettingStarted
https://developer.yodlee.com/docs/getting-started
OpenAPI Specification
swagger: '2.0'
info:
license:
name: Yodlee Developer License
url: https://developer.yodlee.com/terms/condition#_Services_1
contact:
email: developer@yodlee.com
description: 'This file describes the Yodlee Platform APIs using the swagger notation. You can use this swagger file to generate client side SDKs to the Yodlee Platform APIs for many different programming languages. Yodlee API v1.1 - Overview</a>.<br><br>You will have to set the header before making the API call. The following headers apply to all the APIs:<ul><li>Authorization: This header holds the access token</li> <li> Api-Version: 1.1</li></ul><b>Note</b>: If there are any API-specific headers, they are mentioned explicitly in the respective API''s description.'
termsOfService: https://developer.yodlee.com/terms/condition
title: Yodlee Core APIs Account Token Accounts API
version: 1.1.0
basePath: /
tags:
- name: Accounts
description: Accounts API
paths:
/accounts/associatedAccounts/{providerAccountId}:
get:
summary: Associated Accounts
deprecated: false
produces:
- application/json;charset=UTF-8
description: Yodlee classifies providers into credential-based aggregation and Open Banking (OB) providers.<br>This service is associated with the OB aggregation flow. As part of the OB solution, financial institutions may merge their subsidiaries and provide data as a single OB provider.<br>Before the OB solution, this data was aggregated with different provider IDs.<br>This service accepts the providerAccountId and returns all accounts of the associated providerAccounts that belong to the subsidiary of the financial institution.<br>This data should be displayed to the user to let them select the accounts that they wish to provide consent to share account data.<br>
operationId: getAssociatedAccounts
responses:
200:
schema:
$ref: '#/definitions/AssociatedAccountsResponse'
description: OK
400:
schema:
$ref: '#/definitions/YodleeError'
description: 'Y800 : Invalid value for providerAccountId<br>'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: path
name: providerAccountId
format: int64
description: providerAccountId
type: integer
required: true
tags:
- Accounts
/accounts:
post:
summary: Add Manual Account
deprecated: false
produces:
- application/json;charset=UTF-8
description: The add account service is used to add manual accounts.<br>The response of add account service includes the account name , account number and Yodlee generated account id.<br>All manual accounts added will be included as part of networth calculation by default.<br>Add manual account support is available for bank, card, investment, insurance and loan container only.<br><br><b>Note:</b><ul> <li>A real estate account addition is only supported for SYSTEM and MANUAL valuation type.</li></ul>
operationId: createManualAccount
responses:
200:
schema:
$ref: '#/definitions/CreatedAccountResponse'
description: OK
400:
schema:
$ref: '#/definitions/YodleeError'
description: 'Y800 : Invalid value for accountParam<br>Y811 : Real Estate Property value already exists<br>Y862 : The provided address is invalid, or the valuation is not available<br>Y869 : Multiple matches found. Provide the complete address or call the POST /accounts/evaluateAddress API to retrieve the list of matched addresses<br>'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- schema:
$ref: '#/definitions/CreateAccountRequest'
in: body
name: accountParam
description: accountParam
required: true
tags:
- Accounts
consumes:
- application/json
get:
summary: Get Accounts
deprecated: false
produces:
- application/json;charset=UTF-8
description: The get accounts service provides information about accounts added by the user.<br>By default, this service returns information for active and to be closed accounts.<br>If requestId is provided, the accounts that are updated in the context of the requestId will be provided in the response.<br>Pagination is made available to the advisors to retrieve account data of all users assigned to them. The skip and top parameters are used for pagination. In the skip and top parameters pass the number of records to be skipped and retrieved, respectively. <br><br><b>Note:</b><br><ul><li>fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.</li><li>fullAccountNumberList, PII (Personal Identifiable Information) and holder details are not available by default, as it is a premium feature that needs security approval. This will not be available for testing in Sandbox environment.</li></ul>
operationId: getAllAccounts
responses:
200:
schema:
$ref: '#/definitions/AccountResponse'
description: OK
400:
schema:
$ref: '#/definitions/YodleeError'
description: 'Y800 : Invalid value for status<br>Y800 : Invalid value for container<br>Y800 : Invalid value for providerAccountId<br>Y824 : The maximum number of accountIds permitted is 100'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: query
allowEmptyValue: false
name: accountId
description: Comma separated accountIds.
type: string
required: false
- in: query
allowEmptyValue: false
name: container
description: bank/creditCard/investment/insurance/loan/reward/realEstate/otherAssets/otherLiabilities
type: string
required: false
- in: query
allowEmptyValue: false
name: convertToCurrency
description: On-demand currency conversion parameter
type: string
required: false
- in: query
allowEmptyValue: false
name: include
description: profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh<br><b>Note:</b><br><li>fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.</li><br><li>profile is deprecated, and to retrieve the profile information, call the GET /verification/holderProfile API instead.</li>
type: string
required: false
- in: query
allowEmptyValue: false
name: providerAccountId
description: Comma separated providerAccountIds.
type: string
required: false
- in: query
allowEmptyValue: false
name: requestId
description: The unique identifier that returns contextual data
type: string
required: false
- in: query
allowEmptyValue: false
name: status
description: ACTIVE,INACTIVE,TO_BE_CLOSED,CLOSED
type: string
required: false
tags:
- Accounts
/accounts/migrateAccounts/{providerAccountId}:
put:
summary: Migrate Accounts
deprecated: false
produces:
- application/json;charset=UTF-8
description: This service is associated with the open banking (OB) flow.<br>Before invoking this service, display all the associated accounts to the user by calling the GET /associatedAccounts API.<br>The migrate accounts API treats the user's consent acceptance to initiate account migration. Invoking this service indicates that the user has given the consent to access the associated account information from the financial institution.<br>If an existing provider supports bank, card, and loan accounts, and chose only to provide bank and card through OB APIs, a new providerAccountId for OB will be created.<br>The bank and card account information will be moved to the new providerAccountId. The loan account will be retained in the existing provider account.<br>This service returns the OB providerId and the OB providerAccountId. Note that, as part of this process, there is a possibility of one or more providerAccounts getting merged.<br>The update or delete actions will not be allowed for the providerAccounts involved in the migration process until the user completes the authorization on the OB provider.<br>The oauthMigrationEligibilityStatus attribute in the GET /accounts API response indicates the accounts included in the migration process.<br>
operationId: migrateAccounts
responses:
200:
schema:
$ref: '#/definitions/AccountMigrationResponse'
description: OK
400:
schema:
$ref: '#/definitions/YodleeError'
description: 'Y800 : Invalid value for providerAccountId<br>'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: path
name: providerAccountId
format: int64
description: providerAccountId
type: integer
required: true
tags:
- Accounts
consumes:
- application/json
/accounts/evaluateAddress:
post:
summary: Evaluate Address
deprecated: false
produces:
- application/json;charset=UTF-8
description: Use this service to validate the address before adding the real estate account.<br>If the address is valid, the service will return the complete address information.<br>The response will contain multiple addresses if the user-provided input matches with multiple entries in the vendor database.<br>In the case of multiple matches, the user can select the appropriate address from the list and then invoke the add account service with the complete address.<br><br><b>Note:</b> <ul><li>Yodlee recommends to use this service before adding the real estate account to avoid failures.</li></ul>
operationId: evaluateAddress
responses:
200:
schema:
$ref: '#/definitions/EvaluateAddressResponse'
description: OK
400:
schema:
$ref: '#/definitions/YodleeError'
description: 'Y806 : Invalid input<br>Y800 : Invalid value for zip<br>Y812 : Required field/value - address missing in the request<br>Y812 : Required field/value - street missing in the request<br>Y812 : Required field/value - state & city / zip missing in the request'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- schema:
$ref: '#/definitions/EvaluateAddressRequest'
in: body
name: addressParam
description: addressParam
required: true
tags:
- Accounts
consumes:
- application/json
/accounts/{accountId}:
get:
summary: Get Account Details
deprecated: false
produces:
- application/json;charset=UTF-8
description: The get account details service provides detailed information of an account.<br><br><b>Note:</b><li> fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.</li>
operationId: getAccount
responses:
200:
schema:
$ref: '#/definitions/AccountResponse'
description: OK
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: path
name: accountId
format: int64
description: accountId
type: integer
required: true
- in: query
allowEmptyValue: false
name: convertToCurrency
description: On-demand currency conversion parameter
type: string
required: false
- in: query
allowEmptyValue: false
name: include
description: profile, holder, fullAccountNumber, fullAccountNumberList, paymentProfile, autoRefresh<br><b>Note:</b>fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.
type: string
required: false
tags:
- Accounts
delete:
summary: Delete Account
deprecated: false
produces:
- application/json;charset=UTF-8
description: The delete account service allows an account to be deleted.<br>This service does not return a response. The HTTP response code is 204 (Success with no content).<br>
operationId: deleteAccount
responses:
400:
schema:
$ref: '#/definitions/YodleeError'
description: 'Y800 : Invalid value for accountId<br>Y806 : Invalid input<br>Y807 : Resource not found<br>Y868 : No action is allowed, as the data is being migrated to the Open Banking provider<br>'
401:
description: Unauthorized
204:
description: OK
404:
description: Not Found
parameters:
- in: path
name: accountId
format: int64
description: accountId
type: integer
required: true
tags:
- Accounts
put:
summary: Update Account
deprecated: false
produces:
- application/json;charset=UTF-8
description: The update account service is used to update manual and aggregated accounts.<br>The HTTP response code is 204 (Success without content).<br>Update manual account support is available for bank, card, investment, insurance, loan, otherAssets, otherLiabilities and realEstate containers only.<br><br><b>Note:</b><li> A real estate account update is only supported for SYSTEM and MANUAL valuation type.</li> <li> A real estate account can be linked to a loan account by passing accountId of a loan account in linkedAccountIds .</li> <li> Attribute <b>isEbillEnrolled</b> is deprecated as it is applicable for bill accounts only.</li>
operationId: updateAccount
responses:
400:
schema:
$ref: '#/definitions/YodleeError'
description: 'Y800 : Invalid value for accountId<br>Y800 : Invalid value for updateParam<br>Y862 : The provided address is invalid, or the valuation is not available<br>Y868 : No action is allowed, as the data is being migrated to the Open Banking provider<br>Y869 : Multiple matches found. Provide the complete address or call the POST /accounts/evaluateAddress API to retrieve the list of matched addresses<br>'
401:
description: Unauthorized
204:
description: OK
404:
description: Not Found
parameters:
- in: path
name: accountId
format: int64
description: accountId
type: integer
required: true
- schema:
$ref: '#/definitions/UpdateAccountRequest'
in: body
name: accountRequest
description: accountRequest
required: true
tags:
- Accounts
consumes:
- application/json
/accounts/historicalBalances:
get:
summary: Get Historical Balances
deprecated: false
produces:
- application/json;charset=UTF-8
description: The historical balances service is used to retrieve the historical balances for an account or a user.<br>Historical balances are daily (D), weekly (W), and monthly (M). <br>The interval input should be passed as D, W, and M to retrieve the desired historical balances. The default interval is daily (D). <br>When no account id is provided, historical balances of the accounts that are active, to be closed, and closed are provided in the response. <br>If the fromDate and toDate are not passed, the last 90 days of data will be provided. <br>The fromDate and toDate should be passed in the YYYY-MM-DD format. <br>The date field in the response denotes the date for which the balance is requested.<br>includeCF needs to be sent as true if the customer wants to return carried forward balances for a date when the data is not available. <br>asofDate field in the response denotes the date as of which the balance was updated for that account.<br>When there is no balance available for a requested date and if includeCF is sent as true, the previous date for which the balance is available is provided in the response. <br>When there is no previous balance available, no data will be sent. <br>By default, pagination is available for the historicalBalances entity in this API. The skip and top parameters are used for pagination. In the skip and top parameters, pass the number of records to be skipped and retrieved, respectively. The response header provides the links to retrieve the next and previous set of historical balances.<br> The API will only retrieve a maximum 500 records by default when values for skip and top parameters are not provided.
operationId: getHistoricalBalances
responses:
200:
schema:
$ref: '#/definitions/AccountHistoricalBalancesResponse'
description: OK
400:
schema:
$ref: '#/definitions/YodleeError'
description: 'Y800 : Invalid value for accountId<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for toDate<br>Y809 : Invalid date range<br>Y800 : Invalid value for interval<br>Y802 : Future date not allowed'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: query
allowEmptyValue: false
name: accountId
description: accountId
type: string
required: false
- in: query
allowEmptyValue: false
name: fromDate
description: from date for balance retrieval (YYYY-MM-DD)
type: string
required: false
- in: query
allowEmptyValue: false
name: includeCF
description: Consider carry forward logic for missing balances
type: boolean
required: false
- in: query
allowEmptyValue: false
name: interval
description: D-daily, W-weekly or M-monthly
type: string
required: false
- in: query
allowEmptyValue: false
name: skip
format: int32
description: skip (Min 0)
type: integer
required: false
- in: query
allowEmptyValue: false
name: toDate
description: toDate for balance retrieval (YYYY-MM-DD)
type: string
required: false
- in: query
allowEmptyValue: false
name: top
format: int32
description: top (Max 500)
type: integer
required: false
tags:
- Accounts
/accounts/latestBalances:
get:
summary: Get Latest Balances
deprecated: false
produces:
- application/json;charset=UTF-8
description: The latest balances service provides the latest account balance by initiating a new balance refresh request
operationId: getLatestBalances
responses:
200:
schema:
$ref: '#/definitions/AccountBalanceResponse'
description: OK
400:
schema:
$ref: '#/definitions/YodleeError'
description: 'Y800 : Invalid value for providerAccountId<br>Y800 : Invalid value for accountId <br>Y800 : Invalid value for accountId. Only ACTIVE accountId are supported <br>Y901 : Service not supported<br>Y803 : providerAccountId required <br>Y805 : Multiple providerAccountId not supported <br>Y803 : accountId required <br>Y820 : The accountId is not supported for container other than bank, investment<br>Y824 : The maximum number of accountIds permitted is 10<br>Y800 : Invalid value for accountId. All accountIds should belong to the same providerAccountId'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: query
allowEmptyValue: false
name: accountId
description: Comma separated accountIds.
type: string
required: true
- in: query
allowEmptyValue: false
name: providerAccountId
description: providerAccountId.
type: string
required: true
tags:
- Accounts
definitions:
EvaluateAccountAddress:
type: object
title: EvaluateAccountAddress
required:
- street
properties:
zip:
description: Zip.
type: string
country:
description: Country.
type: string
address3:
description: Address Line 3.
type: string
address2:
description: Address Line 2.
type: string
city:
description: City.
type: string
sourceType:
type: string
address1:
description: Address Line 1.
type: string
street:
type: string
state:
description: State.
type: string
type:
type: string
enum:
- HOME
- BUSINESS
- POBOX
- RETAIL
- OFFICE
- SMALL_BUSINESS
- COMMUNICATION
- PERMANENT
- STATEMENT_ADDRESS
- PAYMENT
- PAYOFF
- UNKNOWN
PaymentIdentifier:
type: object
title: PaymentIdentifier
properties:
type:
description: Type of Identifier
readOnly: true
type: string
enum:
- REFERENCE_NUMBER
- PLATFORM_CODE
value:
description: Value of the identifier
readOnly: true
type: string
PaymentBankTransferCode:
type: object
title: PaymentBankTransferCode
properties:
id:
description: Value of the identifier
readOnly: true
type: string
type:
description: Type of BankTransferCode
readOnly: true
type: string
enum:
- ROUTING_NUMBER
- BSB
- IFSC
- SORT_CODE
AccountHistory:
type: object
title: AccountHistory
properties:
historicalBalances:
readOnly: true
type: array
items:
$ref: '#/definitions/HistoricalBalance'
id:
format: int64
readOnly: true
type: integer
Account:
type: object
title: Account
properties:
availableCash:
description: 'The amount that is available for an ATM withdrawal, i.e., the cash available after deducting the amount that is already withdrawn from the total cash limit. (totalCashLimit-cashAdvance= availableCash)<br><b>Additional Details:</b> The available cash amount at the account-level can differ from the available cash at the statement-level, as the information in the aggregated card account data provides more up-to-date information.<br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: creditCard<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
$ref: '#/definitions/Money'
includeInNetWorth:
description: 'Used to determine whether an account to be considered in the networth calculation.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank,creditCard,loan,investment,insurance,realEstate,otherAssets,otherLiabilities<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
type: boolean
moneyMarketBalance:
description: 'The amount in the money market fund or its equivalent such as bank deposit programs.<br><b>Note:</b> The money market balance field is only applicable to brokerage related accounts.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: investment<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
$ref: '#/definitions/Money'
enrollmentDate:
description: 'Date on which the user is enrolled on the rewards program.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
type: string
estimatedDate:
description: 'The date on which the home value was estimated.<br><br><b>Aggregated / Manual</b>: Manual<br><b>Applicable containers</b>: realEstate<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
type: string
memo:
description: 'The additional description or notes given by the user.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
type: string
guarantor:
description: 'A nonprofit or state organization that works with lender, servicer, school, and the Department of Education to help successfully repay Federal Family Education Loan Program (FFELP) loans. If FFELP student loans default, the guarantor takes ownership of them.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: loan<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
type: string
interestPaidLastYear:
description: 'Interest paid in last calendar year.<br><b>Applicable containers</b>: loan<br><b>Aggregated / Manual</b>: Aggregated<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
$ref: '#/definitions/Money'
lastUpdated:
description: 'The date time the account information was last retrieved from the provider site and updated in the Yodlee system.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
type: string
balance:
description: 'The total account value. <br><b>Additional Details:</b><br><b>Bank:</b> available balance or current balance.<br><b>Credit Card:</b> running Balance.<br><b>Investment:</b> The total balance of all the investment account, as it appears on the FI site.<br><b>Insurance:</b> CashValue or amountDue<br><b>Loan:</b> principalBalance<br><b>Applicable containers</b>: bank, creditCard, investment, insurance, loan, otherAssets, otherLiabilities, realEstate<br><b>Aggregated / Manual</b>: Both <br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
$ref: '#/definitions/Money'
nsccMemberClearingCode:
description: 'Used in the mutual fund industry as a standard method of identifying funds, firms, and other intermediaries such as third-party administrators and recordkeepers.<br>This attribute will only populate when account is aggregated through ATV flow.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: Investment container<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
type: string
homeInsuranceType:
description: 'Type of home insurance, like -<ul><li>HOME_OWNER</li><li>RENTAL</li><li>RENTER</li><li>etc..</li></ul><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: insurance<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- HOME_OWNER
- RENTAL
- RENTER
- UNKNOWN
- OTHER
id:
format: int64
description: 'The primary key of the account resource and the unique identifier for the account.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts </li><li>GET accounts/{accountId}</li><li>GET investmentOptions</li><li>GET accounts/historicalBalances</li><li>POST accounts</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
type: integer
cash:
description: 'The amount that is available for immediate withdrawal or the total amount available to purchase securities in a brokerage or investment account.<br><b>Note:</b> The cash balance field is only applicable to brokerage related accounts.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: investment<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
$ref: '#/definitions/Money'
totalCreditLine:
description: 'Total credit line is the amount of money that can be charged to a credit card. If credit limit of $5,000 is issued on a credit card, the total charges on the card cannot exceed this amount.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: creditCard<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
$ref: '#/definitions/Money'
providerName:
description: 'Service provider or institution name where the account originates. This belongs to the provider resource.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
type: string
valuationType:
description: 'The valuation type indicates whether the home value is calculated either manually or by Yodlee Partners.<br><br><b>Aggregated / Manual</b>: Manual<br><b>Applicable containers</b>: realEstate<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- SYSTEM
- MANUAL
marginBalance:
description: 'The amount of borrowed funds used to purchase securities.<br><b>Note</b>: Margin balance is displayed only if the brokerage account is approved for margin. The margin balance field is only applicable to brokerage related accounts.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: investment<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
$ref: '#/definitions/Money'
apr:
format: double
description: 'The annual percentage rate (APR) is the yearly rate of interest on the credit card account.<br><b>Additional Details:</b> The yearly percentage rate charged when a balance is held on a credit card. This rate of interest is applied every month on the outstanding credit card balance.<br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: creditCard<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
type: number
availableCredit:
description: '<br><b>Credit Card:</b> Amount that is available to spend on the credit card. It is usually the Total credit line- Running balance- pending charges. <br><b>Loan:</b> The unused portion of line of credit, on a revolving loan (such as a home-equity line of credit).<br><b>Additional Details:</b><br><b>Note:</b> The available credit amount at the account-level can differ from the available credit field at the statement-level, as the information in the aggregated card account data provides more up-to-date information.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: creditCard, loan<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
$ref: '#/definitions/Money'
sourceProductName:
description: 'sourceProductName: The account unique identifier belongi
# --- truncated at 32 KB (149 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yodlee/refs/heads/main/openapi/yodlee-accounts-api-openapi.yml