Skip to main content
GET
Get STR message detail

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

nuOp
string
required

Message NUOp (23 characters: ISPB[8]+DATE[8]+SEQ[7]).

Required string length: 23
Pattern: ^[0-9A-Z]{8}[0-9]{15}$

Response

OK

correlationId
string
required

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

Example:

"req-7a3f9c2e"

message
object
required

The message's status projection (identifiers, lifecycle, BACEN-receipt fields).

payload
object
required

The structured payload_json persisted for this message (parsed STR fields). Always present.

payloadFormat
enum<string>
required

Availability label for the signed on-wire frame: 'reconstructed' means a frame was retained for this message and is readable at GET /v1/str/messages/{nuOp}/frame (guarded by its own scope), 'structured' means no on-wire bytes were retained and only the payload fields above exist.

Available options:
reconstructed,
structured
Example:

"reconstructed"

correspondent
object

The resolved original<->correspondent counterpart: for an outbound, the inbound response BACEN sent back; for an inbound, the outbound it answers. Absent when no counterpart has been correlated yet.