Create IBS repasse operation

Prerequisite: the rail must be ready before a submit — an active certificate (see rotateCertificate, activateCertificate), a READY readiness report (see getReadiness), and a passing connectivity test (see createConnectivityTest). Accepts a STR0053 IBS-repasse operation (reserve repasse of IBS settlement values to the comitê gestor) through the operation-centric API. The handler translates the JSON request into the STR0053 XML request path, persists the operation aggregate and SUBMITTED outbound relay work, and returns the canonical OperationAccepted envelope. Dispatch was accepted, not BACEN settlement confirmation. Idempotent — replaying the same X-Idempotency key with the same body returns the cached response.

POST /v1/str/operations/ibs-repasses

Create IBS repasse operation

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>"
  }
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

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.

Body

application/json

amount · string · required

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

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

Example:

"1500.25"

dtHrInfSeggc · string · required

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.

Example:

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

dtRepFinanc · string · required

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

Example:

"2026-06-09"

identdInfSeggc · string · required

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

Maximum string length: 50

Example:

"SEGGC-INFO-0001"

recipient · object · required

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

Show child attributes

sender · object · required

Debiting participant account originating the IBS repasse.

Show child attributes

clientReference · string

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

Example:

"ibs-ref-1"

description · string

Optional free-text description carried with the operation.

Example:

"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).

Example:

"10"

Response

201

application/json

Created

acceptedAt · string<date-time> · required

UTC RFC 3339 timestamp at which the command was accepted.

Example:

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

capabilityId · string · required

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

Example:

"STR0004"

correlationId · string · required

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

Example:

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

isReplay · boolean · required

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

Example:

false

operationFamily · string · required

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

Example:

"bankTransfer"

operationId · string<uuid> · required

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

Example:

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

status · string · required

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

Example:

"ACCEPTED"

protocolMetadata · object

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

Show child attributes