Skip to content

Latest commit

 

History

History
124 lines (89 loc) · 5 KB

PrivateDataApi.md

File metadata and controls

124 lines (89 loc) · 5 KB
Raw

obp_python.PrivateDataApi

All URIs are relative to http://test.openbankproject.com

Method HTTP request Description
o_bpv3_0_0_core_private_accounts_all_banks GET /obp/v5.0.0/my/accounts Get Accounts at all Banks (private)
o_bpv4_0_0_get_private_accounts_at_one_bank GET /obp/v5.0.0/banks/{BANK_ID}/accounts Get Accounts at Bank

o_bpv3_0_0_core_private_accounts_all_banks

CoreAccountsJsonV300 o_bpv3_0_0_core_private_accounts_all_banks()

Get Accounts at all Banks (private)

Returns the list of accounts containing private views for the user.
Each account lists the views available to the user.

optional request parameters:

  • account_type_filter: one or many accountType value, split by comma
  • account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE

whole url example:
/my/accounts?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE

Authentication is Mandatory

Example

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

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.PrivateDataApi(obp_python.ApiClient(configuration))

try:
    # Get Accounts at all Banks (private)
    api_response = api_instance.o_bpv3_0_0_core_private_accounts_all_banks()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PrivateDataApi->o_bpv3_0_0_core_private_accounts_all_banks: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CoreAccountsJsonV300

Authorization

directLogin, gatewayLogin

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

o_bpv4_0_0_get_private_accounts_at_one_bank

BasicAccountsJSON o_bpv4_0_0_get_private_accounts_at_one_bank(bank_id)

Get Accounts at Bank

Returns the list of accounts at BANK_ID that the user has access to.
For each account the API returns the account ID and the views available to the user..
Each account must have at least one private View.

optional request parameters for filter with attributes
URL params example: /banks/some-bank-id/accounts?manager=John&count=8

Authentication is Mandatory

Example

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

# Configure API key authorization: directLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure API key authorization: gatewayLogin
configuration = obp_python.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = obp_python.PrivateDataApi(obp_python.ApiClient(configuration))
bank_id = 'bank_id_example' # str | The bank id

try:
    # Get Accounts at Bank
    api_response = api_instance.o_bpv4_0_0_get_private_accounts_at_one_bank(bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PrivateDataApi->o_bpv4_0_0_get_private_accounts_at_one_bank: %s\n" % e)

Parameters

Name Type Description Notes
bank_id str The bank id

Return type

BasicAccountsJSON

Authorization

directLogin, gatewayLogin

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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