API Explorer 935 endpoints

Get Message Outbox

GET /obp/v7.0.0/management/message-outbox

OBPv7.0.0-getMessageOutbox Roles: CanGetMessageOutbox API

List rows of the generic transactional message outbox — the messages OBP-API must deliver asynchronously, written in the same DB transaction as the business event that caused them and published by the relay with at-least-once redelivery.

Filter with outbox_type (e.g. OPEN_CORRIDOR), status (PENDING / DELIVERED / STICKY) and limit (default 100, max 500). subject_id + subject_id_type name the business object each message is about (a settlement, a transaction request, ...) — not to be confused with the per-request Correlation-Id.

STICKY rows are failures redelivery cannot fix: an error reply that retrying cannot change, or an Open Corridor message still undelivered after 144 attempts on this instance (its last_error keeps the cause). After reconciliation, re-queue one with the retry endpoint. The wire payload is not exposed: it can carry commit-reveal evidence and originator PII.

Authentication is Required.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields (12)
attempts
attempts
created_at
created_at
last_error
last_error
operation_name
operation_name
outbox_id
outbox_id
outbox_type
outbox_type
rows
rows
status
subject_id
subject_id
subject_id_type
subject_id_type
target_id
target_id
updated_at
updated_at
Example success response
{
  "rows": [
    {
      "outbox_id": 42,
      "outbox_type": "OPEN_CORRIDOR",
      "subject_id": "4050046c-63b3-4868-8a22-14b4181d33a6",
      "subject_id_type": "transaction_request_id",
      "operation_name": "obp_credit_notification",
      "target_id": "gh.29.uk",
      "status": "STICKY",
      "attempts": 3,
      "last_error": "OBP-BANK-NODE-COMMITMENT-MISMATCH",
      "created_at": "2026-08-09T15:17:02.000Z",
      "updated_at": "2026-08-09T15:26:27.000Z"
    }
  ]
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 getMessageOutbox