API Explorer

⯆

API Explorer

My Collections

API
- The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeably
  More...
- Get API Info (root)
Account
- The thing that tokens of value (money) come in and out of. An account has one or more `owners` which
  More...
- Create View
- Get access for specific user
- Get account by id
- Get accounts at all banks (Private, inc views)
- Get accounts at bank (Private)
- Get private accounts at all banks (Authenticated access)
- Get private accounts at one bank
- Get public accounts at all banks (Anonymous access)
- Update Account Label
- Update View
Account Public
- Get public accounts at one bank (Anonymous access)
Bank
- A Bank (aka Space) represents a financial institution, brand or organizational unit under which res
  More...
- Get Bank
- Get Banks
Bank Accounts (Dynamic Endpoint)
Counterparty
Counterparty Metadata
Documentation
Dynamic Resource Doc
- In OBP we largely define our endpoints using an internal case class or model called ResourceDoc
  More...
- A test endpoint
Example Title
Qredo Partner & Core Client API
Reltime
Transaction
- Transactions are records of successful movements of value into or out of an `Account`. OBP Transac
  More...
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Full)
Transaction Metadata
View Custom
_FooBar
_OBP API
_OBP Activity
_OBP Reena

Log off

v1.2.1 (144 APIs)

API Host: https://obp-apisandbox.bancohipotecario.com.sv

Get API Info (root)

Returns information about:

API version
Hosted by information
Git Commit

Authentication is Optional

JSON response body fields:

connector: connector
email: felixsmith@example.com
git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

Typical Successful Response

								
									{
  "version":"String",
  "version_status":"String",
  "git_commit":"String",
  "connector":"String",
  "hosted_by":{
    "organisation":"String",
    "email":"String",
    "phone":"String",
    "organisation_website":"String"
  }
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.
no connector set

Connector Methods:

Version: OBPv1.2.1, function_name: by root, operation_id: OBPv1.2.1-root Tags: API,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

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

Featured APIs

API Explorer

v1.2.1 (144 APIs)

Get API Info (root)