API Explorer

Open Bank Project
Login

OBP v4.0.0 (304 APIs)

API Host: https://api.openbankproject.com

Bank

Accounts

Views

Counterparties

Transactions

Get API Configuration

Returns information about:

  • The default bank_id
  • Akka configuration
  • Elastic Search configuration
  • Cached functions

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "akka":{
    "ports":[{
      "property":"default",
      "value":"8080"
    }],
    "log_level":"Debug",
    "remote_data_secret_matched":true
  },
  "elastic_search":{
    "metrics":[{
      "property":"String",
      "value":"Mapper"
    }],
    "warehouse":[{
      "property":"String",
      "value":"ElasticSearch"
    }]
  },
  "cache":[{
    "function_name":"getBanks",
    "ttl_in_seconds":5
  }],
  "scopes":{
    "require_scopes_for_all_roles":true,
    "require_scopes_for_listed_roles":["CanCreateUserAuthContextUpdate"]
  }
}
Headers:
Required Roles:
  • CanGetConfig - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by config

Get API Info (root)

Returns information about:

  • API version
  • Hosted by information
  • Hosted at information
  • Energy source information
  • Git Commit

Authentication is Optional

Typical Successful Response:

								
									
{
  "version":"String",
  "version_status":"String",
  "git_commit":"String",
  "connector":"String",
  "hosted_by":{
    "organisation":"String",
    "email":"String",
    "phone":"String",
    "organisation_website":"String"
  },
  "hosted_at":{
    "organisation":"Amazon",
    "organisation_website":"https://aws.amazon.com/"
  },
  "energy_source":{
    "organisation":"Stromio",
    "organisation_website":"https://www.stromio.de/"
  }
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
  • no connector set
Connector Methods:
Implemented in OBPv4.0.0 by root

Get Adapter Info

Get basic information about the Adapter.

Authentication is Optional

Typical Successful Response:

								
									
{
  "name":"String",
  "version":"String",
  "git_commit":"String",
  "date":"2013-01-21T23:08:00Z"
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getAdapterInfo

Get Adapter Info for a bank

Get basic information about the Adapter listening on behalf of this bank.

Authentication is Optional

Typical Successful Response:

								
									
{
  "name":"String",
  "version":"String",
  "git_commit":"String",
  "date":"2013-01-21T23:08:00Z"
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
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:

								
									
{
  "connector_version":"kafka_vSept2018",
  "git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0",
  "duration_time":"10 ms"
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
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.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.

Authentication is Optional

Typical Successful Response:

								
									
{
  "kty":"RSA",
  "e":"AQAB",
  "use":"sig",
  "kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s",
  "n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ"
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getServerJWK

Get JSON Web Key (JWK) URIs

Get the OAuth2 server's public JSON Web Key (JWK) URIs.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.

Authentication is Optional

Typical Successful Response:

								
									
{
  "jwks_uris":[{
    "jwks_uri":"https://www.googleapis.com/oauth2/v3/certs"
  }]
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getOAuth2ServerJWKsURIs

Get Mapper Database Info

Get basic information about the Mapper Database.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "name":"String",
  "version":"String",
  "git_commit":"String",
  "date":"2013-01-21T23:08:00Z"
}
Headers:
Required Roles:
  • CanGetDatabaseInfo - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv4.0.0 by getMapperDatabaseInfo

Get Rate Limiting Info

Get information about the Rate Limiting setup on this OBP Instance such as:

Is rate limiting enabled and active?
What backend is used to keep track of the API calls (e.g. REDIS).

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "enabled":true,
  "technology":"REDIS",
  "service_available":true,
  "is_active":true
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Implemented in OBPv3.1.0 by getRateLimitingInfo

Get the Call Context of a current call

Get the Call Context of the current call.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Required Roles:
  • CanGetCallContext - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv4.0.0 by getCallContext

Create ATM

Create ATM for the Bank.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "id":"atm-id-123",
  "bank_id":"gh.29.uk",
  "name":"Atm by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":11.45,
    "longitude":11.45
  },
  "meta":{
    "license":{
      "id":"5",
      "name":"TESOBE"
    }
  },
  "monday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "tuesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "wednesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "thursday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "friday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "saturday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "sunday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "is_accessible":"true",
  "located_at":"Full service store",
  "more_info":"short walk to the lake from here",
  "has_deposit_capability":"true"
}
Headers:
Required Roles:
  • CanCreateAtm - Please login to request this Role
  • CanCreateAtmAtAnyBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by createAtm

Get Bank ATM

Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:

  • Address
  • Geo Location
  • License the data under this endpoint is released under

Authentication is Optional

Typical Successful Response:

								
									
{
  "id":"atm-id-123",
  "bank_id":"gh.29.uk",
  "name":"Atm by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":11.45,
    "longitude":11.45
  },
  "meta":{
    "license":{
      "id":"5",
      "name":"TESOBE"
    }
  },
  "monday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "tuesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "wednesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "thursday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "friday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "saturday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "sunday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "is_accessible":"true",
  "located_at":"Full service store",
  "more_info":"short walk to the lake from here",
  "has_deposit_capability":"true"
}
Headers:
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30009: ATM not found. Please specify a valid value for ATM_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by getAtm

Get Bank ATMS

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

  • Address
  • Geo Location
  • License the data under this endpoint is released under

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:

								
									
{
  "id":"atm-id-123",
  "bank_id":"gh.29.uk",
  "name":"Atm by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":11.45,
    "longitude":11.45
  },
  "meta":{
    "license":{
      "id":"5",
      "name":"TESOBE"
    }
  },
  "monday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "tuesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "wednesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "thursday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "friday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "saturday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "sunday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "is_accessible":"true",
  "located_at":"Full service store",
  "more_info":"short walk to the lake from here",
  "has_deposit_capability":"true"
}
Headers:
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • No ATMs available. License may not be set.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by getAtms

Check Available Funds

Check Available Funds
Mandatory URL parameters:

  • amount=NUMBER
  • currency=STRING

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "answer":"yes",
  "date":"2021-08-16T00:37:28Z",
  "available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20054: Invalid amount. Please specify a valid value for amount.
  • OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by checkFundsAvailable

Create Account

Create 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.
If the 'product_code' matches a product_code from Product, account attributes will be created that match the Product Attributes.

Note: The Amount MUST be zero.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "label":"My Account",
  "product_code":"AC",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "branch_id":"DERBY6",
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_attributes":[{
    "product_code":"saving1",
    "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
    "name":"OVERDRAFT_START_DATE",
    "type":"DATE_WITH_DAY",
    "value":"2012-04-23"
  }]
}
Headers:
Required Roles:
  • CanCreateAccount - Please login to request this Role
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30107: Invalid User Id.
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30106: Invalid Balance Amount.
  • OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00
  • OBP-30109: Initial Balance of Account must be Zero (0).
  • OBP-30105: Invalid Balance Currency.
  • OBP-30208: Account_ID already exists at the Bank.
  • OBP-50000: Unknown Error.
Connector Methods:
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.
If the product_code matches a product_code from Product, account attributes will be created that match the Product Attributes.

Note: The Amount MUST be zero.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "label":"My Account",
  "product_code":"AC",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "branch_id":"DERBY6",
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_attributes":[{
    "product_code":"saving1",
    "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
    "name":"OVERDRAFT_START_DATE",
    "type":"DATE_WITH_DAY",
    "value":"2012-04-23"
  }]
}
Headers:
Required Roles:
  • CanCreateAccount - Please login to request this Role
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-30106: Invalid Balance Amount.
  • OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00
  • OBP-30109: Initial Balance of Account must be Zero (0).
  • OBP-30105: Invalid Balance Currency.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by addAccount

