API Explorer

v4.0.0 (353 APIs)

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:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Required Roles:
  • CanCreateSandbox - Please login to request this Role
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:
Implemented in OBPv2.1.0 by sandboxDataImport, operation_id: OBPv2.1.0-sandboxDataImport