right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (610 APIs)

API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Create sandbox

Import bulk data into the sandbox (Authenticated access).

This call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.

The user needs to have CanCreateSandbox entitlement.

Note: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.

An example of an import set of data (json) can be found here
Authentication is Mandatory

JSON request body fields:

IBAN: DE91 1000 0000 0123 4567 89

accounts:

actual_date: 2020-01-27

address:

amount: 10.12

atms:

balance: 10

bank:

bank_id: gh.29.uk

banks:

branches:

category:

channel:

city:

code: 125

completed: 2020-01-27

country_code: 1254

county:

crm_events:

currency: EUR

customer:

description: This an optional field. Maximum length is 2000. It can be any characters here.

detail:

details:

email: felixsmith@example.com

family:

full_name: full name string

generate_accountants_view:

generate_auditors_view:

generate_public_view:

hours:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

latitude: 38.8951

license:

line_1:

line_2:

line_3:

location:

logo: logo url

longitude: -77.0364

meta:

more_info_url: www.example.com/abc

name: ACCOUNT_MANAGEMENT_FEE

new_balance: 20

number:

owners:

password: password

post_code: 789

posted: 2020-01-27

products:

short_name:

state:

super_family:

this_account:

transactions:

type:

user_name: felixsmith

users: user list

value: 5987953

website: www.openbankproject.com

account_number: 546387432

counterparty:

driveUp:

lobby:

name: ACCOUNT_MANAGEMENT_FEE

JSON response body fields:

success:

Typical Successful Response: 

								
									
{
  "success":"Success"
}
Required Roles:
  • CanCreateSandbox - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-00002: Data import is disabled for this API instance.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by sandboxDataImport, operation_id: OBPv2.1.0-sandboxDataImport Tags: Sandbox,