Create Account Attribute

Create 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)
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

Typical Successful Response:

								
									
{
  "product_code":"saving1",
  "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "name":"OVERDRAFT_START_DATE",
  "type":"DATE_WITH_DAY",
  "value":"2012-04-23"
}
Headers:
Required Roles:
  • CanCreateAccountAttributeAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv3.1.0 by createAccountAttribute

Create or Update Account Attribute Definition

Create 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:

								
									
{
  "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "bank_id":"gh.29.uk",
  "name":"SPECIAL_TAX_NUMBER",
  "category":"Account",
  "type":"STRING",
  "description":"description",
  "alias":"STRING",
  "can_be_seen_on_views":["bank"],
  "is_active":true
}
Headers:
Required Roles:
  • CanCreateAccountAttributeDefinitionAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv4.0.0 by createOrUpdateAccountAttributeDefinition

Delete Account Attribute Definition

Delete Account Attribute Definition by ATTRIBUTE_DEFINITION_ID

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Required Roles:
  • CanDeleteAccountAttributeDefinitionAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv4.0.0 by deleteAccountAttributeDefinition

Delete Account Cascade

Delete an Account Cascade specified by ACCOUNT_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Required Roles:
  • CanDeleteAccountCascade - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by deleteAccountCascade

Get Account Attribute Definition

Get Account Attribute Definition

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "attributes":[{
    "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "bank_id":"gh.29.uk",
    "name":"SPECIAL_TAX_NUMBER",
    "category":"Account",
    "type":"STRING",
    "description":"description",
    "alias":"STRING",
    "can_be_seen_on_views":["bank"],
    "is_active":true
  }]
}
Headers:
Required Roles:
  • CanGetAccountAttributeDefinitionAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv4.0.0 by getAccountAttributeDefinition

Get Account by Id (Core)

Information returned about the account specified by ACCOUNT_ID:

  • Number - The human readable account number given by the bank that identifies the account.
  • Label - A label given by the owner of the account
  • Owners - Users that own this account
  • Type - The type of account
  • Balance - Currency and Value
  • Account Routings - A list that might include IBAN or national account identifiers
  • Account Rules - A list that might include Overdraft and other bank specific rules
  • Account Attributes - A list that might include custom defined account attribute
  • Tags - A list of Tags assigned to this account

This call returns the owner view and requires access to that view.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "bank_id":"gh.29.uk",
  "label":"My Account",
  "number":"546387432",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }],
  "product_code":"AC",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "views_basic":[{
    "id":"owner",
    "short_name":"Owner",
    "description":"This view is for the owner for the account.",
    "is_public":false
  }],
  "account_attributes":[{
    "product_code":"saving1",
    "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
    "name":"OVERDRAFT_START_DATE",
    "type":"DATE_WITH_DAY",
    "value":"2012-04-23"
  }],
  "tags":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "value":"OBP",
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
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):

  • Number
  • Owners
  • Type
  • Balance
  • IBAN
  • Available views (sorted by short_name)

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.
This call provides balance and other account information via delegated authentication using OAuth.

Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to true.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "label":"NoneLabel",
  "number":"123",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }],
  "product_code":"OBP",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "views_available":[{
    "id":"123",
    "short_name":"short_name",
    "description":"description",
    "is_public":true,
    "alias":"None",
    "hide_metadata_if_alias_used":true,
    "can_add_comment":true,
    "can_add_corporate_location":true,
    "can_add_image":true,
    "can_add_image_url":true,
    "can_add_more_info":true,
    "can_add_open_corporates_url":true,
    "can_add_physical_location":true,
    "can_add_private_alias":true,
    "can_add_public_alias":true,
    "can_add_tag":true,
    "can_add_url":true,
    "can_add_where_tag":true,
    "can_delete_comment":true,
    "can_delete_corporate_location":true,
    "can_delete_image":true,
    "can_delete_physical_location":true,
    "can_delete_tag":true,
    "can_delete_where_tag":true,
    "can_edit_owner_comment":true,
    "can_see_bank_account_balance":true,
    "can_see_bank_account_bank_name":true,
    "can_see_bank_account_currency":true,
    "can_see_bank_account_iban":true,
    "can_see_bank_account_label":true,
    "can_see_bank_account_national_identifier":true,
    "can_see_bank_account_number":true,
    "can_see_bank_account_owners":true,
    "can_see_bank_account_swift_bic":true,
    "can_see_bank_account_type":true,
    "can_see_comments":true,
    "can_see_corporate_location":true,
    "can_see_image_url":true,
    "can_see_images":true,
    "can_see_more_info":true,
    "can_see_open_corporates_url":true,
    "can_see_other_account_bank_name":true,
    "can_see_other_account_iban":true,
    "can_see_other_account_kind":true,
    "can_see_other_account_metadata":true,
    "can_see_other_account_national_identifier":true,
    "can_see_other_account_number":true,
    "can_see_other_account_swift_bic":true,
    "can_see_owner_comment":true,
    "can_see_physical_location":true,
    "can_see_private_alias":true,
    "can_see_public_alias":true,
    "can_see_tags":true,
    "can_see_transaction_amount":true,
    "can_see_transaction_balance":true,
    "can_see_transaction_currency":true,
    "can_see_transaction_description":true,
    "can_see_transaction_finish_date":true,
    "can_see_transaction_metadata":true,
    "can_see_transaction_other_bank_account":true,
    "can_see_transaction_start_date":true,
    "can_see_transaction_this_bank_account":true,
    "can_see_transaction_type":true,
    "can_see_url":true,
    "can_see_where_tag":true
  }],
  "bank_id":"gh.29.uk",
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_attributes":[{
    "product_code":"saving1",
    "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
    "name":"OVERDRAFT_START_DATE",
    "type":"DATE_WITH_DAY",
    "value":"2012-04-23"
  }],
  "tags":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "value":"OBP",
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getPrivateAccountByIdFull

Get Accounts Balances

Get the Balances for the Accounts of the current User at one bank.

Authentication is Optional

Typical Successful Response:

								
									
{
  "accounts":[{
    "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "label":"My Account",
    "bank_id":"gh.29.uk",
    "account_routings":[{
      "scheme":"accountNumber",
      "address":"123456"
    }],
    "balance":{
      "currency":"EUR",
      "amount":"100"
    }
  }],
  "overall_balance":{
    "currency":"EUR",
    "amount":"100"
  },
  "overall_balance_date":"2017-09-19T00:00:00Z"
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getBankAccountsBalances

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

Typical Successful Response:

								
									
{
  "accounts":[{
    "id":"12314",
    "bank_id":"123",
    "number":"123",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }]
  }]
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Implemented in OBPv3.0.0 by getAccountsHeld

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

Typical Successful Response:

								
									
