API Explorer

obp.openCorridorSettlementInstruction

Open Corridor: instruct the debtor bank's Bank Node to settle the net amount on its settlement rail (e.g. cardano-ada). AMQP messageId on the wire: obp_settlement_instruction. `amount` is in major units. `idempotency_key` is required — the Bank Node keeps a durable settlement record per key and never pays twice; re-publishing the same instruction returns the recorded state (redelivery doubles as SUBMITTED → FINAL status polling). Published to the debtor bank's vhost.

Format rabbitmq_vOct2024 Group Open Corridor Suggested order 1

Outbound message (OBP to adapter)
{
  "snapshot_id": "snap-1",
  "settlement_id": "settle-1",
  "settlement_system": "cardano-ada",
  "currency": "KES",
  "amount": "1500.00",
  "creditor_bank_id": "gh.29.uk",
  "creditor_address": "addr_test1vqn7sn79x6k9a2353l458mk2gccmwqk7nza93zydpuvl7lquy6jcl",
  "idempotency_key": "settle-1"
}
Inbound message (adapter to OBP)
{
  "inboundAdapterCallContext": {
    "correlationId": "1flssoftxq0cr1nssr68u0mioj"
  },
  "status": {
    "errorCode": "",
    "backendMessages": []
  },
  "data": {
    "settlement_id": "settle-1",
    "status": "SUBMITTED",
    "tx_id": "787e857c1d49735603d283965b010c0c721aa4cdea627ec1ce8be266a5112845",
    "blockchain": "cardano",
    "asset": "ADA",
    "asset_amount": "10.000000",
    "depth": 0,
    "finality_depth": 15
  }
}