right logo image
right logo image
Ingresar
⯆

API Explorer

Log off

v3.0.0 (164 APIs)

Anfitrión de la API: https://api3.openbankproject.com
Banco
Cuentas
Vistas
Contrapartes
Transacciones

Get Bank Level Dynamic Resource Docs

Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.

This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.

This endpoint is used by OBP API Explorer to display and work with the API documentation.

Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank

You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.

You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.

You may need some other language resource docs, now we support i18n language tag , e.g. ?locale=zh_CN

You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.

You can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123

See the Resource Doc endpoint for more information.

Following are more examples:
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=zh_CN
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
https://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?cache-modifier=3141592653

  • operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
  • version references the version that the API call is defined in.
  • function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
  • request_url is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource
  • specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.
  • summary is a short description inline with the swagger terminology.
  • description may contain html markup (generated from markdown on the server).

Authentication is Mandatory

URL Parameters:

API_VERSION:

BANK_ID: gh.29.uk

JSON response body fields:

connector_methods: connector_methods

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

description_markdown: description_markdown

error_response_bodies: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.

example_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}

function: function

implemented_by: implemented_by

is_featured: false

operation_id: OBPv4.0.0-getBanks

request_url: /my_user/MY_USER_ID

request_verb: POST

resource_docs: resource_docs

special_instructions:

specified_url:

success_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}

summary:

tags: Create-My-User

typed_request_body: typed_request_body

typed_success_response_body: typed_success_response_body

version:

created_by_bank_id: created_by_bank_id

meta:

roles: CanCreateMyUser

Respuesta Exitosa Típica: 

								
									
{
  "resource_docs":[{
    "operation_id":"OBPv1.4.0-testResourceDoc",
    "implemented_by":{
      "version":"OBPv1.4.0",
      "function":"testResourceDoc"
    },
    "request_verb":"GET",
    "request_url":"/dummy",
    "summary":"Test Resource Doc",
    "description":"<p>I am only a test Resource Doc</p>\n<p>Authentication is Mandatory</p>\n<p><strong>JSON response body fields:</strong></p>\n",
    "description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n",
    "example_request_body":{
      "jsonString":"{}"
    },
    "success_response_body":{
      "jsonString":"{}"
    },
    "error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],
    "tags":["Documentation"],
    "typed_request_body":{
      "type":"object",
      "properties":{
        "jsonString":{
          "type":"string"
        }
      }
    },
    "typed_success_response_body":{
      "type":"object",
      "properties":{
        "jsonString":{
          "type":"string"
        }
      }
    },
    "roles":[{
      "role":"CanGetCustomers",
      "requires_bank_id":true
    }],
    "is_featured":false,
    "special_instructions":"",
    "specified_url":"",
    "connector_methods":[]
  }]
}
Roles Requeridos:
  • CanReadDynamicResourceDocsAtOneBank - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv1.4.0, function_name: by getBankLevelDynamicResourceDocsObp, operation_id: OBPv1.4.0-getBankLevelDynamicResourceDocsObp Tags: Documentation, API,

Get Glossary of the API

Get API Glossary

Returns the glossary of the API

Authentication is Optional

JSON response body fields:

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

glossary_items:

html: html format content

markdown:

title: Dr.

Respuesta Exitosa Típica: 

								
									
{
  "glossary_items":[{
    "title":"Dr.",
    "description":{
      "markdown":"String",
      "html":"String"
    }
  }]
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.0.0, function_name: by getApiGlossary, operation_id: OBPv3.0.0-getApiGlossary Tags: Documentation,

Get Message Docs

These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.
Integrators can use these messages to build Adapters that provide core banking services to OBP.

Note: API Explorer provides a Message Docs page where these messages are displayed.

CONNECTOR: kafka_vSept2018, stored_procedure_vDec2019 ...

Authentication is Optional

URL Parameters:

CONNECTOR: CONNECTOR

JSON response body fields:

adapter_implementation:

dependent_endpoints:

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

example_inbound_message: {}

example_outbound_message: {}

group:

message_docs:

message_format:

name: ACCOUNT_MANAGEMENT_FEE

process: obp.getBank

suggested_order:

version:

inboundAvroSchema:

inbound_topic:

outboundAvroSchema:

outbound_topic:

requiredFieldInfo: false

Respuesta Exitosa Típica: 

								
									
{
  "message_docs":[{
    "process":"getAccounts",
    "message_format":"KafkaV2017",
    "outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts",
    "inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts",
    "description":"get Banks",
    "example_outbound_message":{
      "jsonString":"{}"
    },
    "example_inbound_message":{
      "jsonString":"{}"
    },
    "outboundAvroSchema":{
      "jsonString":"{}"
    },
    "inboundAvroSchema":{
      "jsonString":"{}"
    },
    "adapter_implementation":{
      "group":"CORE",
      "suggested_order":3
    },
    "dependent_endpoints":[{
      "name":"getAccounts",
      "version":"OBPv3.0.0"
    },{
      "name":"getBalances",
      "version":"OBPv2.0.0"
    }],
    "requiredFieldInfo":{
      "data.bankId":["v2.2.0","v3.1.0"]
    }
  }]
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv2.2.0, function_name: by getMessageDocs, operation_id: OBPv2.2.0-getMessageDocs Tags: Documentation, API,

Get Resource Docs

Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.

This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.

This endpoint is used by OBP API Explorer to display and work with the API documentation.

Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank

You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.

You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.

You may need some other language resource docs, now we support i18n language tag , e.g. ?locale=zh_CN

You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.

You can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123

See the Resource Doc endpoint for more information.

Following are more examples:
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653

  • operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
  • version references the version that the API call is defined in.
  • function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
  • request_url is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource
  • specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.
  • summary is a short description inline with the swagger terminology.
  • description may contain html markup (generated from markdown on the server).

Authentication is Mandatory

URL Parameters:

API_VERSION:

JSON response body fields:

connector_methods: connector_methods

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

description_markdown: description_markdown

error_response_bodies: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.

example_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}

function: function

implemented_by: implemented_by

is_featured: false

operation_id: OBPv4.0.0-getBanks

request_url: /my_user/MY_USER_ID

request_verb: POST

resource_docs: resource_docs

special_instructions:

specified_url:

success_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}