{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
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:

  • 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

Typical Successful Response:

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf"
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
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.
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

Typical Successful Response:

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"String",
    "bank_id":"gh.29.uk",
    "account_type":"330",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "views":[{
      "id":"owner",
      "short_name":"Owner",
      "description":"This view is for the owner for the account.",
      "is_public":false
    }]
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
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.
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

Typical Successful Response:

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"String",
    "bank_id":"gh.29.uk",
    "account_type":"330",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "views":[{
      "id":"owner",
      "short_name":"Owner",
      "description":"This view is for the owner for the account.",
      "is_public":false
    }]
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by corePrivateAccountsAllBanks

Get Checkbook orders

 
  Get all checkbook orders

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "account":{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "account_type":"330",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "branch_routings":[{
      "scheme":"BranchNumber",
      "address":"678"
    }]
  },
  "orders":[{
    "order":{
      "order_id":"xjksajfkj",
      "order_date":"07082013",
      "number_of_checkbooks":"4",
      "distribution_channel":"1201",
      "status":"2",
      "first_check_number":"5165276",
      "shipping_code":"1"
    }
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50211: Connector did not return the set of check book.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getCheckbookOrders

Get Firehose Accounts at Bank

Get 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
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?manager=John&count=8

to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be _timestamp_
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?manager=John&count=8&_timestamp_=1596762180358

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "bank_id":"String",
    "label":"String",
    "number":"String",
    "owners":[{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }],
    "type":"String",
    "balance":{
      "currency":"EUR",
      "amount":"0"
    },
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "account_rules":[{
      "scheme":"OVERDRAFT",
      "value":"10"
    }]
  }]
}
Headers:
Required Roles:
  • CanUseAccountFirehoseAtAnyBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv3.0.0 by getFirehoseAccountsAtOneBank

Update Account

Update the account.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "label":"Label",
  "type":"CURRENT",
  "branch_id":"1234",
  "account_routings":[{
    "scheme":"IBAN",
    "address":"DE91 1000 0000 0123 4567 89"
  }]
}
Headers:
Required Roles:
  • CanUpdateAccount - Please login to request this Role
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv3.1.0 by updateAccount

Update Account Attribute

Update 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)
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.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "product_code":"saving1",
  "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "name":"OVERDRAFT_START_DATE",
  "type":"DATE_WITH_DAY",
  "value":"2012-04-23"
}
Headers:
Required Roles:
  • CanUpdateAccountAttribute - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv3.1.0 by updateAccountAttribute

Update Account Label

Update 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:

								
									
{
  "success":"Success"
}
Headers:
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • user does not have access to owner view on account
Connector Methods:
Implemented in OBPv1.2.1 by updateAccountLabel

Grant User access to View

Grants 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:

								
									
{
  "id":"1234",
  "short_name":"short_name",
  "description":"description",
  "metadata_view":"owner",
  "is_public":true,
  "is_system":true,
  "alias":"No",
  "hide_metadata_if_alias_used":true,
  "can_add_comment":true,
  "can_add_corporate_location":true,
  "can_add_image":true,
  "can_add_image_url":true,
  "can_add_more_info":true,
  "can_add_open_corporates_url":true,
  "can_add_physical_location":true,
  "can_add_private_alias":true,
  "can_add_public_alias":true,
  "can_add_tag":true,
  "can_add_url":true,
  "can_add_where_tag":true,
  "can_delete_comment":true,
  "can_add_counterparty":true,
  "can_delete_corporate_location":true,
  "can_delete_image":true,
  "can_delete_physical_location":true,
  "can_delete_tag":true,
  "can_delete_where_tag":true,
  "can_edit_owner_comment":true,
  "can_see_bank_account_balance":true,
  "can_query_available_funds":true,
  "can_see_bank_account_bank_name":true,
  "can_see_bank_account_currency":true,
  "can_see_bank_account_iban":true,
  "can_see_bank_account_label":true,
  "can_see_bank_account_national_identifier":true,
  "can_see_bank_account_number":true,
  "can_see_bank_account_owners":true,
  "can_see_bank_account_swift_bic":true,
  "can_see_bank_account_type":true,
  "can_see_comments":true,
  "can_see_corporate_location":true,
  "can_see_image_url":true,
  "can_see_images":true,
  "can_see_more_info":true,
  "can_see_open_corporates_url":true,
  "can_see_other_account_bank_name":true,
  "can_see_other_account_iban":true,
  "can_see_other_account_kind":true,
  "can_see_other_account_metadata":true,
  "can_see_other_account_national_identifier":true,
  "can_see_other_account_number":true,
  "can_see_other_account_swift_bic":true,
  "can_see_owner_comment":true,
  "can_see_physical_location":true,
  "can_see_private_alias":true,
  "can_see_public_alias":true,
  "can_see_tags":true,
  "can_see_transaction_amount":true,
  "can_see_transaction_balance":true,
  "can_see_transaction_currency":true,
  "can_see_transaction_description":true,
  "can_see_transaction_finish_date":true,
  "can_see_transaction_metadata":true,
  "can_see_transaction_other_bank_account":true,
  "can_see_transaction_start_date":true,
  "can_see_transaction_this_bank_account":true,
  "can_see_transaction_type":true,
  "can_see_url":true,
  "can_see_where_tag":true,
  "can_see_bank_routing_scheme":true,
  "can_see_bank_routing_address":true,
  "can_see_bank_account_routing_scheme":true,
  "can_see_bank_account_routing_address":true,
  "can_see_other_bank_routing_scheme":true,
  "can_see_other_bank_routing_address":true,
  "can_see_other_account_routing_scheme":true,
  "can_see_other_account_routing_address":true,
  "can_add_transaction_request_to_own_account":true,
  "can_add_transaction_request_to_any_account":true,
  "can_see_bank_account_credit_limit":true,
  "can_create_direct_debit":true,
  "can_create_standing_order":true
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20047: User must have access to the owner view or must be an account holder.
  • OBP-10001: Incorrect json format.
  • OBP-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-30252: System view not found. Please specify a valid value for VIEW_ID
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30063: Cannot grant account access.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by grantUserAccessToView

Revoke User access to View

Revoke 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:

								
									
{
  "revoked":true
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20047: User must have access to the owner view or must be an account holder.
  • OBP-10001: Incorrect json format.
  • OBP-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-30252: System view not found. Please specify a valid value for VIEW_ID
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30064: Cannot revoke account access.
  • OBP-30065: Cannot find account access.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by revokeUserAccessToView

Create Account Application

Create Account Application

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}
Headers:
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Implemented in OBPv3.1.0 by createAccountApplication

Get Account Application by Id

Get the Account Application.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getAccountApplication

Get Account Applications

Get the Account Applications.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "account_applications":[{
    "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
    "product_code":"saveing1",
    "user":{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"felixsmith@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith"
    },
    "customer":{
      "bank_id":"gh.29.uk",
      "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customer_number":"5987953",
      "legal_name":"Eveline Tripman",
      "mobile_phone_number":"+44 07972 444 876",
      "email":"felixsmith@example.com",
      "face_image":{
        "url":"www.openbankproject",
        "date":"2017-09-19T00:00:00Z"
      },
      "date_of_birth":"2017-09-19T00:00:00Z",
      "relationship_status":"single",
      "dependants":1,
      "dob_of_dependants":["2017-09-19T00:00:00Z"],
      "credit_rating":{
        "rating":"OBP",
        "source":"OBP"
      },
      "credit_limit":{
        "currency":"EUR",
        "amount":"0"
      },
      "highest_education_attained":"Master",
      "employment_status":"worker",
      "kyc_status":true,
      "last_ok_date":"2017-09-19T00:00:00Z",
      "title":"Dr.",
      "branch_id":"DERBY6",
      "name_suffix":"Sr"
    },
    "date_of_application":"2017-09-19T00:00:00Z",
    "status":"REQUESTED"
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getAccountApplications

Update Account Application Status

Update an Account Application status

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by updateAccountApplicationStatus

Create a tag on account

Posts 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:

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "value":"OBP",
  "date":"2017-09-19T00:00:00Z",
  "user":{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-30022: The current view does not have the permission:
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by addTagForViewOnAccount

Delete a tag on account

Deletes 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:

								
									
{
  "jsonString":"{}"
}
Headers:
Possible Errors:
  • OBP-30022: The current view does not have the permission:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by deleteTagForViewOnAccount

Get tags on account

Returns the account ACCOUNT_ID tags made on a view (VIEW_ID).
Authentication is Mandatory

Authentication is required as the tag is linked with the user.

Typical Successful Response:

								
									
{
  "tags":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "value":"OBP",
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-30022: The current view does not have the permission:
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getTagsForViewOnAccount

Get Public Account by Id

Returns 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.

  • Number
  • Owners
  • Type
  • Balance
  • Routing

PSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
This call provides balance and other account information via delegated authentication using OAuth.

Authentication is Optional

Typical Successful Response:

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "bank_id":"String",
  "label":"String",
  "number":"String",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }],
  "type":"String",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_rules":[{
    "scheme":"OVERDRAFT",
    "value":"10"
  }]
}
Headers:
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by getPublicAccountById

