API Explorer

Builder
Login

Builder b1 (4 APIs)

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

Bank

Accounts

Views

Counterparties

Transactions

Create Template

Create template. Authentication is Mandatory.

Typical Successful Response:

								
									
{
  "id":"11231231312",
  "author":"Chinua Achebe",
  "pages":209,
  "points":1.3
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in API-BUILDERb1 by createTemplate

Delete Template

Delete template. Authentication is Mandatory.

Typical Successful Response:

								
									
{
  "jsonString":"true"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in API-BUILDERb1 by deleteTemplate

Get Template

Return one template. Authentication is Mandatory.

Typical Successful Response:

								
									
{
  "id":"11231231312",
  "author":"Chinua Achebe",
  "pages":209,
  "points":1.3
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in API-BUILDERb1 by getTemplate

Get Templates

Return All my templates. Authentication is Mandatory.

Typical Successful Response:

								
									
[{
  "id":"11231231312",
  "author":"Chinua Achebe",
  "pages":209,
  "points":1.3
}]
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in API-BUILDERb1 by getTemplates

Get documentation about the selected endpoints as:

Resource Docs JSON

 

Swagger 2 JSON

This list can be used as a basis to limit the available endpoints by editing the API Props:

[createTemplate, deleteTemplate, getTemplate, getTemplates]

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.