Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 3.44 KB

EnrichDataApi.md

File metadata and controls

57 lines (38 loc) · 3.44 KB
Raw

python_client.EnrichDataApi

All URIs are relative to https://localhost

Method HTTP request Description
push_user_data POST /enrichData/userData Push UserData

push_user_data

EnrichedTransactionResponse push_user_data(user_data=user_data)

Push UserData

Push User Data
The data enrich API v1.1 allows customers to get the transactions enriched in real-time by feeding the data into the Yodlee Platform. To get the transactions enriched, it is necessary that users, accounts, and transactions are updated to the Yodlee Platform.
The following features are supported through the data enrich API:

  • Add user
  • Add account
  • Update account
  • Add transactions
  • Update transactions
Yodlee will enrich the transactions with the following information:
  • Category
  • High Level Category
  • Detail Category
  • Simple description
  • Merchant details
    • Name
    • Address
  • Transaction type
  • Transaction subtype
The data feed through the enrich APIs will be updated to the Yodlee Platform in real time. The updated accounts and transactions information can then be retrieved from the system using the respective Yodlee 1.1 APIs.
Implementation Notes
  • Supported only through credential-based authentication mechanisms.
  • Customer must be TLS 1.2 compliant to integrate with the data enrich API.
  • Supported account types are savings, checking, and credit.
  • A maximum of 128 transactions can be passed to the API.
  • As the data enrich API is a premium offering and is priced per API call, Yodlee recommends not to call the API to update accounts and transactions.
  • The minimum required parameters to create account and transaction is accepted. The Yodlee data model supports more parameters than what is accepted in this API. Customers can make the rest of the parameters available during the auto-refresh process of the accounts.
  • Though few input parameters are optional, Yodlee recommends passing them as the account information will make complete sense to the consumers when it is displayed in the Yodlee applications or widgets.

Example

from __future__ import print_function
import time
import python_client
from python_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = python_client.EnrichDataApi()
user_data = python_client.EnrichDataRequest() # EnrichDataRequest | Input for User Data (optional)

try:
    # Push UserData
    api_response = api_instance.push_user_data(user_data=user_data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EnrichDataApi->push_user_data: %s\n" % e)

Parameters

Name Type Description Notes
user_data EnrichDataRequest Input for User Data [optional]

Return type

EnrichedTransactionResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]