Get Public Accounts at Bank

Returns 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:

								
									
{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv2.0.0 by publicAccountsAtOneBank

Get Public Accounts at all Banks

Get public accounts at all banks (Anonymous access).
Returns accounts that contain at least one public view (a view where is_public is true)
For each account the API returns the ID and the available views.

Authentication is Optional

Typical Successful Response:

								
									
{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}
Headers:
Possible Errors:
  • OBP-30066: Could not get accounts.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv2.0.0 by publicAccountsAllBanks

Create Bank

Create a new bank (Authenticated access).

The user creating this will be automatically assigned the Role CanCreateEntitlementAtOneBank.
Thus the User can manage the bank they create and assign Roles to other Users.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "id":"gh.29.uk.x",
  "full_name":"uk",
  "short_name":"uk",
  "logo_url":"https://static.openbankproject.com/images/sandbox/bank_x.png",
  "website_url":"https://www.example.com",
  "swift_bic":"IIIGGB22",
  "national_identifier":"UK97ZZZ1234567890",
  "bank_routing":{
    "scheme":"BIC",
    "address":"OKOYFIHH"
  }
}
Headers:
Required Roles:
  • CanCreateBank - Please login to request this Role
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30210: Insufficient authorisation to Create Bank. You do not have the role CanCreateBank.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv4.0.0 by createBank

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

Typical Successful Response:

								
									
{
  "id":{
    "value":"123"
  },
  "bankId":{
    "value":"gh.uk.9j"
  },
  "shortCode":"80080",
  "summary":"SANDBOX_TAN",
  "description":"This is the sandbox mode, charging litter money.",
  "charge":{
    "currency":"EUR",
    "amount":"100"
  }
}
Headers:
Required Roles:
  • CanCreateTransactionType - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-40005: Insufficient authorisation to Create Transaction Type offered by the bank. The Request could not be created because you don't have access to CanCreateTransactionType.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv2.1.0 by createTransactionType

Get Bank

Get the bank specified by BANK_ID
Returns information about a single bank specified by BANK_ID including:

  • Short and full name of bank
  • Logo URL
  • Website

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "id":"gh.29.uk",
  "short_name":"short_name ",
  "full_name":"full_name",
  "logo":"logo",
  "website":"www.openbankproject.com",
  "bank_routing":{
    "scheme":"Bank_ID",
    "address":"gh.29.uk"
  }
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
Connector Methods:
Implemented in OBPv3.0.0 by bankById

Get Banks

Get banks on this API instance
Returns a list of banks supported on this server:

  • ID used as parameter in URLs
  • Short and full name of bank
  • Logo URL
  • Website

Authentication is Optional

Typical Successful Response:

								
									
{
  "banks":[{
    "id":"gh.29.uk",
    "short_name":"short_name ",
    "full_name":"full_name",
    "logo":"logo",
    "website":"www.openbankproject.com",
    "bank_routing":{
      "scheme":"Bank_ID",
      "address":"gh.29.uk"
    }
  }]
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by getBanks

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

Typical Successful Response:

								
									
{
  "transaction_types":[{
    "id":{
      "value":"123"
    },
    "bank_id":"gh.29.uk",
    "short_code":"PlaceholderString",
    "summary":"PlaceholderString",
    "description":"PlaceholderString",
    "charge":{
      "currency":"EUR",
      "amount":"0"
    }
  }]
}
Headers:
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv2.0.0 by getTransactionTypes

Create Branch

Create Branch for the Bank.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "id":"branch-id-123",
  "bank_id":"bank-id-123",
  "name":"Branch by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"String",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":10.0,
    "longitude":10.0
  },
  "meta":{
    "license":{
      "id":"PDDL",
      "name":"Open Data Commons Public Domain Dedication and License "
    }
  },
  "lobby":{
    "monday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "tuesday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "wednesday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "thursday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "friday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "saturday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "sunday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }]
  },
  "drive_up":{
    "monday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "tuesday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "wednesday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "thursday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "friday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "saturday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "sunday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }
  },
  "branch_routing":{
    "scheme":"OBP",
    "address":"123abc"
  },
  "is_accessible":"true",
  "accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
  "branch_type":"Full service store",
  "more_info":"short walk to the lake from here",
  "phone_number":"+381631954907"
}
Headers:
Required Roles:
  • CanCreateBranch - Please login to request this Role
  • CanCreateBranchAtAnyBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv3.0.0 by createBranch

Delete Branch

Delete Branch from given Bank.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Required Roles:
  • CanDeleteBranch - Please login to request this Role
  • CanDeleteBranchAtAnyBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30218: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv3.1.0 by deleteBranch

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

Typical Successful Response:

								
									
{
  "id":"branch-id-123",
  "bank_id":"bank-id-123",
  "name":"Branch by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"String",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":10.0,
    "longitude":10.0
  },
  "meta":{
    "license":{
      "id":"PDDL",
      "name":"Open Data Commons Public Domain Dedication and License "
    }
  },
  "lobby":{
    "monday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "tuesday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "wednesday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "thursday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "friday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "saturday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "sunday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }]
  },
  "drive_up":{
    "monday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "tuesday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "wednesday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "thursday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "friday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "saturday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "sunday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }
  },
  "branch_routing":{
    "scheme":"OBP",
    "address":"123abc"
  },
  "is_accessible":"true",
  "accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
  "branch_type":"Full service store",
  "more_info":"short walk to the lake from here",
  "phone_number":"+381631954907"
}
Headers:
Possible Errors:
  • OBP-300010: Branch not found. Please specify a valid value for BRANCH_ID. Or License may not be set. meta.license.id and meta.license.name can not be empty
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by getBranch

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

Typical Successful Response:

								
									
{
  "branches":[{
    "id":"branch-id-123",
    "bank_id":"bank-id-123",
    "name":"Branch by the Lake",
    "address":{
      "line_1":"No 1 the Road",
      "line_2":"The Place",
      "line_3":"The Hill",
      "city":"Berlin",
      "county":"String",
      "state":"Brandenburg",
      "postcode":"13359",
      "country_code":"DE"
    },
    "location":{
      "latitude":10.0,
      "longitude":10.0
    },
    "meta":{
      "license":{
        "id":"PDDL",
        "name":"Open Data Commons Public Domain Dedication and License "
      }
    },
    "lobby":{
      "monday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }],
      "tuesday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }],
      "wednesday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }],
      "thursday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }],
      "friday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }],
      "saturday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }],
      "sunday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }]
    },
    "drive_up":{
      "monday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      },
      "tuesday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      },
      "wednesday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      },
      "thursday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      },
      "friday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      },
      "saturday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      },
      "sunday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }
    },
    "branch_routing":{
      "scheme":"OBP",
      "address":"123abc"
    },
    "is_accessible":"true",
    "accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
    "branch_type":"Full service store",
    "more_info":"short walk to the lake from here",
    "phone_number":"+381631954907"
  }]
}
Headers:
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-32001: No branches available. License may not be set.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by getBranches

