List received electronic-money advices

Returns the durable log of electronic-money movements the STR ADVISED us about over a client’s conta correspondente a moeda eletrônica (CCME) — movements this rail did NOT command. Each leg reaches the side that did not command it: SME0001R2 (an FI funded a CCME) reaches the credited IEME, SME0002R2 (funds were recalled out of a CCME) reaches the FI, SME0004R2 (an entry received in error was given back) reaches the credited party. An advice is therefore never an answer to a frame we sent, and correlating it to one is wrong by construction. Amounts and the BACEN date stamps cross VERBATIM as the frame spelled them, with no arithmetic and no parsing; the response carries NO total, so a client learns how many advices it loaded and never how many exist. Most recent first by receipt; optionally filter by advice leg or by the window in which this rail received them.

GET /v1/str/sme-advices

List received electronic-money advices

cURL

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

200

{
  "correlationId": "req-7a3f9c2e",
  "items": [
    {
      "amount": "1200.55",
      "id": "0190b3a1-1c2d-7e4f-8a9b-0c1d2e3f4a5b",
      "numCtrlSTR": "20260902000001",
      "receivedAt": "2026-09-02T12:00:00Z",
      "wireCode": "SME0001R2",
      "agCredtd": "0001",
      "cnpjCliCredtd": "12345678000199",
      "creditedIspb": "12345678",
      "ctCredtd": "123456",
      "debitedIspb": "00038166",
      "description": "devolucao de lancamento recebido em duplicidade",
      "dtHrBC": "2026-09-02T09:15:00",
      "dtMovto": "2026-09-02",
      "ispbIFCredtd": "00038166",
      "originalControlNumber": "20260901000009"
    }
  ],
  "limit": 50,
  "nextCursor": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

wireCode · enum<string>

Optional advice-leg filter. Only the three response legs are admitted: the R1 legs are answers to this rail's OWN commands, not third-party advice.

Opciones disponibles: SME0001R2, SME0002R2, SME0004R2

startDate · string

Optional inclusive start of the window in which THIS RAIL RECEIVED the advice (receivedAt) — not the BACEN business date dtMovto. RFC3339 instant or bare YYYY-MM-DD.

Ejemplo:

"2026-09-01"

endDate · string

Optional inclusive end of the window in which THIS RAIL RECEIVED the advice (receivedAt) — not the BACEN business date dtMovto. A bare YYYY-MM-DD spans the whole day.

Ejemplo:

"2026-09-02"

cursor · string

Opaque pagination token from a previous response.

limit · integer<int64> · predeterminado: 50

Items per page (default 50, 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

Received advices matching the request, most recent first (by the receipt clock of this rail).

Show child attributes

limit · integer<int64> · requerido

Effective page size applied to this response.

Ejemplo:

50

nextCursor · string

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