summary:

tags: Create-My-User

typed_request_body: typed_request_body

typed_success_response_body: typed_success_response_body

version:

created_by_bank_id: created_by_bank_id

meta:

roles: CanCreateMyUser

Respuesta Exitosa Típica: 

								
									
{
  "resource_docs":[{
    "operation_id":"OBPv1.4.0-testResourceDoc",
    "implemented_by":{
      "version":"OBPv1.4.0",
      "function":"testResourceDoc"
    },
    "request_verb":"GET",
    "request_url":"/dummy",
    "summary":"Test Resource Doc",
    "description":"<p>I am only a test Resource Doc</p>\n<p>Authentication is Mandatory</p>\n<p><strong>JSON response body fields:</strong></p>\n",
    "description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n",
    "example_request_body":{
      "jsonString":"{}"
    },
    "success_response_body":{
      "jsonString":"{}"
    },
    "error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],
    "tags":["Documentation"],
    "typed_request_body":{
      "type":"object",
      "properties":{
        "jsonString":{
          "type":"string"
        }
      }
    },
    "typed_success_response_body":{
      "type":"object",
      "properties":{
        "jsonString":{
          "type":"string"
        }
      }
    },
    "roles":[{
      "role":"CanGetCustomers",
      "requires_bank_id":true
    }],
    "is_featured":false,
    "special_instructions":"",
    "specified_url":"",
    "connector_methods":[]
  }]
}
Roles Requeridos:
  • CanReadResourceDoc - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv1.4.0, function_name: by getResourceDocsObp, operation_id: OBPv1.4.0-getResourceDocsObp Tags: Documentation, API,

Get Resource Docs

Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.

This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.

This endpoint is used by OBP API Explorer to display and work with the API documentation.

Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank

You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.

You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.

You may need some other language resource docs, now we support i18n language tag , e.g. ?locale=zh_CN

You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.

You can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123

See the Resource Doc endpoint for more information.

Following are more examples:
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
https://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653

  • operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
  • version references the version that the API call is defined in.
  • function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
  • request_url is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource
  • specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.
  • summary is a short description inline with the swagger terminology.
  • description may contain html markup (generated from markdown on the server).

Authentication is Mandatory

URL Parameters:

API_VERSION:

JSON response body fields:

connector_methods: connector_methods

count:

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

description_markdown: description_markdown

error_response_bodies: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.

example_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}

function: function

implemented_by: implemented_by

is_featured: false

operation_id: OBPv4.0.0-getBanks

request_url: /my_user/MY_USER_ID

request_verb: POST

resource_docs: resource_docs

response_date: response_date

special_instructions:

specified_url:

success_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}

summary:

tags: Create-My-User

typed_request_body: typed_request_body

typed_success_response_body: typed_success_response_body

version:

created_by_bank_id: created_by_bank_id

meta:

roles: CanCreateMyUser

Respuesta Exitosa Típica: 

								
									
{
  "resource_docs":[{
    "operation_id":"OBPv1.4.0-testResourceDoc",
    "implemented_by":{
      "version":"OBPv1.4.0",
      "function":"testResourceDoc"
    },
    "request_verb":"GET",
    "request_url":"/dummy",
    "summary":"Test Resource Doc",
    "description":"<p>I am only a test Resource Doc</p>\n<p>Authentication is Mandatory</p>\n<p><strong>JSON response body fields:</strong></p>\n",
    "description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n",
    "example_request_body":{
      "jsonString":"{}"
    },
    "success_response_body":{
      "jsonString":"{}"
    },
    "error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],
    "tags":["Documentation"],
    "typed_request_body":{
      "type":"object",
      "properties":{
        "jsonString":{
          "type":"string"
        }
      }
    },
    "typed_success_response_body":{
      "type":"object",
      "properties":{
        "jsonString":{
          "type":"string"
        }
      }
    },
    "roles":[{
      "role":"CanGetCustomers",
      "requires_bank_id":true
    }],
    "is_featured":false,
    "special_instructions":"",
    "specified_url":"",
    "connector_methods":[]
  }],
  "meta":{
    "response_date":"2024-10-06T00:00:38Z",
    "count":1
  }
}
Roles Requeridos:
  • CanReadResourceDoc - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv1.4.0, function_name: by getResourceDocsObpV400, operation_id: OBPv1.4.0-getResourceDocsObpV400 Tags: Documentation, API,

Get Swagger documentation

Returns documentation about the RESTful resources on this server in Swagger format.

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank

(All endpoints are given one or more tags which for used in grouping)

You may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById

(Each endpoint is implemented in the OBP Scala code by a 'function')

See the Resource Doc endpoint for more information.

Following are more examples:
https://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger
https://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
https://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
https://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById

Authentication is Optional

URL Parameters:

API_VERSION:

JSON response body fields:

Respuesta Exitosa Típica: 

								
									
{
  "jsonString":"{}"
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv1.4.0, function_name: by getResourceDocsSwagger, operation_id: OBPv1.4.0-getResourceDocsSwagger Tags: Documentation, API,