Create Card

Create Card at bank specified by BANK_ID .

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "bank_id":"gh.29.uk",
  "card_number":"364435172576215",
  "card_type":"Credit",
  "name_on_card":"SusanSmith",
  "issue_number":"1",
  "serial_number":"1324234",
  "valid_from_date":"2017-09-19T00:00:00Z",
  "expires_date":"2017-09-19T00:00:00Z",
  "enabled":true,
  "cancelled":true,
  "on_hot_list":true,
  "technology":"technologyString1",
  "networks":["networks1"],
  "allows":["credit","debit"],
  "account":{
    "id":"123",
    "label":"OBP",
    "views_available":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":true,
      "alias":"None",
      "hide_metadata_if_alias_used":true,
      "can_add_comment":true,
      "can_add_corporate_location":true,
      "can_add_image":true,
      "can_add_image_url":true,
      "can_add_more_info":true,
      "can_add_open_corporates_url":true,
      "can_add_physical_location":true,
      "can_add_private_alias":true,
      "can_add_public_alias":true,
      "can_add_tag":true,
      "can_add_url":true,
      "can_add_where_tag":true,
      "can_delete_comment":true,
      "can_delete_corporate_location":true,
      "can_delete_image":true,
      "can_delete_physical_location":true,
      "can_delete_tag":true,
      "can_delete_where_tag":true,
      "can_edit_owner_comment":true,
      "can_see_bank_account_balance":true,
      "can_see_bank_account_bank_name":true,
      "can_see_bank_account_currency":true,
      "can_see_bank_account_iban":true,
      "can_see_bank_account_label":true,
      "can_see_bank_account_national_identifier":true,
      "can_see_bank_account_number":true,
      "can_see_bank_account_owners":true,
      "can_see_bank_account_swift_bic":true,
      "can_see_bank_account_type":true,
      "can_see_comments":true,
      "can_see_corporate_location":true,
      "can_see_image_url":true,
      "can_see_images":true,
      "can_see_more_info":true,
      "can_see_open_corporates_url":true,
      "can_see_other_account_bank_name":true,
      "can_see_other_account_iban":true,
      "can_see_other_account_kind":true,
      "can_see_other_account_metadata":true,
      "can_see_other_account_national_identifier":true,
      "can_see_other_account_number":true,
      "can_see_other_account_swift_bic":true,
      "can_see_owner_comment":true,
      "can_see_physical_location":true,
      "can_see_private_alias":true,
      "can_see_public_alias":true,
      "can_see_tags":true,
      "can_see_transaction_amount":true,
      "can_see_transaction_balance":true,
      "can_see_transaction_currency":true,
      "can_see_transaction_description":true,
      "can_see_transaction_finish_date":true,
      "can_see_transaction_metadata":true,
      "can_see_transaction_other_bank_account":true,
      "can_see_transaction_start_date":true,
      "can_see_transaction_this_bank_account":true,
      "can_see_transaction_type":true,
      "can_see_url":true,
      "can_see_where_tag":true
    }],
    "bank_id":"gh.29.uk"
  },
  "replacement":{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"RENEW"
  },
  "pin_reset":[{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"FORGOT"
  }],
  "collected":"2017-09-19T00:00:00Z",
  "posted":"2017-09-19T00:00:00Z",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
Headers:
Required Roles:
  • CanCreateCardsForBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10015: Allowed values are:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by addCardForBank

Create Card Attribute

Create 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:

								
									
{
  "name":"OVERDRAFT_START_DATE",
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "attribute_type":"DOUBLE",
  "bank_id":{
    "value":"gh.29.uk"
  },
  "value":"2012-04-23",
  "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by createCardAttribute

Create or Update Card Attribute Definition

Create 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:

								
									
{
  "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "bank_id":"gh.29.uk",
  "name":"SPECIAL_TAX_NUMBER",
  "category":"Card",
  "type":"STRING",
  "description":"description",
  "alias":"STRING",
  "can_be_seen_on_views":["bank"],
  "is_active":true
}
Headers:
Required Roles:
  • CanCreateCardAttributeDefinitionAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv4.0.0 by createOrUpdateCardAttributeDefinition

Delete Card

Delete a Card at bank specified by CARD_ID .

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Required Roles:
  • CanCreateCardsForBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10015: Allowed values are:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by deleteCardForBank

Delete Card Attribute Definition

Delete Card Attribute Definition by ATTRIBUTE_DEFINITION_ID

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Required Roles:
  • CanDeleteCardAttributeDefinitionAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv4.0.0 by deleteCardAttributeDefinition

Get Card Attribute Definition

Get Card Attribute Definition

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "attributes":[{
    "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "bank_id":"gh.29.uk",
    "name":"SPECIAL_TAX_NUMBER",
    "category":"Card",
    "type":"STRING",
    "description":"description",
    "alias":"STRING",
    "can_be_seen_on_views":["bank"],
    "is_active":true
  }]
}
Headers:
Required Roles:
  • CanGetCardAttributeDefinitionAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv4.0.0 by getCardAttributeDefinition

Get Card By Id

