obp_python.AccountInformationServiceAISApi

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

Method	HTTP request	Description
o_bpv2_0_0_get_transaction_types	GET /obp/v5.0.0/banks/{BANK_ID}/transaction-types	Get Transaction Types at Bank
o_bpv3_0_0_core_private_accounts_all_banks	GET /obp/v5.0.0/my/accounts	Get Accounts at all Banks (private)
o_bpv3_0_0_get_accounts_held	GET /obp/v5.0.0/banks/{BANK_ID}/accounts-held	Get Accounts Held
o_bpv3_0_0_get_core_transactions_for_bank_account	GET /obp/v5.0.0/my/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/transactions	Get Transactions for Account (Core)
o_bpv3_0_0_get_private_account_idsby_bank_id	GET /obp/v5.0.0/banks/{BANK_ID}/accounts/account_ids/private	Get Accounts at Bank (IDs only)
o_bpv3_0_0_private_accounts_at_one_bank	GET /obp/v5.0.0/banks/{BANK_ID}/accounts/private	Get Accounts at Bank (Minimal)
o_bpv3_1_0_answer_consent_challenge	POST /obp/v5.0.0/banks/{BANK_ID}/consents/{CONSENT_ID}/challenge	Answer Consent Challenge
o_bpv3_1_0_create_consent_email	POST /obp/v5.0.0/banks/{BANK_ID}/my/consents/EMAIL	Create Consent (EMAIL)
o_bpv3_1_0_create_consent_sms	POST /obp/v5.0.0/banks/{BANK_ID}/my/consents/SMS	Create Consent (SMS)
o_bpv3_1_0_get_server_jwk	GET /obp/v5.0.0/certs	Get JSON Web Key (JWK)
o_bpv3_1_0_revoke_consent	GET /obp/v5.0.0/banks/{BANK_ID}/my/consents/{CONSENT_ID}/revoke	Revoke Consent
o_bpv4_0_0_add_consent_user	PUT /obp/v5.0.0/banks/{BANK_ID}/consents/{CONSENT_ID}/user-update-request	Add User to a Consent
o_bpv4_0_0_get_bank_account_balances	GET /obp/v5.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/balances	Get Account Balances
o_bpv4_0_0_get_bank_accounts_balances	GET /obp/v5.0.0/banks/{BANK_ID}/balances	Get Accounts Balances
o_bpv4_0_0_get_banks	GET /obp/v5.0.0/banks	Get Banks
o_bpv4_0_0_get_consent_infos	GET /obp/v5.0.0/banks/{BANK_ID}/my/consent-infos	Get Consents Info
o_bpv4_0_0_get_consents	GET /obp/v5.0.0/banks/{BANK_ID}/my/consents	Get Consents
o_bpv4_0_0_get_core_account_by_id	GET /obp/v5.0.0/my/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/account	Get Account by Id (Core)
o_bpv4_0_0_update_consent_status	PUT /obp/v5.0.0/banks/{BANK_ID}/consents/{CONSENT_ID}	Update Consent Status
o_bpv5_0_0_create_consent_by_consent_request_id_email	POST /obp/v5.0.0/consumer/consent-requests/CONSENT_REQUEST_ID/EMAIL/consents	Create Consent By CONSENT_REQUEST_ID (EMAIL)
o_bpv5_0_0_create_consent_by_consent_request_id_sms	POST /obp/v5.0.0/consumer/consent-requests/CONSENT_REQUEST_ID/SMS/consents	Create Consent By CONSENT_REQUEST_ID (SMS)
o_bpv5_0_0_create_consent_request	POST /obp/v5.0.0/consumer/consent-requests	Create Consent Request
o_bpv5_0_0_get_bank	GET /obp/v5.0.0/banks/{BANK_ID}	Get Bank
o_bpv5_0_0_get_consent_by_consent_request_id	GET /obp/v5.0.0/consumer/consent-requests/CONSENT_REQUEST_ID/consents	Get Consent By Consent Request Id
o_bpv5_0_0_get_consent_request	GET /obp/v5.0.0/consumer/consent-requests/CONSENT_REQUEST_ID	Get Consent Request

o_bpv2_0_0_get_transaction_types

TransactionTypesJsonV200 o_bpv2_0_0_get_transaction_types(body, bank_id)

Get Transaction Types at Bank

Get Transaction Types for the bank specified by BANK_ID:

Lists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).

id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.
bank_id : The bank that supports this TransactionType
short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here
summary : A succinct summary
description : A longer description
charge : The charge to the customer for each one of these

Authentication is Optional

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.AccountInformationServiceAISApi(obp_python.ApiClient(configuration))
body = obp_python.EmptyClassJson() # EmptyClassJson | EmptyClassJson object that needs to be added.
bank_id = 'bank_id_example' # str | The bank id

