Skip to content

Latest commit

 

History

History
230 lines (172 loc) · 13.9 KB

ProvidersApi.md

File metadata and controls

230 lines (172 loc) · 13.9 KB
Raw

yodlee.ProvidersApi

All URIs are relative to http://localhost

Method HTTP request Description
get_all_providers GET /providers Get Providers
get_provider GET /providers/{providerId} Get Provider Details
get_providers_count GET /providers/count Get Providers Count

get_all_providers

ProviderResponse get_all_providers(capability=capability, datasetfilter=datasetfilter, full_account_number_fields=full_account_number_fields, institution_id=institution_id, name=name, priority=priority, provider_id=provider_id, skip=skip, top=top)

Get Providers

The get provider service is used to get all the providers that are enabled, search a provider service by name or routing number and get popular sites of a region.
Searching for a provider using a routing number is applicable only to the USA and Canada regions.
The valid values for priority are:
1. cobrand: Returns providers enabled for the cobrand (Default priority)
2. popular: Returns providers popular among users of the customer

Only the datasets, attributes, and containers that are enabled for the customer will be returned in the response.
Input for the dataset$filter should adhere to the following expression:
<dataset.name>[<attribute.name>.container[ OR ] OR <attribute.name>.container[]]
OR <dataset.name>[<attribute.name> OR <attribute.name>]
dataset$filter value examples:
ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank OR investment OR creditCard]]
ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]
BASIC_AGG_DATA[ACCOUNT_DETAILS.container[bank OR investment] OR HOLDINGS.container[bank]] OR ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]
BASIC_AGG_DATA
BASIC_AGG_DATA OR ACCT_PROFILE
BASIC_AGG_DATA [ ACCOUNT_DETAILS OR HOLDINGS ]
BASIC_AGG_DATA [ ACCOUNT_DETAILS] OR DOCUMENT
BASIC_AGG_DATA [ BASIC_ACCOUNT_INFO OR ACCOUNT_DETAILS ]

The fullAcountNumberFields is specified to filter the providers that have paymentAccountNumber or unmaskedAccountNumber support in the FULL_ACCT_NUMBER dataset attribute.
Examples for usage of fullAccountNumberFields
dataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=paymentAccountNumber
dataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=unmaskedAccountNumber
dataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=unmaskedAccountNumber,paymentAccountNumber

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 transactions.

Note:

  1. In a product flow involving user interaction, Yodlee recommends invoking this service with filters.
  2. Without filters, the service may perform slowly as it takes a few minutes to return data in the response.
  3. The AuthParameter appears in the response only in case of token-based aggregation sites.
  4. The pagination feature only applies when the priority parameter is set as cobrand. If no values are provided in the skip and top parameters, the API will only return the first 500 records.
  5. This service supports the localization feature and accepts locale as a header parameter.
  6. The capability has been deprecated in query parameter and response.

Example

from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.ProvidersApi(api_client)
    capability = 'capability_example' # str | CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated (optional)
datasetfilter = 'datasetfilter_example' # str | Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer. (optional)
full_account_number_fields = 'full_account_number_fields_example' # str | Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber. (optional)
institution_id = 56 # int | Institution Id for Single site selection (optional)
name = 'name_example' # str | Name in minimum 1 character or routing number. (optional)
priority = 'priority_example' # str | Search priority (optional)
provider_id = 'provider_id_example' # str | Max 5 Comma seperated Provider Ids (optional)
skip = 56 # int | skip (Min 0) - This is not applicable along with 'name' parameter. (optional)
top = 56 # int | top (Max 500) - This is not applicable along with 'name' parameter. (optional)

    try:
        # Get Providers
        api_response = api_instance.get_all_providers(capability=capability, datasetfilter=datasetfilter, full_account_number_fields=full_account_number_fields, institution_id=institution_id, name=name, priority=priority, provider_id=provider_id, skip=skip, top=top)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ProvidersApi->get_all_providers: %s\n" % e)

Parameters

