Get Message Docs
GET /obp/v7.0.0/message-docs/CONNECTOR
OBPv2.2.0-getMessageDocs No role required Message-DocDocumentationAPI
These message docs provide example messages sent by OBP to the (RabbitMq) 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: rest_vMar2019, stored_procedure_vDec2019 ...
User Authentication is Optional. The User need not be logged in.
URL Parameters:
CONNECTOR: CONNECTOR
JSON response body fields (17)
- adapter_implementation
- dependent_endpoints
- description
- Description of the object. 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
Example success response
{
"message_docs": [
{
"process": "getAccounts",
"message_format": "rest_vMar2019",
"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"
]
}
}
]
}Possible errors (2)
- OBP-30211: Invalid Connector. Please specify a valid value for CONNECTOR.
- OBP-50000: Unknown Error.