This will the datails of the card.
It shows the account infomation which linked the the card.
Also shows the card attributes of the card.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "bank_id":"gh.29.uk",
  "card_number":"364435172576215",
  "card_type":"Credit",
  "name_on_card":"SusanSmith",
  "issue_number":"1",
  "serial_number":"1324234",
  "valid_from_date":"2017-09-19T00:00:00Z",
  "expires_date":"2017-09-19T00:00:00Z",
  "enabled":true,
  "cancelled":true,
  "on_hot_list":true,
  "technology":"technologyString1",
  "networks":["networks1"],
  "allows":["credit","debit"],
  "account":{
    "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "label":"My Account",
    "views_available":[{
      "id":"owner",
      "name":"Owner",
      "description":"This view is for the owner for the account."
    }],
    "bank_id":"gh.29.uk"
  },
  "replacement":{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"RENEW"
  },
  "pin_reset":[{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"FORGOT"
  }],
  "collected":"2017-09-19T00:00:00Z",
  "posted":"2017-09-19T00:00:00Z",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "card_attributes":[{
    "name":"OVERDRAFT_START_DATE",
    "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "attribute_type":"STRING",
    "bank_id":{
      "value":"gh.29.uk"
    },
    "value":"2012-04-23",
    "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getCardForBank

Get Cards for the specified bank

Should 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:

								
									
{
  "cards":[{
    "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
    "bank_id":"gh.29.uk",
    "card_number":"364435172576215",
    "card_type":"Credit",
    "name_on_card":"SusanSmith",
    "issue_number":"1",
    "serial_number":"1324234",
    "valid_from_date":"2017-09-19T00:00:00Z",
    "expires_date":"2017-09-19T00:00:00Z",
    "enabled":true,
    "cancelled":true,
    "on_hot_list":true,
    "technology":"technologyString1",
    "networks":["networks1"],
    "allows":["credit","debit"],
    "account":{
      "id":"123",
      "label":"OBP",
      "views_available":[{
        "id":"123",
        "short_name":"short_name",
        "description":"description",
        "is_public":true,
        "alias":"None",
        "hide_metadata_if_alias_used":true,
        "can_add_comment":true,
        "can_add_corporate_location":true,
        "can_add_image":true,
        "can_add_image_url":true,
        "can_add_more_info":true,
        "can_add_open_corporates_url":true,
        "can_add_physical_location":true,
        "can_add_private_alias":true,
        "can_add_public_alias":true,
        "can_add_tag":true,
        "can_add_url":true,
        "can_add_where_tag":true,
        "can_delete_comment":true,
        "can_delete_corporate_location":true,
        "can_delete_image":true,
        "can_delete_physical_location":true,
        "can_delete_tag":true,
        "can_delete_where_tag":true,
        "can_edit_owner_comment":true,
        "can_see_bank_account_balance":true,
        "can_see_bank_account_bank_name":true,
        "can_see_bank_account_currency":true,
        "can_see_bank_account_iban":true,
        "can_see_bank_account_label":true,
        "can_see_bank_account_national_identifier":true,
        "can_see_bank_account_number":true,
        "can_see_bank_account_owners":true,
        "can_see_bank_account_swift_bic":true,
        "can_see_bank_account_type":true,
        "can_see_comments":true,
        "can_see_corporate_location":true,
        "can_see_image_url":true,
        "can_see_images":true,
        "can_see_more_info":true,
        "can_see_open_corporates_url":true,
        "can_see_other_account_bank_name":true,
        "can_see_other_account_iban":true,
        "can_see_other_account_kind":true,
        "can_see_other_account_metadata":true,
        "can_see_other_account_national_identifier":true,
        "can_see_other_account_number":true,
        "can_see_other_account_swift_bic":true,
        "can_see_owner_comment":true,
        "can_see_physical_location":true,
        "can_see_private_alias":true,
        "can_see_public_alias":true,
        "can_see_tags":true,
        "can_see_transaction_amount":true,
        "can_see_transaction_balance":true,
        "can_see_transaction_currency":true,
        "can_see_transaction_description":true,
        "can_see_transaction_finish_date":true,
        "can_see_transaction_metadata":true,
        "can_see_transaction_other_bank_account":true,
        "can_see_transaction_start_date":true,
        "can_see_transaction_this_bank_account":true,
        "can_see_transaction_type":true,
        "can_see_url":true,
        "can_see_where_tag":true
      }],
      "bank_id":"gh.29.uk"
    },
    "replacement":{
      "requested_date":"2017-09-19T00:00:00Z",
      "reason_requested":"RENEW"
    },
    "pin_reset":[{
      "requested_date":"2017-09-19T00:00:00Z",
      "reason_requested":"FORGOT"
    }],
    "collected":"2017-09-19T00:00:00Z",
    "posted":"2017-09-19T00:00:00Z",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getCardsForBank

Get cards for the current user

Returns 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:

								
									
{
  "cards":[{
    "bank_id":"gh.29.uk",
    "bank_card_number":"364435172576215",
    "name_on_card":"String",
    "issue_number":"1",
    "serial_number":"1324234",
    "valid_from_date":"2017-09-19T00:00:00Z",
    "expires_date":"2017-09-19T00:00:00Z",
    "enabled":true,
    "cancelled":true,
    "on_hot_list":true,
    "technology":"String",
    "networks":["String"],
    "allows":["String"],
    "account":{
      "id":"123",
      "label":"OBP",
      "views_available":[{
        "id":"123",
        "short_name":"short_name",
        "description":"description",
        "is_public":true,
        "alias":"None",
        "hide_metadata_if_alias_used":true,
        "can_add_comment":true,
        "can_add_corporate_location":true,
        "can_add_image":true,
        "can_add_image_url":true,
        "can_add_more_info":true,
        "can_add_open_corporates_url":true,
        "can_add_physical_location":true,
        "can_add_private_alias":true,
        "can_add_public_alias":true,
        "can_add_tag":true,
        "can_add_url":true,
        "can_add_where_tag":true,
        "can_delete_comment":true,
        "can_delete_corporate_location":true,
        "can_delete_image":true,
        "can_delete_physical_location":true,
        "can_delete_tag":true,
        "can_delete_where_tag":true,
        "can_edit_owner_comment":true,
        "can_see_bank_account_balance":true,
        "can_see_bank_account_bank_name":true,
        "can_see_bank_account_currency":true,
        "can_see_bank_account_iban":true,
        "can_see_bank_account_label":true,
        "can_see_bank_account_national_identifier":true,
        "can_see_bank_account_number":true,
        "can_see_bank_account_owners":true,
        "can_see_bank_account_swift_bic":true,
        "can_see_bank_account_type":true,
        "can_see_comments":true,
        "can_see_corporate_location":true,
        "can_see_image_url":true,
        "can_see_images":true,
        "can_see_more_info":true,
        "can_see_open_corporates_url":true,
        "can_see_other_account_bank_name":true,
        "can_see_other_account_iban":true,
        "can_see_other_account_kind":true,
        "can_see_other_account_metadata":true,
        "can_see_other_account_national_identifier":true,
        "can_see_other_account_number":true,
        "can_see_other_account_swift_bic":true,
        "can_see_owner_comment":true,
        "can_see_physical_location":true,
        "can_see_private_alias":true,
        "can_see_public_alias":true,
        "can_see_tags":true,
        "can_see_transaction_amount":true,
        "can_see_transaction_balance":true,
        "can_see_transaction_currency":true,
        "can_see_transaction_description":true,
        "can_see_transaction_finish_date":true,
        "can_see_transaction_metadata":true,
        "can_see_transaction_other_bank_account":true,
        "can_see_transaction_start_date":true,
        "can_see_transaction_this_bank_account":true,
        "can_see_transaction_type":true,
        "can_see_url":true,
        "can_see_where_tag":true
      }],
      "bank_id":"gh.29.uk"
    },
    "replacement":{
      "requested_date":"2017-09-19T00:00:00Z",
      "reason_requested":"RENEW"
    },
    "pin_reset":[{
      "requested_date":"2017-09-19T00:00:00Z",
      "reason_requested":"FORGOT"
    }],
    "collected":"2017-09-19T00:00:00Z",
    "posted":"2017-09-19T00:00:00Z"
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.3.0 by getCards

Get status of Credit Card order 

  Get status of Credit Card orders

Get all orders

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "cards":[{
    "card_type":"5",
    "card_description":"good",
    "use_type":"3"
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50212: Connector did not return the set of status of credit card.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getStatusOfCreditCardOrder

Update Card

Update Card at bank specified by CARD_ID .
Authentication is Mandatory

Typical Successful Response:

								
									
{
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "bank_id":"gh.29.uk",
  "card_number":"364435172576215",
  "card_type":"Credit",
  "name_on_card":"SusanSmith",
  "issue_number":"1",
  "serial_number":"1324234",
  "valid_from_date":"2017-09-19T00:00:00Z",
  "expires_date":"2017-09-19T00:00:00Z",
  "enabled":true,
  "cancelled":true,
  "on_hot_list":true,
  "technology":"technologyString1",
  "networks":["networks1"],
  "allows":["credit","debit"],
  "account":{
    "id":"123",
    "label":"OBP",
    "views_available":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":true,
      "alias":"None",
      "hide_metadata_if_alias_used":true,
      "can_add_comment":true,
      "can_add_corporate_location":true,
      "can_add_image":true,
      "can_add_image_url":true,
      "can_add_more_info":true,
      "can_add_open_corporates_url":true,
      "can_add_physical_location":true,
      "can_add_private_alias":true,
      "can_add_public_alias":true,
      "can_add_tag":true,
      "can_add_url":true,
      "can_add_where_tag":true,
      "can_delete_comment":true,
      "can_delete_corporate_location":true,
      "can_delete_image":true,
      "can_delete_physical_location":true,
      "can_delete_tag":true,
      "can_delete_where_tag":true,
      "can_edit_owner_comment":true,
      "can_see_bank_account_balance":true,
      "can_see_bank_account_bank_name":true,
      "can_see_bank_account_currency":true,
      "can_see_bank_account_iban":true,
      "can_see_bank_account_label":true,
      "can_see_bank_account_national_identifier":true,
      "can_see_bank_account_number":true,
      "can_see_bank_account_owners":true,
      "can_see_bank_account_swift_bic":true,
      "can_see_bank_account_type":true,
      "can_see_comments":true,
      "can_see_corporate_location":true,
      "can_see_image_url":true,
      "can_see_images":true,
      "can_see_more_info":true,
      "can_see_open_corporates_url":true,
      "can_see_other_account_bank_name":true,
      "can_see_other_account_iban":true,
      "can_see_other_account_kind":true,
      "can_see_other_account_metadata":true,
      "can_see_other_account_national_identifier":true,
      "can_see_other_account_number":true,
      "can_see_other_account_swift_bic":true,
      "can_see_owner_comment":true,
      "can_see_physical_location":true,
      "can_see_private_alias":true,
      "can_see_public_alias":true,
      "can_see_tags":true,
      "can_see_transaction_amount":true,
      "can_see_transaction_balance":true,
      "can_see_transaction_currency":true,
      "can_see_transaction_description":true,
      "can_see_transaction_finish_date":true,
      "can_see_transaction_metadata":true,
      "can_see_transaction_other_bank_account":true,
      "can_see_transaction_start_date":true,
      "can_see_transaction_this_bank_account":true,
      "can_see_transaction_type":true,
      "can_see_url":true,
      "can_see_where_tag":true
    }],
    "bank_id":"gh.29.uk"
  },
  "replacement":{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"RENEW"
  },
  "pin_reset":[{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"FORGOT"
  }],
  "collected":"2017-09-19T00:00:00Z",
  "posted":"2017-09-19T00:00:00Z",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
Headers:
Required Roles:
  • CanCreateCardsForBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10015: Allowed values are:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by updatedCardForBank

Update Card Attribute

Update 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:

								
									
{
  "name":"OVERDRAFT_START_DATE",
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "attribute_type":"DOUBLE",
  "bank_id":{
    "value":"gh.29.uk"
  },
  "value":"2012-04-23",
  "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by updateCardAttribute

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.

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

Typical Successful Response:

								
									
{
  "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945",
  "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4",
  "status":"INITIATED"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
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
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.

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.
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

Authentication is Mandatory

Example 1:
{
"everything": true,
"views": [],
"entitlements": [],
"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"email": "eveline@example.com"
}

Please note that consumer_id is optional field
Example 2:
{
"everything": true,
"views": [],
"entitlements": [],
"email": "eveline@example.com"
}

Please note if everything=false you need to explicitly specify views and entitlements
Example 3:
{
"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"
}

Typical Successful Response:

								
									
{
  "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945",
  "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4",
  "status":"INITIATED"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-35009: Only SMS and EMAIL are supported as SCA methods.
  • OBP-35013: Consents can only contain Roles that you already have access to.
  • OBP-35014: Consents can only contain Views that you already have access to.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-20058: Consumer is disabled.
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
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
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.

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.
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

Authentication is Mandatory

Example 1:
{
"everything": true,
"views": [],
"entitlements": [],
"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"email": "eveline@example.com"
}

Please note that consumer_id is optional field
Example 2:
{
"everything": true,
"views": [],
"entitlements": [],
"email": "eveline@example.com"
}

Please note if everything=false you need to explicitly specify views and entitlements
Example 3:
{
"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"
}

Typical Successful Response:

								
									
{
  "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945",
  "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4",
  "status":"INITIATED"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-35009: Only SMS and EMAIL are supported as SCA methods.
  • OBP-35013: Consents can only contain Roles that you already have access to.
  • OBP-35014: Consents can only contain Views that you already have access to.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-20058: Consumer is disabled.
  • OBP-00010: Missing props value at this API instance -
  • OBP-35010: SMS server is not working or SMS server can not send the message to the phone number:
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by createConsentSms

Get Consents

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.
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 gets the Consents that the current User created.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "consents":[{
    "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945",
    "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4",
    "status":"INITIATED"
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getConsents

Revoke Consent

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.
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

Revoke Consent for current user specified by CONSENT_ID

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945",
  "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4",
  "status":"REJECTED"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by revokeConsent

Enable or Disable Consumers

Enable/Disable a Consumer specified by CONSUMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "enabled":false
}
Headers:
Required Roles:
  • CanEnableConsumers - Please login to request this Role
  • CanDisableConsumers - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by enableDisableConsumers

Get Call Limits for a Consumer

Get Calls limits per Consumer.
Authentication is Mandatory

Typical Successful Response:

								
									
{
  "per_second_call_limit":"-1",
  "per_minute_call_limit":"-1",
  "per_hour_call_limit":"-1",
  "per_day_call_limit":"-1",
  "per_week_call_limit":"-1",
  "per_month_call_limit":"-1",
  "current_state":{
    "per_second":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_minute":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_hour":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_day":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_week":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_month":{
      "calls_made":-1,
      "reset_in_seconds":-1
    }
  }
}
Headers:
Required Roles:
  • CanSetCallLimits - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30023: Cannot update Consumer
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getCallsLimit

Get Consumer

Get the Consumer specified by CONSUMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "consumer_id":1213,
  "app_name":"SOFI",
  "app_type":"Web",
  "description":"Account Management",
  "developer_email":"felixsmith@example.com",
  "redirect_url":"www.openbankproject.com",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "created_by_user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "enabled":true,
  "created":"2017-09-19T00:00:00Z"
}
Headers:
Required Roles:
  • CanGetConsumers - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getConsumer

Get Consumers

Get the all Consumers.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "consumers":[{
    "consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec",
    "app_name":"SOFI",
    "app_type":"Web",
    "description":"Account Management",
    "developer_email":"felixsmith@example.com",
    "redirect_url":"www.openbankproject.com",
    "created_by_user":{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"felixsmith@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith"
    },
    "enabled":true,
    "created":"2017-09-19T00:00:00Z"
  }]
}
Headers:
Required Roles:
  • CanGetConsumers - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
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:

								
									
{
  "consumers":[{
    "consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec",
    "app_name":"SOFI",
    "app_type":"Web",
    "description":"Account Management",
    "developer_email":"felixsmith@example.com",
    "redirect_url":"www.openbankproject.com",
    "created_by_user":{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"felixsmith@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith"
    },
    "enabled":true,
    "created":"2017-09-19T00:00:00Z"
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getConsumersForCurrentUser

Post a Consumer

Create a Consumer (Authenticated access).

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "app_name":"Some app name",
  "app_type":"App type",
  "description":"Description",
  "developer_email":"some.email@example.com",
  "redirect_url":"Some redirect url",
  "created_by_user_id":"Created by UUID",
  "enabled":true,
  "created":"2021-08-16T00:37:33Z"
}
Headers:
Required Roles:
  • CanCreateConsumer - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv4.0.0 by createConsumer

Set Calls Limit for a Consumer

Set the API call limits for a Consumer:

Per Second
Per Minute
Per Hour
Per Week
Per Month

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "from_date":"2017-09-19T00:00:00Z",
  "to_date":"2017-09-19T00:00:00Z",
  "per_second_call_limit":"-1",
  "per_minute_call_limit":"-1",
  "per_hour_call_limit":"-1",
  "per_day_call_limit":"-1",
  "per_week_call_limit":"-1",
  "per_month_call_limit":"-1"
}
Headers:
Required Roles:
  • CanSetCallLimits - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30023: Cannot update Consumer
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by callsLimit

Update Consumer RedirectUrl

Update 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:

								
									
{
  "consumer_id":1213,
  "app_name":"SOFI",
  "app_type":"Web",
  "description":"Account Management",
  "developer_email":"felixsmith@example.com",
  "redirect_url":"www.openbankproject.com",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "created_by_user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "enabled":true,
  "created":"2017-09-19T00:00:00Z"
}
Headers:
Required Roles:
  • CanUpdateConsumerRedirectUrl - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
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 (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests

  • Implicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.

Explicit Counterparties are created for the account / view
They are how the user of the view (e.g. account owner) refers to the other side of the transaction

name : the human readable name (e.g. Piano teacher, Miss Nipa)

description : the human readable name (e.g. Piano teacher, Miss Nipa)

bank_routing_scheme : eg: bankId or bankCode or any other strings

bank_routing_address : eg: gh.29.uk, must be valid sandbox bankIds

account_routing_scheme : eg: AccountId or AccountNumber or any other strings

account_routing_address : eg: 1d65db7c-a7b2-4839-af41-95, must be valid accountIds

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: branch-id-123 or you can leave it empty, not useful in sandbox mode.

is_beneficiary : must be set to true in order to send payments to this counterparty

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
{
"name": "Tesobe1",
"description": "Good Company",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"is_beneficiary": true,
"other_account_secondary_routing_scheme": "",
"other_account_secondary_routing_address": "",
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}

A minimal example for TransactionRequestType == SEPA

{
"name": "Tesobe2",
"description": "Good Company",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"other_account_secondary_routing_scheme": "IBAN",
"other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00",
"is_beneficiary": true,
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "other_bank_routing_scheme":"OBP",
  "other_bank_routing_address":"gh.29.uk",
  "other_branch_routing_scheme":"OBP",
  "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_routing_scheme":"OBP",
  "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_secondary_routing_scheme":"IBAN",
  "other_account_secondary_routing_address":"DE89370400440532013000",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "private_alias":"String"
  }
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv2.2.0 by createCounterparty

Create Counterparty (Explicit) for any account

Create Counterparty (Explicit) for any Account.

In OBP, there are two types of Counterparty.

  • Explicit Counterparties (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests

  • Implicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.

Explicit Counterparties are created for the account / view
They are how the user of the view (e.g. account owner) refers to the other side of the transaction

name : the human readable name (e.g. Piano teacher, Miss Nipa)

description : the human readable name (e.g. Piano teacher, Miss Nipa)

bank_routing_scheme : eg: bankId or bankCode or any other strings

bank_routing_address : eg: gh.29.uk, must be valid sandbox bankIds

account_routing_scheme : eg: AccountId or AccountNumber or any other strings

account_routing_address : eg: 1d65db7c-a7b2-4839-af41-95, must be valid accountIds

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: branch-id-123 or you can leave it empty, not useful in sandbox mode.

is_beneficiary : must be set to true in order to send payments to this counterparty

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
{
"name": "Tesobe1",
"description": "Good Company",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"is_beneficiary": true,
"other_account_secondary_routing_scheme": "",
"other_account_secondary_routing_address": "",
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}

A minimal example for TransactionRequestType == SEPA

{
"name": "Tesobe2",
"description": "Good Company",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"other_account_secondary_routing_scheme": "IBAN",
"other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00",
"is_beneficiary": true,
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "other_bank_routing_scheme":"OBP",
  "other_bank_routing_address":"gh.29.uk",
  "other_branch_routing_scheme":"OBP",
  "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_routing_scheme":"OBP",
  "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_secondary_routing_scheme":"IBAN",
  "other_account_secondary_routing_address":"DE89370400440532013000",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "private_alias":"String"
  }
}
Headers:
Required Roles:
  • CanCreateCounterpartyAtBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv4.0.0 by createCounterpartyForAnyAccount

Get Counterparties (Explicit)

Get the Counterparties (Explicit) for the account / view.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "counterparties":[{
    "name":"CounterpartyName",
    "description":"My landlord",
    "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "this_bank_id":"gh.29.uk",
    "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "this_view_id":"owner",
    "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "other_bank_routing_scheme":"OBP",
    "other_bank_routing_address":"gh.29.uk",
    "other_branch_routing_scheme":"OBP",
    "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
    "other_account_routing_scheme":"OBP",
    "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
    "other_account_secondary_routing_scheme":"IBAN",
    "other_account_secondary_routing_address":"DE89370400440532013000",
    "is_beneficiary":true,
    "bespoke":[{
      "key":"englishName",
      "value":"english Name"
    }]
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30022: The current view does not have the permission:
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv2.2.0 by getExplictCounterpartiesForAccount

Get Counterparty by Counterparty Id (Explicit)

Information returned about the Counterparty specified by COUNTERPARTY_ID:

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "other_bank_routing_scheme":"OBP",
  "other_bank_routing_address":"gh.29.uk",
  "other_branch_routing_scheme":"OBP",
  "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_routing_scheme":"OBP",
  "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_secondary_routing_scheme":"IBAN",
  "other_account_secondary_routing_address":"DE89370400440532013000",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "private_alias":"String"
  }
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv2.2.0 by getExplictCounterpartyById

Get Other Account by Id

Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.
Authentication is Optional

Authentication is required if the view is not public.

Typical Successful Response:

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "holder":{
    "name":"OBP",
    "is_alias":true
  },
  "bank_routing":{
    "scheme":"Bank_ID",
    "address":"gh.29.uk"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "metadata":{
    "public_alias":"NONE",
    "private_alias":"NONE",
    "more_info":"www.openbankproject.com",
    "URL":"www.openbankproject.com",
    "image_URL":"www.openbankproject.com",
    "open_corporates_URL":"www.openbankproject.com",
    "corporate_location":{
      "latitude":1.231,
      "longitude":1.231,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    },
    "physical_location":{
      "latitude":1.231,
      "longitude":1.231,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    }
  }
}
Headers:
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by getOtherAccountByIdForBankAccount

Get Other Accounts of one Account

Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID.
Authentication is Optional

Authentication is required if the view VIEW_ID is not public.

Typical Successful Response:

								
									
{
  "other_accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "holder":{
      "name":"OBP",
      "is_alias":true
    },
    "bank_routing":{
      "scheme":"Bank_ID",
      "address":"gh.29.uk"
    },
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "metadata":{
      "public_alias":"NONE",
      "private_alias":"NONE",
      "more_info":"www.openbankproject.com",
      "URL":"www.openbankproject.com",
      "image_URL":"www.openbankproject.com",
      "open_corporates_URL":"www.openbankproject.com",
      "corporate_location":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      },
      "physical_location":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      }
    }
  }]
}
Headers:
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by getOtherAccountsForBankAccount

Add Corporate Location to Counterparty

Add the geolocation of the counterparty's registered address

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "success":"Success"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • the view does not allow metadata access
  • the view does not allow adding a corporate location
  • Coordinates not possible
  • Corporate Location cannot be deleted
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by addCounterpartyCorporateLocation

Add Counterparty More Info

Add a description of the counter party from the perpestive of the account e.g. My dentist

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "success":"Success"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-30022: The current view does not have the permission:
  • the view ownerdoes not allow adding more info
  • More Info cannot be added
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by addCounterpartyMoreInfo

Add Open Corporates URL to Counterparty

Add open corporates url to other bank account

Authentication is Optional

Typical Successful Response:

								
									
{
  "success":"Success"
}
Headers:
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow adding an open corporate url
  • URL cannot be added
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by addCounterpartyOpenCorporatesUrl

Add image url to other bank account

Add a url that points to the logo of the counterparty

Authentication is Mandatory