Name Type Description Notes
capability str CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated [optional]
datasetfilter str Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer. [optional]
full_account_number_fields str Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber. [optional]
institution_id int Institution Id for Single site selection [optional]
name str Name in minimum 1 character or routing number. [optional]
priority str Search priority [optional]
provider_id str Max 5 Comma seperated Provider Ids [optional]
skip int skip (Min 0) - This is not applicable along with 'name' parameter. [optional]
top int top (Max 500) - This is not applicable along with 'name' parameter. [optional]

Return type

ProviderResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Y800 : Invalid value for priority<br>Y800 : Invalid value for providerName<br>Y801 : Invalid length for a site search. The search string must have atleast 1 character<br>Y800 : Invalid value for skip<br>Y804 : Permitted values of top between 1 - 500<br>Y821 : Dataset not supported<br>Y820 : The additionalDataSet is not supported for Get provider API -
401 Unauthorized -
404 Not Found -

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

get_provider

ProviderDetailResponse get_provider(provider_id)

Get Provider Details

The get provider detail service is used to get detailed information including the login form for a provider.
The response is a provider object that includes information such as name of the provider,
provider's base URL, a list of containers supported by the provider, the login form details of the provider, etc.
Only enabled datasets, attributes and containers gets returned in the response.

Note:

  • This service supports the localization feature and accepts locale as a header parameter.
  • The capability has been deprecated in the response.

    Example

    from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.ProvidersApi(api_client)
    provider_id = 56 # int | providerId

    try:
        # Get Provider Details
        api_response = api_instance.get_provider(provider_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ProvidersApi->get_provider: %s\n" % e)

    Parameters

    Name Type Description Notes
    provider_id int providerId

    Return type

    ProviderDetailResponse

    Authorization

    No authorization required

    HTTP request headers

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

    HTTP response details

    Status code Description Response headers
    200 OK -
    400 Y800 : Invalid value for providerId -
    401 Unauthorized -
    404 Not Found -

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

    get_providers_count

    ProvidersCountResponse get_providers_count(capability=capability, datasetfilter=datasetfilter, full_account_number_fields=full_account_number_fields, name=name, priority=priority)

    Get Providers Count

    The count service provides the total number of providers that get returned in the GET /providers depending on the input parameters passed.
    If you are implementing pagination for providers, call this endpoint before calling GET /providers to know the number of providers that are returned for the input parameters passed.
    The functionality of the input parameters remains the same as that of the GET /providers endpoint

    Note:

  • The capability has been deprecated in the query parameter.

    • Example

    from __future__ import print_function
import time
import yodlee
from yodlee.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yodlee.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with yodlee.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = yodlee.ProvidersApi(api_client)
    capability = 'capability_example' # str | CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated (optional)
datasetfilter = 'datasetfilter_example' # str | Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer. (optional)
full_account_number_fields = 'full_account_number_fields_example' # str | Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber. (optional)
name = 'name_example' # str | Name in minimum 1 character or routing number. (optional)
priority = 'priority_example' # str | Search priority (optional)

    try:
        # Get Providers Count
        api_response = api_instance.get_providers_count(capability=capability, datasetfilter=datasetfilter, full_account_number_fields=full_account_number_fields, name=name, priority=priority)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ProvidersApi->get_providers_count: %s\n" % e)

    Parameters

    Name Type Description Notes
    capability str CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated [optional]
    datasetfilter str Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer. [optional]
    full_account_number_fields str Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber. [optional]
    name str Name in minimum 1 character or routing number. [optional]
    priority str Search priority [optional]

    Return type

    ProvidersCountResponse

    Authorization

    No authorization required

    HTTP request headers

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

    HTTP response details

    Status code Description Response headers
    200 OK -
    400 Y800 : Invalid value for priority<br>Y800 : Invalid value for providerName<br>Y801 : Invalid length for a site search. The search string must have at least 1 character<br>Y800 : Invalid value for skip<br>Y804 : Permitted values of top between 1 - 500<br>Y821 : Dataset not supported<br>Y820 : The additionalDataSet is not supported for Get provider API -
    401 Unauthorized -
    404 Not Found -

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