Crear operación de repasse IBS

Prerrequisito: el rail debe estar listo antes de un envío: un certificado activo (ver rotateCertificate, activateCertificate), un reporte de disponibilidad READY (ver getReadiness) y una prueba de conectividad aprobada (ver createConnectivityTest). Acepta una operación de repasse IBS STR0053 (repasse de reservas de los valores de liquidación IBS al comitê gestor) a través de la API centrada en operaciones. El handler traduce la solicitud JSON a la ruta de solicitud XML STR0053, persiste el agregado de operación y el trabajo de relay de salida SUBMITTED, y devuelve el sobre canónico OperationAccepted. El despacho fue aceptado, no una confirmación de liquidación de BACEN. Idempotente: reenviar la misma clave X-Idempotency con el mismo cuerpo devuelve la respuesta en caché.

POST /v1/str/operations/ibs-repasses

Crear operación de repasse IBS

cURL

curl --request POST \
  --url https://spb.sandbox.lerian.net/v1/str/operations/ibs-repasses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "dtHrInfSeggc": "<string>",
  "dtRepFinanc": "<string>",
  "identdInfSeggc": "<string>",
  "recipient": {
    "ispb": "<string>",
    "account": "<string>",
    "accountType": "<string>",
    "branch": "<string>",
    "document": "<string>",
    "name": "<string>",
    "party": "<string>",
    "paymentAccount": "<string>"
  },
  "sender": {
    "ispb": "<string>",
    "account": "<string>",
    "accountType": "<string>",
    "branch": "<string>",
    "document": "<string>",
    "name": "<string>",
    "party": "<string>",
    "paymentAccount": "<string>"
  },
  "clientReference": "<string>",
  "description": "<string>",
  "metadata": {},
  "qtdTransc": "<string>"
}
'

201

{
  "acceptedAt": "2023-11-07T05:31:56Z",
  "capabilityId": "<string>",
  "correlationId": "<string>",
  "isReplay": true,
  "operationFamily": "<string>",
  "operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "protocolMetadata": {
    "controlNumber": "<string>",
    "nuOp": "<string>"
  }
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

Authorization · string

Bearer JWT token.

X-Idempotency · string

Idempotency key (canonical).

X-Idempotency-Key · string

Idempotency key (legacy alias).

X-TTL · string

Idempotency key TTL in seconds.

Cuerpo

application/json

amount · string · requerido

Repasse amount as a decimal string in BRL, minor-unit precision (two decimal places).

Pattern: ^[0-9]+(\.[0-9]+)?$

Ejemplo:

"1500.25"

dtHrInfSeggc · string · requerido

Settlement-info timestamp in BACEN STR0053 ISO dateTime form (e.g. 2026-06-09T12:00:00) WITHOUT a timezone offset; the use case validates the BACEN format.

Ejemplo:

"2026-06-09T12:00:00"

dtRepFinanc · string · requerido

Financial repasse date in BACEN STR0053 ISO date form (e.g. 2026-06-09).

Ejemplo:

"2026-06-09"

identdInfSeggc · string · requerido

Comitê-gestor settlement-info identifier (required, 1-50 chars).

Maximum string length: 50

Ejemplo:

"SEGGC-INFO-0001"

recipient · object · requerido

Crediting participant account (comitê gestor) receiving the IBS repasse.

Show child attributes

sender · object · requerido

Debiting participant account originating the IBS repasse.

Show child attributes

clientReference · string

Optional caller-supplied correlation reference echoed back for client-side reconciliation.

Ejemplo:

"ibs-ref-1"

description · string

Optional free-text description carried with the operation.

Ejemplo:

"Repasse IBS comite gestor"

metadata · object

Opaque client-side metadata forwarded verbatim to the legacy submit DTO. NOT persisted on the operation intent or sanitized payload.

Show child attributes

qtdTransc · string

Optional transaction count (digits only).

Ejemplo:

"10"

Respuesta

201

application/json

Created

acceptedAt · string<date-time> · requerido

UTC RFC 3339 timestamp at which the command was accepted.

Ejemplo:

"2026-05-06T18:30:00Z"

capabilityId · string · requerido

STR capability identifier resolved for the accepted operation (e.g. STR0004).

Ejemplo:

"STR0004"

correlationId · string · requerido

Request correlation identifier for tracing the accept across logs and traces.

Ejemplo:

"req-7c8b3a2e-9f1d-4a55-9b8e-1e1234567890"

isReplay · boolean · requerido

True when this response replays a prior idempotent accept rather than creating a new operation.

Ejemplo:

false

operationFamily · string · requerido

Operation family the accepted command belongs to (e.g. bankTransfer).

Ejemplo:

"bankTransfer"

operationId · string<uuid> · requerido

Server-assigned operation aggregate UUID used for subsequent status, return, and cancellation calls.

Ejemplo:

"7c8b3a2e-9f1d-4a55-9b8e-1e1234567890"

status · string · requerido

Current control-plane lifecycle status of the operation; ACCEPTED on initial accept.

Ejemplo:

"ACCEPTED"

protocolMetadata · object

Optional SAFE protocol correlation fields; present once the operation is mapped to STR wire identifiers.

Show child attributes