try:
    # Get Transaction Types at Bank
    api_response = api_instance.o_bpv2_0_0_get_transaction_types(body, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->o_bpv2_0_0_get_transaction_types: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	EmptyClassJson	EmptyClassJson object that needs to be added.
bank_id	str	The bank id

Return type

TransactionTypesJsonV200

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_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.AccountInformationServiceAISApi(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 AccountInformationServiceAISApi->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_bpv3_0_0_get_accounts_held

CoreAccountsHeldJsonV300 o_bpv3_0_0_get_accounts_held(bank_id)

Get Accounts Held

Get Accounts held by the current User if even the User has not been assigned the owner View yet.

Can be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.

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:
/banks/BANK_ID/accounts-held?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.AccountInformationServiceAISApi(obp_python.ApiClient(configuration))
bank_id = 'bank_id_example' # str | The bank id

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

Parameters

Name	Type	Description	Notes
bank_id	str	The bank id

Return type

CoreAccountsHeldJsonV300

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_bpv3_0_0_get_core_transactions_for_bank_account

CoreTransactionsJsonV300 o_bpv3_0_0_get_core_transactions_for_bank_account(account_id, bank_id)

Get Transactions for Account (Core)

Returns transactions list (Core info) of the account specified by ACCOUNT_ID.

Authentication is Mandatory

Possible custom url parameters for pagination:

limit=NUMBER ==> default value: 50
offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

sort_direction=ASC/DESC ==> default value: DESC.

eg2:?limit=100&offset=0&sort_direction=ASC

from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).
to_date=DATE => example value: 2023-02-16T16:23:47.662Z. NOTE! The default value is now (2023-02-16T16:23:47.662Z).

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z

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.AccountInformationServiceAISApi(obp_python.ApiClient(configuration))
account_id = 'account_id_example' # str | The account id
bank_id = 'bank_id_example' # str | The bank id

try:
    # Get Transactions for Account (Core)
    api_response = api_instance.o_bpv3_0_0_get_core_transactions_for_bank_account(account_id, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->o_bpv3_0_0_get_core_transactions_for_bank_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str	The account id
bank_id	str	The bank id

Return type

CoreTransactionsJsonV300

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_bpv3_0_0_get_private_account_idsby_bank_id

AccountsIdsJsonV300 o_bpv3_0_0_get_private_account_idsby_bank_id(bank_id)

Get Accounts at Bank (IDs only)

Returns only the list of accounts ids at BANK_ID that the user has access to.

Each account must have at least one private View.

For each account the API returns its account ID.

If you want to see more information on the Views, use the Account Detail call.

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:
/banks/BANK_ID/accounts/account_ids/private?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.AccountInformationServiceAISApi(obp_python.ApiClient(configuration))
bank_id = 'bank_id_example' # str | The bank id

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

Parameters

Name	Type	Description	Notes
bank_id	str	The bank id

Return type

AccountsIdsJsonV300

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_bpv3_0_0_private_accounts_at_one_bank

CoreAccountsJsonV300 o_bpv3_0_0_private_accounts_at_one_bank(bank_id)

Get Accounts at Bank (Minimal)

Returns the minimal list of private accounts at BANK_ID that the user has access to.
For each account, the API returns the ID, routing addresses and the views available to the current user.

If you want to see more information on the Views, use the Account Detail call.

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:
/banks/BANK_ID/accounts/private?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.AccountInformationServiceAISApi(obp_python.ApiClient(configuration))
bank_id = 'bank_id_example' # str | The bank id

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

Parameters

Name	Type	Description	Notes
bank_id	str	The bank id

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_bpv3_1_0_answer_consent_challenge

ConsentChallengeJsonV310 o_bpv3_1_0_answer_consent_challenge(body, consent_id, bank_id)

Answer Consent Challenge

An OBP Consent allows the holder of the Consent to call one or more endpoints.

Consents must be created and authorisied using SCA (Strong Customer Authentication).

That is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.

Each Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, REVOKED, RECEIVED, VALID, REVOKEDBYPSU, EXPIRED, TERMINATEDBYTPP, AUTHORISED, AWAITINGAUTHORISATION.

Each Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
For example:
GET /obp/v4.0.0/users/current HTTP/1.1
Host: 127.0.0.1:8080
Consent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
EtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
zcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
tNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg

Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
cache-control: no-cache

Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.

Example of POST JSON:
{
"everything": false,
"views": [
{
"bank_id": "GENODEM1GLS",
"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"view_id": "owner"
}
],
"entitlements": [
{
"bank_id": "GENODEM1GLS",
"role_name": "CanGetCustomer"
}
],
"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"email": "eveline@example.com",
"valid_from": "2020-02-07T08:43:34Z",
"time_to_live": 3600
}
Please note that only optional fields are: consumer_id, valid_from and time_to_live.
In case you omit they the default values are used:
consumer_id = consumer of current user
valid_from = current time
time_to_live = consents.max_time_to_live

This endpoint is used to confirm a Consent previously created.

The User must supply a code that was sent out of band (OOB) for example via an SMS.

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.AccountInformationServiceAISApi(obp_python.ApiClient(configuration))
body = obp_python.PostConsentChallengeJsonV310() # PostConsentChallengeJsonV310 | PostConsentChallengeJsonV310 object that needs to be added.
consent_id = 'consent_id_example' # str | the consent id
bank_id = 'bank_id_example' # str | The bank id

try:
    # Answer Consent Challenge
    api_response = api_instance.o_bpv3_1_0_answer_consent_challenge(body, consent_id, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountInformationServiceAISApi->o_bpv3_1_0_answer_consent_challenge: %s\n" % e)

Parameters

Name	Type	Description
body	PostConsentChallengeJsonV310	PostConsentChallengeJsonV310 object that needs to be added.
consent_id	str	the consent id
bank_id	str	The bank id

Return type

ConsentChallengeJsonV310

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_bpv3_1_0_create_consent_email

ConsentJsonV310 o_bpv3_1_0_create_consent_email(body, bank_id)

Create Consent (EMAIL)

This endpoint starts the process of creating a Consent.

The Consent is created in an INITIATED state.

A One Time Password (OTP) (AKA security challenge) is sent Out of band (OOB) to the User via the transport defined in SCA_METHOD
SCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes.

When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.