List operations

Lists operations with optional filters. Cursor-based pagination — pass the nextCursor from a previous response to continue. The cursor is opaque and MUST NOT be parsed by clients. Raw protocol payload fields never appear in responses.

GET /v1/str/operations

List operations

cURL

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

200

{
  "correlationId": "req-7a3f9c2e",
  "items": [
    {
      "capabilityId": "STR0004",
      "createdAt": "2026-05-06T18:30:00Z",
      "direction": "OUTBOUND",
      "operationFamily": "bankTransfer",
      "operationId": "7c8b3a2e-9f1d-4a55-9b8e-1e1234567890",
      "status": "ACCEPTED",
      "updatedAt": "2026-05-06T18:31:00Z",
      "amount": "150.00",
      "clientReference": "client-ref-1",
      "counterpartyISPB": "87654321",
      "protocolMetadata": {
        "controlNumber": "20260506000000000001",
        "emissionApprovalId": "<string>",
        "nuOp": "12345678202605060000001"
      },
      "scheduledExecutionAt": "2026-06-23T10:00:00Z"
    }
  ],
  "limit": 20,
  "total": 142,
  "nextCursor": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

operationFamily · string

Operation family filter (e.g. bankTransfer).

capabilityId · string

Capability filter (e.g. STR0004).

status · string[] | null

Public lifecycle status filter. Repeat the param for multiple values (?status=A&status=B) — WHERE status IN (...).

direction · string

Direction filter (INBOUND or OUTBOUND).

startDate · string

Inclusive lower bound (RFC3339 timestamp or YYYY-MM-DD).

endDate · string

Inclusive upper bound (RFC3339 timestamp or YYYY-MM-DD).

correlationId · string

Filter by request correlation identity.

nuOp · string

Filter by STR protocol nuOp.

cursor · string

Opaque pagination token from a previous response.

limit · integer<int64> · predeterminado: 20

Items per page (default 20, max 100).

Rango requerido: 1 <= x <= 100

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

Operation summaries for the current page.

Show child attributes

limit · integer<int64> · requerido

Effective page size applied to this response.

Ejemplo:

20

total · integer<int64> · requerido

COUNT(*) of operations 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:

142

nextCursor · string

Opaque cursor for the next page; absent when this is the last page. Do not parse.