Open Bank Project
|
OBP v4.0.0 (301 APIs)
API Host: https://openlab.openbankproject.com
BankAccountsViewsCounterpartiesTransactionsGet API ConfigurationReturns information about:
Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by config
Get API Info (root)Returns information about:
Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by root
Get Adapter InfoGet basic information about the Adapter. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getAdapterInfo
Get Adapter Info for a bankGet basic information about the Adapter listening on behalf of this bank. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getAdapterInfoForBank
Get Connector Status (Loopback)This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable. Currently this is only implemented for Kafka based connectors. For Kafka based connectors, this endpoint writes a message to Kafka and reads it again. In the future, this endpoint may also return information about database connections etc. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getObpConnectorLoopback
Get JSON Web Key (JWK)Get the server's public JSON Web Key (JWK) set and certificate chain. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getServerJWK
Get JSON Web Key (JWK) URIsGet the OAuth2 server's public JSON Web Key (JWK) URIs. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getOAuth2ServerJWKsURIs
Get Mapper Database InfoGet basic information about the Mapper Database. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getMapperDatabaseInfo
Get Rate Limiting InfoGet information about the Rate Limiting setup on this OBP Instance such as: Is rate limiting enabled and active? Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getRateLimitingInfo
Get the Call Context of a current callGet the Call Context of the current call. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getCallContext
Create ATMCreate ATM for the Bank. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by createAtm
Get Bank ATMReturns information about ATM for a single bank specified by BANK_ID and ATM_ID including:
Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getAtm
Get Bank ATMSReturns information about ATMs for a single bank specified by BANK_ID including:
Pagination: By default, 100 records are returned. You can use the url query parameters limit and offset for pagination Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getAtms
Check Available FundsCheck Available Funds
Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by checkFundsAvailable
Create AccountCreate Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID. The User can create an Account for themself - or - the User that has the USER_ID specified in the POST body. If the PUT 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 PUT body USER_ID is not specified, the account will be owned by the logged in User. The 'product_code' field SHOULD be a product_code from Product. Note: The Amount MUST be zero. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by createAccount
Create Account (POST)Create Account at bank specified by BANK_ID. The User can create an Account for himself - or - the User that has the USER_ID specified in the POST body. 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. The 'product_code' field SHOULD be a product_code from Product. Note: The Amount MUST be zero. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by addAccount
Create Account AttributeCreate Account Attribute Account Attributes are used to describe a financial Product with a list of typed key value pairs. Each Account Attribute is linked to its Account by ACCOUNT_ID Typical account attributes might be: ISIN (for International bonds) ISSUE_DATE (When the bond was issued in the market) See FPML for more examples. The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by createAccountAttribute
Create or Update Account Attribute DefinitionCreate or Update Account Attribute Definition The category field must be Account The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by createOrUpdateAccountAttributeDefinition
Delete Account Attribute DefinitionDelete Account Attribute Definition by ATTRIBUTE_DEFINITION_ID Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteAccountAttributeDefinition
Delete Account CascadeDelete an Account Cascade specified by ACCOUNT_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteAccountCascade
Get Account Attribute DefinitionGet Account Attribute Definition Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getAccountAttributeDefinition
Get Account by Id (Core)Information returned about the account specified by ACCOUNT_ID:
This call returns the owner view and requires access to that view. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getCoreAccountById
Get Account by Id (Full)Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):
More details about the data moderation by the view here. PSD2 Context: PSD2 requires customers to have access to their account information via third party applications. Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv4.0.0 by getPrivateAccountByIdFull
Get Accounts BalancesGet the Balances for the Accounts of the current User at one bank. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getBankAccountsBalances
Get Accounts HeldGet 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:
whole url example: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getAccountsHeld
Get Accounts at BankReturns the list of accounts at BANK_ID that the user has access to. optional request parameters for filter with attributes Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getPrivateAccountsAtOneBank
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:
whole url example: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getPrivateAccountIdsbyBankId
Get Accounts at Bank (Minimal)Returns the minimal list of private accounts at BANK_ID that the user has access to. If you want to see more information on the Views, use the Account Detail call. optional request parameters:
whole url example: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by privateAccountsAtOneBank
Get Accounts at all Banks (private)Returns the list of accounts containing private views for the user. optional request parameters:
whole url example: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by corePrivateAccountsAllBanks
Get Firehose Accounts at BankGet Accounts which have a firehose view assigned to them. This endpoint allows bulk access to accounts. Requires the CanUseFirehoseAtAnyBank Role To be shown on the list, each Account must have a firehose View linked to it. A firehose view has is_firehose = true For VIEW_ID try 'owner' optional request parameters for filter with attributes to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.0.0 by getFirehoseAccountsAtOneBank
Update AccountUpdate the account. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by updateAccount
Update Account AttributeUpdate Account Attribute Account Attributes are used to describe a financial Product with a list of typed key value pairs. Each Account Attribute is linked to its Account by ACCOUNT_ID Typical account attributes might be: ISIN (for International bonds) ISSUE_DATE (When the bond was issued in the market) See FPML for more examples. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by updateAccountAttribute
Update Account LabelUpdate the label for the account. The label is how the account is known to the account owner e.g. 'My savings account' Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.2.1 by updateAccountLabel
Grant User access to ViewGrants the User identified by USER_ID access to the view identified by VIEW_ID. Authentication is Mandatory and the user needs to be account holder. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by grantUserAccessToView
Revoke User access to ViewRevoke the User identified by USER_ID access to the view identified by VIEW_ID. Authentication is Mandatory and the user needs to be account holder. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by revokeUserAccessToView
Create Account ApplicationCreate Account Application Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by createAccountApplication
Get Account Application by IdGet the Account Application. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by getAccountApplication
Get Account ApplicationsGet the Account Applications. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getAccountApplications
Update Account Application StatusUpdate an Account Application status Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by updateAccountApplicationStatus
Create a tag on accountPosts a tag about an account ACCOUNT_ID on a view VIEW_ID. Authentication is Mandatory Authentication is required as the tag is linked with the user. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by addTagForViewOnAccount
Delete a tag on accountDeletes the tag TAG_ID about the account ACCOUNT_ID made on view. Authentication is Mandatory Authentication is required as the tag is linked with the user. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteTagForViewOnAccount
Get tags on accountReturns the account ACCOUNT_ID tags made on a view (VIEW_ID). Authentication is required as the tag is linked with the user. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getTagsForViewOnAccount
Get Public Account by IdReturns information about an account that has a public view. The account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.
PSD2 Context: PSD2 requires customers to have access to their account information via third party applications. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getPublicAccountById
Get Public Accounts at BankReturns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv2.0.0 by publicAccountsAtOneBank
Get Public Accounts at all BanksGet public accounts at all banks (Anonymous access). Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv2.0.0 by publicAccountsAllBanks
Create 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 Settlement AccountCreate a new settlement account at a bank. The created settlement account id will be the concatenation of the payment system and the account currency. 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 If you want to create default settlement account for a specific currency, you can fill the When a transaction is saved in OBP through the mapped connector, OBP-API look for the account to save the double-entry transaction. 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 Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by createSettlementAccount
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 Settlement accounts at BankGet settlement accounts on this API instance Note: a settlement account is considered as a bank account. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by getSettlementAccounts
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
Create BranchCreate Branch for the Bank. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by createBranch
Delete BranchDelete Branch from given Bank. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by deleteBranch
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
Create CardCreate Card at bank specified by BANK_ID . Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by addCardForBank
Create Card AttributeCreate Card Attribute Card Attributes are used to describe a financial Product with a list of typed key value pairs. Each Card Attribute is linked to its Card by CARD_ID The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY" Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by createCardAttribute
Create or Update Card Attribute DefinitionCreate or Update Card Attribute Definition The category field must be Card The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by createOrUpdateCardAttributeDefinition
Delete CardDelete a Card at bank specified by CARD_ID . Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by deleteCardForBank
Delete Card Attribute DefinitionDelete Card Attribute Definition by ATTRIBUTE_DEFINITION_ID Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by deleteCardAttributeDefinition
Get Card Attribute DefinitionGet Card Attribute Definition Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getCardAttributeDefinition
Get Card By IdThis will the datails of the card. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by getCardForBank
Get Cards for the specified bankShould be able to filter on the following fields eg:/management/banks/BANK_ID/cards?customer_id=66214b8e-259e-44ad-8868-3eb47be70646$account_id=8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0 1 customer_id should be valid customer_id, otherwise, it will return an empty card list. 2 account_id should be valid account_id , otherwise, it will return an empty card list. ${authenticationRequiredMessage(true)} Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getCardsForBank
Get cards for the current userReturns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv1.3.0 by getCards
Update CardUpdate Card at bank specified by CARD_ID . Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv3.1.0 by updatedCardForBank
Update Card AttributeUpdate Card Attribute Card Attributes are used to describe a financial Product with a list of typed key value pairs. Each Card Attribute is linked to its Card by CARD_ID Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv3.1.0 by updateCardAttribute
Answer Consent ChallengeAn 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. Each Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk 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: 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 Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by answerConsentChallenge
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 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. 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. Each Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk 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: Authentication is Mandatory Example 1: Please note that consumer_id is optional field Please note if everything=false you need to explicitly specify views and entitlements Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by createConsentEmail
Create Consent (SMS)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 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. 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. Each Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk 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: Authentication is Mandatory Example 1: Please note that consumer_id is optional field Please note if everything=false you need to explicitly specify views and entitlements Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by createConsentSms
Get ConsentsAn 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. Each Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk 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: This endpoint gets the Consents that the current User created. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getConsents
Revoke ConsentAn 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. Each Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk 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: Revoke Consent for current user specified by CONSENT_ID Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by revokeConsent
Enable or Disable ConsumersEnable/Disable a Consumer specified by CONSUMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by enableDisableConsumers
Get Call Limits for a ConsumerGet Calls limits per Consumer. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getCallsLimit
Get ConsumerGet the Consumer specified by CONSUMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getConsumer
Get ConsumersGet the all Consumers. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getConsumers
Get Consumers (logged in User)Get the Consumers for logged in User. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by getConsumersForCurrentUser
Post a ConsumerCreate a Consumer (Authenticated access). Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by createConsumer
Set Calls Limit for a ConsumerSet the API call limits for a Consumer: Per Second Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv3.1.0 by callsLimit
Update Consumer RedirectUrlUpdate an existing redirectUrl for a Consumer specified by CONSUMER_ID. CONSUMER_ID can be obtained after you register the application. Or use the endpoint 'Get Consumers' to get it Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Connector Methods:
Implemented in OBPv2.1.0 by updateConsumerRedirectUrl
Create Counterparty (Explicit)Create Counterparty (Explicit) for an Account. In OBP, there are two types of Counterparty.
Explicit Counterparties are created for the account / view name : the human readable name (e.g. Piano teacher, Miss Nipa) description : the human readable name (e.g. Piano teacher, Miss Nipa) currency : counterparty account currency (e.g. EUR, GBP, USD, ...) bank_routing_scheme : eg: bankId or bankCode or any other strings bank_routing_address : eg: account_routing_scheme : eg: AccountId or AccountNumber or any other strings account_routing_address : eg: other_account_secondary_routing_scheme : eg: IBan or any other strings other_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty. other_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode. other_branch_routing_address : eg: is_beneficiary : must be set to bespoke: It supports a list of key-value, you can add it to the counterparty. bespoke.key : any info-key you want to add to this counterparty bespoke.value : any info-value you want to add to this counterparty The view specified by VIEW_ID must have the canAddCounterparty permission A minimal example for TransactionRequestType == COUNTERPARTY A minimal example for TransactionRequestType == SEPA { Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv4.0.0 by createCounterparty
Create Counterparty for any account (Explicit)Create Counterparty for any Account. (Explicit) In OBP, there are two types of Counterparty.
Explicit Counterparties are created for the account / view name : the human readable name (e.g. Piano teacher, Miss Nipa) description : the human readable name (e.g. Piano teacher, Miss Nipa) currency : counterparty account currency (e.g. EUR, GBP, USD, ...) bank_routing_scheme : eg: bankId or bankCode or any other strings bank_routing_address : eg: account_routing_scheme : eg: AccountId or AccountNumber or any other strings account_routing_address : eg: other_account_secondary_routing_scheme : eg: IBan or any other strings other_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty. other_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode. other_branch_routing_address : eg: is_beneficiary : must be set to bespoke: It supports a list of key-value, you can add it to the counterparty. bespoke.key : any info-key you want to add to this counterparty bespoke.value : any info-value you want to add to this counterparty The view specified by VIEW_ID must have the canAddCounterparty permission A minimal example for TransactionRequestType == COUNTERPARTY A minimal example for TransactionRequestType == SEPA { Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by createCounterpartyForAnyAccount
Get Counterparties (Explicit)Get the Counterparties (Explicit) for the account / view. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getExplictCounterpartiesForAccount
Get Counterparty by Counterparty Id (Explicit)Information returned about the Counterparty specified by COUNTERPARTY_ID: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv4.0.0 by getExplictCounterpartyById
Get Counterparty by name for any account (Explicit)Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv4.0.0 by getCounterpartyByNameForAnyAccount
Get Other Account by IdReturns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID. Authentication is required if the view is not public. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getOtherAccountByIdForBankAccount
Get Other Accounts of one AccountReturns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID. Authentication is required if the view VIEW_ID is not public. Typical Successful Response:
Headers:
Possible Errors:
Connector Methods:
Implemented in OBPv3.0.0 by getOtherAccountsForBankAccount
Add Corporate Location to CounterpartyAdd the geolocation of the counterparty's registered address Authentication is Mandatory |