obp_python.BankApi

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_bpv2_1_0_create_transaction_type	PUT /obp/v5.0.0/banks/{BANK_ID}/transaction-types	Create Transaction Type at bank
o_bpv2_1_0_get_transaction_request_types_supported_by_bank	GET /obp/v5.0.0/banks/{BANK_ID}/transaction-request-types	Get Transaction Request Types at Bank
o_bpv3_0_0_get_branch	GET /obp/v5.0.0/banks/{BANK_ID}/branches/{BRANCH_ID}	Get Branch
o_bpv3_0_0_get_branches	GET /obp/v5.0.0/banks/{BANK_ID}/branches	Get Branches for a Bank
o_bpv3_1_0_create_account_webhook	POST /obp/v5.0.0/banks/{BANK_ID}/account-web-hooks	Create an Account Webhook
o_bpv3_1_0_enable_disable_account_webhook	PUT /obp/v5.0.0/banks/{BANK_ID}/account-web-hooks	Enable/Disable an Account Webhook
o_bpv3_1_0_get_account_webhooks	GET /obp/v5.0.0/management/banks/{BANK_ID}/account-web-hooks	Get Account Webhooks
o_bpv4_0_0_create_bank_account_notification_webhook	POST /obp/v5.0.0/banks/{BANK_ID}/web-hooks/account/notifications/on-create-transaction	Create bank level Account Notification Webhook
o_bpv4_0_0_create_bank_attribute	POST /obp/v5.0.0/banks/{BANK_ID}/attribute	Create Bank Attribute
o_bpv4_0_0_create_or_update_bank_attribute_definition	PUT /obp/v5.0.0/banks/{BANK_ID}/attribute-definitions/bank	Create or Update Bank Attribute Definition
o_bpv4_0_0_create_settlement_account	POST /obp/v5.0.0/banks/{BANK_ID}/settlement-accounts	Create Settlement Account
o_bpv4_0_0_create_system_account_notification_webhook	POST /obp/v5.0.0/web-hooks/account/notifications/on-create-transaction	Create system level Account Notification Webhook
o_bpv4_0_0_delete_bank_attribute	DELETE /obp/v5.0.0/banks/{BANK_ID}/attributes/BANK_ATTRIBUTE_ID	Delete Bank Attribute
o_bpv4_0_0_delete_bank_cascade	DELETE /obp/v5.0.0/management/cascading/banks/{BANK_ID}	Delete Bank Cascade
o_bpv4_0_0_get_bank_attribute	GET /obp/v5.0.0/banks/{BANK_ID}/attributes/BANK_ATTRIBUTE_ID	Get Bank Attribute By BANK_ATTRIBUTE_ID
o_bpv4_0_0_get_bank_attributes	GET /obp/v5.0.0/banks/{BANK_ID}/attributes	Get Bank Attributes
o_bpv4_0_0_get_banks	GET /obp/v5.0.0/banks	Get Banks
o_bpv4_0_0_get_settlement_accounts	GET /obp/v5.0.0/banks/{BANK_ID}/settlement-accounts	Get Settlement accounts at Bank
o_bpv4_0_0_update_bank_attribute	PUT /obp/v5.0.0/banks/{BANK_ID}/attributes/BANK_ATTRIBUTE_ID	Update Bank Attribute
o_bpv5_0_0_create_bank	POST /obp/v5.0.0/banks	Create Bank
o_bpv5_0_0_get_bank	GET /obp/v5.0.0/banks/{BANK_ID}	Get Bank
o_bpv5_0_0_update_bank	PUT /obp/v5.0.0/banks	Update Bank

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.BankApi(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 BankApi->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_bpv2_1_0_create_transaction_type

TransactionType o_bpv2_1_0_create_transaction_type(body, bank_id)

Create Transaction Type at bank

Create Transaction Types for the bank specified by BANK_ID:

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

try:
    # Create Transaction Type at bank
    api_response = api_instance.o_bpv2_1_0_create_transaction_type(body, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BankApi->o_bpv2_1_0_create_transaction_type: %s\n" % e)

Parameters

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

Return type

TransactionType

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_bpv2_1_0_get_transaction_request_types_supported_by_bank

TransactionRequestTypesJSON o_bpv2_1_0_get_transaction_request_types_supported_by_bank(body, bank_id)

Get Transaction Request Types at Bank

Get the list of the Transaction Request Types supported by the bank.

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.BankApi(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 Request Types at Bank
    api_response = api_instance.o_bpv2_1_0_get_transaction_request_types_supported_by_bank(body, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BankApi->o_bpv2_1_0_get_transaction_request_types_supported_by_bank: %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

TransactionRequestTypesJSON

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_branch

BranchJsonV300 o_bpv3_0_0_get_branch(branch_id, bank_id)

Get Branch

Returns information about a single Branch specified by BANK_ID and BRANCH_ID including:

Name
Address
Geo Location
License the data under this endpoint is released under.

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.BankApi(obp_python.ApiClient(configuration))
branch_id = 'branch_id_example' # str | The branch id
bank_id = 'bank_id_example' # str | The bank id

try:
    # Get Branch
    api_response = api_instance.o_bpv3_0_0_get_branch(branch_id, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BankApi->o_bpv3_0_0_get_branch: %s\n" % e)

Parameters

Name	Type	Description	Notes
branch_id	str	The branch id
bank_id	str	The bank id

Return type

BranchJsonV300

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_branches

BranchesJsonV300 o_bpv3_0_0_get_branches(bank_id)

Get Branches for a Bank

Returns information about branches for a single bank specified by BANK_ID including:

Name
Address
Geo Location
License the data under this endpoint is released under
Structured opening hours
Accessible flag
Branch Type
More Info

Pagination:

By default, 50 records are returned.

You can use the url query parameters limit and offset for pagination
You can also use the follow url query parameters:

city - string, find Branches those in this city, optional
withinMetersOf - number, find Branches within given meters distance, optional
nearLatitude - number, a position of latitude value, cooperate with withMetersOf do query filter, optional
nearLongitude - number, a position of longitude value, cooperate with withMetersOf do query filter, optional

note: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value.

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

try:
    # Get Branches for a Bank
    api_response = api_instance.o_bpv3_0_0_get_branches(bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BankApi->o_bpv3_0_0_get_branches: %s\n" % e)

Parameters

Name	Type	Description	Notes
bank_id	str	The bank id

Return type

BranchesJsonV300

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_account_webhook

AccountWebhookJson o_bpv3_1_0_create_account_webhook(body, bank_id)

Create an Account Webhook

Webhooks are used to call external URLs when certain events happen.

Account Webhooks focus on events around accounts.

For instance, a webhook could be used to notify an external service if a balance changes on an account.

This functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange

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

try:
    # Create an Account Webhook
    api_response = api_instance.o_bpv3_1_0_create_account_webhook(body, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BankApi->o_bpv3_1_0_create_account_webhook: %s\n" % e)

Parameters

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

Return type

AccountWebhookJson

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_enable_disable_account_webhook

AccountWebhookJson o_bpv3_1_0_enable_disable_account_webhook(body, bank_id)

Enable/Disable an Account Webhook

Webhooks are used to call external URLs when certain events happen.

Account Webhooks focus on events around accounts.

For instance, a webhook could be used to notify an external service if a balance changes on an account.

This functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange

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

try:
    # Enable/Disable an Account Webhook
    api_response = api_instance.o_bpv3_1_0_enable_disable_account_webhook(body, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BankApi->o_bpv3_1_0_enable_disable_account_webhook: %s\n" % e)

Parameters

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

Return type

AccountWebhookJson

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_get_account_webhooks

AccountWebhooksJson o_bpv3_1_0_get_account_webhooks(bank_id)

Get Account Webhooks

Get Account Webhooks.

Possible custom URL parameters for pagination:

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

account_id=STRING (if null ignore)
user_id=STRING (if null ignore)

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

try:
    # Get Account Webhooks
    api_response = api_instance.o_bpv3_1_0_get_account_webhooks(bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BankApi->o_bpv3_1_0_get_account_webhooks: %s\n" % e)

Parameters

Name	Type	Description	Notes
bank_id	str	The bank id

Return type

AccountWebhooksJson

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_create_bank_account_notification_webhook

BankAccountNotificationWebhookJson o_bpv4_0_0_create_bank_account_notification_webhook(body, bank_id)

Create bank level Account Notification Webhook

Create a notification Webhook that will fire for all accounts on the specified Bank.

Webhooks are used to call external web services when certain events happen.

For instance, a webhook can be used to notify an external service if a transaction is created on an account.

When an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.

Inside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.

The webhook will POST the following structure to your service:

{
"event_name": "OnCreateTransaction",
"event_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"bank_id": "gh.29.uk",
"account_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"transaction_id": "7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"related_entities": [
{
"user_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"customer_ids": ["3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"]
}
]
}

Thus, your service should accept the above POST body structure.

In this way, your web service can be informed about an event on an account and act accordingly.

Further information about the account, transaction or related entities can then be retrieved using the standard REST APIs.

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

try:
    # Create bank level Account Notification Webhook
    api_response = api_instance.o_bpv4_0_0_create_bank_account_notification_webhook(body, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BankApi->o_bpv4_0_0_create_bank_account_notification_webhook: %s\n" % e)

Parameters

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

Return type

BankAccountNotificationWebhookJson

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_create_bank_attribute

BankAttributeResponseJsonV400 o_bpv4_0_0_create_bank_attribute(body, bank_id)

Create Bank Attribute

Typical product attributes might be:

ISIN (for International bonds)
VKN (for German bonds)
REDCODE (markit short code for credit derivative)
LOAN_ID (e.g. used for Anacredit reporting)

ISSUE_DATE (When the bond was issued in the market)
MATURITY_DATE (End of life time of a product)
TRADABLE

See FPML for more examples.

The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"

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

try:
    # Create Bank Attribute
    api_response = api_instance.o_bpv4_0_0_create_bank_attribute(body, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BankApi->o_bpv4_0_0_create_bank_attribute: %s\n" % e)

Parameters

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

Return type

BankAttributeResponseJsonV400

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_create_or_update_bank_attribute_definition

AttributeDefinitionResponseJsonV400 o_bpv4_0_0_create_or_update_bank_attribute_definition(body, bank_id)

Create or Update Bank Attribute Definition

The category field must be Bank

The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY

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

try:
    # Create or Update Bank Attribute Definition
    api_response = api_instance.o_bpv4_0_0_create_or_update_bank_attribute_definition(body, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BankApi->o_bpv4_0_0_create_or_update_bank_attribute_definition: %s\n" % e)

Parameters

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

Return type

AttributeDefinitionResponseJsonV400

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_create_settlement_account

SettlementAccountResponseJson o_bpv4_0_0_create_settlement_account(body, bank_id)

Create Settlement Account

Create a new settlement account at a bank.

The created settlement account id will be the concatenation of the payment system and the account currency.
For examples: SEPA_SETTLEMENT_ACCOUNT_EUR, CARD_SETTLEMENT_ACCOUNT_USD

By default, when you create a new bank, two settlements accounts are created automatically: OBP_DEFAULT_INCOMING_ACCOUNT_ID and OBP_DEFAULT_OUTGOING_ACCOUNT_ID
Those two accounts have EUR as default currency.

If you want to create default settlement account for a specific currency, you can fill the payment_system field with the DEFAULT value.

When a transaction is saved in OBP through the mapped connector, OBP-API look for the account to save the double-entry transaction.
If no OBP account can be found from the counterparty, the double-entry transaction will be saved on a bank settlement account.
- First, the mapped connector looks for a settlement account specific to the payment system and currency. E.g SEPA_SETTLEMENT_ACCOUNT_EUR.
- If we don't find any specific settlement account with the payment system, we look for a default settlement account for the counterparty currency. E.g DEFAULT_SETTLEMENT_ACCOUNT_EUR.
- Else, we select one of the two OBP default settlement accounts (OBP_DEFAULT_INCOMING_ACCOUNT_ID/OBP_DEFAULT_OUTGOING_ACCOUNT_ID) according to the transaction direction.

If the POST body USER_ID is specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.

If the POST body USER_ID is not specified, the account will be owned by the logged in User.

Note: The Amount MUST be zero.

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

try:
    # Create Settlement Account
    api_response = api_instance.o_bpv4_0_0_create_settlement_account(body, bank_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BankApi->o_bpv4_0_0_create_settlement_account: %s\n" % e)

Parameters

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

Return type

SettlementAccountResponseJson

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_create_system_account_notification_webhook

SystemAccountNotificationWebhookJson o_bpv4_0_0_create_system_account_notification_webhook(body)

Create system level Account Notification Webhook

Create a notification Webhook that will fire for all accounts on the system.