Set AMQP Bank Broker
PUT /obp/v7.0.0/banks/BANK_ID/amqp-broker
OBPv7.0.0-setAmqpBankBroker Roles: CanConfigureAmqpBankBroker(per bank) Bank
Register (or replace) the AMQP broker coordinates for a bank — where OBP-API publishes messages destined for that bank's own infrastructure. Named by transport, not by consumer; Open Corridor Interface C is the first consumer.
Each onboarded bank's Bank Node consumes Interface C messages on its own vhost with its own credentials; OBP-API publishes obp_credit_notification to the creditor bank's vhost and obp_settlement_instruction / obp_settlement_advice using the coordinates registered here. One registration per bank (upsert semantics).
The password is write-only and never returned by any endpoint.
This record carries transport coordinates only. The bank's on-chain settlement address is NOT part of it: it is the CARDANO account routing on the bank's OBP-INCOMING-SETTLEMENT-ACCOUNT (manage it via Update Account / Create Account).
Authentication is Required.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields (6)
Example request body
{
"host": "rabbitmq.bank.example.com",
"port": 5672,
"virtual_host": "/bank.gh.29.uk",
"username": "obp-api",
"password": "***",
"use_ssl": false
}Example success response
{
"bank_id": "gh.29.uk",
"host": "rabbitmq.bank.example.com",
"port": 5672,
"virtual_host": "/bank.gh.29.uk",
"username": "obp-api",
"use_ssl": false
}Possible errors (6)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-10035: Incorrect json value.
- OBP-50000: Unknown Error.