Open Bank Project |
OBP v4.0.0 filtered by tag: Bank, Bank-Branch, Bank-ATM, Bank-Product, Bank-FX (11 APIs)
API Host: https://fincluye.openbankproject.com
BankAccountsViewsCounterpartiesTransactionsCreate BankCreate a new bank (Authenticated access). The user creating this will be automatically assigned the Role CanCreateEntitlementAtOneBank. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by createBank
Create Transaction Type at bankCreate Transaction Types for the bank specified by BANK_ID:
Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv2.1.0 by createTransactionType
Get BankGet the bank specified by BANK_ID
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by bankById
Get BanksGet banks on this API instance
Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getBanks
Get Transaction Types at BankGet 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).
Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv2.0.0 by getTransactionTypes
Get BranchReturns information about a single Branch specified by BANK_ID and BRANCH_ID including:
Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getBranch
Get Branches for a BankReturns information about branches for a single bank specified by BANK_ID including:
Pagination: By default, 50 records are returned. You can use the url query parameters limit and offset for pagination
note: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getBranches
Get Transaction Request Types at BankGet the list of the Transaction Request Types supported by the bank. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv2.1.0 by getTransactionRequestTypesSupportedByBank
Create an Account WebhookCreate 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 Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by createAccountWebhook
Enable/Disable an Account WebhookEnable/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 Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by enableDisableAccountWebhook
Get Account WebhooksGet Account Webhooks. Possible custom URL parameters for pagination: Possible custom headers for pagination:
eg1:?limit=100&offset=0
eg2:?limit=100&offset=0&sort_direction=ASC
Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getAccountWebhooks
|