List STR messages

Lists outbound and inbound STR messages with optional filters and cursor-based pagination. The cursor is opaque — pass the nextCursor value from a previous response to continue. Filters can be combined freely; results are merged in the requested sort order.

GET /v1/str/messages

List STR messages

cURL

curl --request GET \
  --url https://api.example.com/v1/str/messages \
  --header 'Authorization: Bearer <token>'

200

{
  "correlationId": "req-7a3f9c2e",
  "items": [
    {
      "createdAt": "2026-05-04T18:29:55Z",
      "direction": "OUTBOUND",
      "messageType": "STR0004",
      "nuOp": "12345678202605040000001",
      "status": "DELIVERED",
      "amount": "150.00",
      "controlNumber": "20260503000000000001",
      "mqMessageId": "414d5120514d2020202020202020202060f0c2a201a30b25",
      "resolvedAt": "2026-05-04T18:30:05Z",
      "strStatus": "Acatado"
    }
  ],
  "limit": 50,
  "total": 318,
  "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTA1LTA0VDE4OjMwOjAwWiIsImlkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIn0"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

cursor · string

Opaque pagination token from a previous response.

limit · integer<int64> · predeterminado: 20

Page size (default 20, max 100).

Rango requerido: 1 <= x <= 100

sort_order · enum<string>

Sort order (default desc, most recent first).

Opciones disponibles: asc, desc

message_type · string

Filter by STR message type (e.g. STR0004).

status · enum<string>

Filter by processing status. PENDING_APPROVAL is the maker-checker parked state: an emission above its alçada band awaiting its distinct-actor signatures, filterable here exactly as it is published on the log rows.

Opciones disponibles: SUBMITTED, DELIVERED, CONFIRMED, REJECTED, FAILED, RETURNED, CANCELED, RECEIVED, PENDING_APPROVAL

direction · enum<string>

Filter by message direction.

Opciones disponibles: INBOUND, OUTBOUND

start_date · string

Lower bound for created_at (RFC3339 or YYYY-MM-DD).

end_date · string

Upper bound for created_at (RFC3339 or YYYY-MM-DD).

Respuesta

200

application/json

OK

correlationId · string · requerido

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

Ejemplo:

"req-7a3f9c2e"

items · object[] · requerido

Page of message summaries ordered most-recent-first.

Show child attributes

limit · integer<int64> · requerido

Page size applied to this response (number of items requested).

Ejemplo:

50

total · integer<int64> · requerido

Sum of the per-repository (outbound + inbound) COUNT(*) matching the same filters as items, excluding the cursor/limit — the full filtered-set size, stable across pages (a record count, never a monetary sum).

Ejemplo:

318

nextCursor · string

Opaque cursor for the next page; absent when there are no more results. Presence signals more results, absence signals end-of-list.

Ejemplo:

"eyJjcmVhdGVkQXQiOiIyMDI2LTA1LTA0VDE4OjMwOjAwWiIsImlkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIn0"