API Explorer

⯆

API Explorer

My Collections

API
- The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeably
  More...
- Get API Info (root)
ATM
- Get Bank ATM
Account
- The thing that tokens of value (money) come in and out of. An account has one or more `owners` which
  More...
- Create Account
- Create View
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank
- Get Accounts at all Banks (Private)
- Get all Accounts at all Banks
- Get private accounts at one bank
- Update Account Label
- Update View
Account Public
Bank
- A Bank (aka Space) represents a financial institution, brand or organizational unit under which res
  More...
- Create Transaction Type at bank
- Get Bank
- Get Bank ATMS
- Get Banks
- Get Transaction Types at Bank
Bank Accounts (Dynamic Endpoint)
Branch
Card
Consumer
- The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on be
  More...
- Enable or Disable Consumers
- Get Consumer
- Get Consumers
- Update Consumer RedirectUrl
Counterparty
Counterparty Metadata
Customer
- The legal entity that has the relationship to the bank. Customers are linked to Users via `User Cus
  More...
- Add Social Media Handle
- Create Customer
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get Customers for Current User
- Get Customers for current User at Bank
Customer Meeting
Customer Message
Data Warehouse
- Search Warehouse Data Via Elasticsearch
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
KYC
Metric
Product
Qredo Partner & Core Client API
Reltime
Role
Sandbox
- Create sandbox
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 (Core)
- Get Transactions for Account (Full)
Transaction Metadata
Transaction Request
User
- The entity that accesses the API with a login / authorisation token and has access to zero or more
  More...
- Create User
- Get User (Current)
- Get Users by Email Address
- Get all Users
View Custom
_FooBar
_OBP API
_OBP Activity
_OBP Reena

Log off

v2.1.0 (206 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

v2.1.0 (206 APIs)

Get API Info (root)