Componer y enviar un mensaje STR curado

Superficie de composición de mensajes curada, restringida por catálogo, enrutada por maker-checker y por tipo. El capabilityId elegido debe estar en la lista de permitidos de composición (STR0004/STR0005/STR0006/STR0007/STR0008/STR0053), resolverse en el catálogo y ser PUBLICLY_SUBMITTABLE; de lo contrario la solicitud se rechaza con SPB-0003 (HTTP 400). El mensaje se construye a través del pipeline de composición compartido y hereda la compuerta de emisión de alçada: un monto por encima de su banda queda retenido en PENDING_APPROVAL (visible en GET /v1/str/emission-approvals, con emissionApprovalId establecido) y se despacha al alcanzar el quórum; por debajo de la banda queda SUBMITTED. Idempotente: reenviar la misma clave X-Idempotency devuelve la misma emisión. El monto declarado se reenvía de forma literal; no se suma ninguna posición.

POST /v1/str/messages/compose

Componer y enviar un mensaje STR curado

cURL

curl --request POST \
  --url https://spb.sandbox.lerian.net/v1/str/messages/compose \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "<string>",
  "capabilityId": "<string>",
  "purposeCode": "<string>",
  "recipient": {
    "ispb": "<string>",
    "account": "<string>",
    "accountType": "<string>",
    "branch": "<string>",
    "document": "<string>",
    "name": "<string>",
    "paymentAccount": "<string>"
  },
  "sender": {
    "ispb": "<string>",
    "account": "<string>",
    "accountType": "<string>",
    "branch": "<string>",
    "document": "<string>",
    "name": "<string>",
    "paymentAccount": "<string>"
  },
  "description": "<string>",
  "finlddCli": "<string>",
  "metadata": {}
}
'

202

{
  "controlNumber": "<string>",
  "correlationId": "<string>",
  "messageId": "<string>",
  "nuOp": "<string>",
  "status": "<string>",
  "emissionApprovalId": "<string>",
  "requiredSignatures": 123
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

Authorization · string

Bearer JWT token (the maker subject is derived from it for the alçada gate).

X-Idempotency · string

Idempotency key (canonical; legacy alias X-Idempotency-Key).

X-Idempotency-Key · string

Idempotency key (legacy alias).

X-TTL · string

Idempotency key TTL in seconds.

Cuerpo

application/json

amount · string · requerido

Transfer amount as a decimal string in BRL, minor-unit precision (two decimal places). Forwarded VERBATIM into the submit DTO and the alçada gate — Lerian SPB performs NO arithmetic on it.

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

Ejemplo:

"150000.00"

capabilityId · string · requerido

STR capability code to compose. Must resolve in the catalog, be PUBLICLY_SUBMITTABLE, and be in the compose allowlist (STR0004/STR0005/STR0006/STR0007/STR0008/STR0053).

Ejemplo:

"STR0008"

purposeCode · string · requerido

BACEN STR purpose code (finalidade), exactly 5 digits. When 99999 (Outros) a description is mandatory (RSTR0034).

Pattern: ^[0-9]{5}$

Ejemplo:

"00001"

recipient · object · requerido

Crediting (creditor) participant account receiving the transfer.

Show child attributes

sender · object · requerido

Debiting (debtor) participant account originating the transfer.

Show child attributes

description · string

Optional free-text description; mandatory when purposeCode or finlddCli is 99999 (RSTR0034). Serialized into the STR Hist element.

Ejemplo:

"Wire transfer for invoice 2026-Q2-A47"

finlddCli · string

Optional client-level purpose code (5 digits) carried on STR0004/STR0008. When 99999 the description is required (RSTR0034).

Pattern: ^[0-9]{5}$

Ejemplo:

"00001"

metadata · object

Opaque client-side metadata forwarded verbatim to the submit DTO (NOT sent to BACEN). Do not include sensitive fields.

Show child attributes

Respuesta

202

application/json

Accepted

controlNumber · string · requerido

14-digit STR control number identifying the message on the SPB network.

Ejemplo:

"20260621000001"

correlationId · string · requerido

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

Ejemplo:

"req-7a3f9c2e"

messageId · string · requerido

Internal outbound-message id assigned at persistence time; the key for the approval queue when parked.

Ejemplo:

"6f2c8a1e-..."

nuOp · string · requerido

23-digit STR operation number stamped on the composed message (protocol correlation).

Ejemplo:

"12345678202606210000001"

status · string · requerido

Emission status: SUBMITTED (dispatched / liquidatable) or PENDING_APPROVAL (parked awaiting maker-checker quorum).

Ejemplo:

"PENDING_APPROVAL"

emissionApprovalId · string

Set ONLY when the emission parked: the maker-checker queue id (equal to messageId). Poll GET /v1/str/emission-approvals to track it. Empty when SUBMITTED immediately.

Ejemplo:

"6f2c8a1e-..."

requiredSignatures · integer<int64>

N-of-M distinct-actor quorum the parked emission must collect (the alçada band requirement). Omitted/0 when SUBMITTED immediately.

Ejemplo:

2