Compose and send a curated STR message

Catalog-gated, maker-checker-routed, per-type curated message-compose surface. The chosen capabilityId must be in the compose allowlist (STR0004/STR0005/STR0006/STR0007/STR0008/STR0053), resolve in the catalog, and be PUBLICLY_SUBMITTABLE; otherwise the request is rejected SPB-0003 (HTTP 400). The message is built through the shared compose pipeline and inherits the alçada emission gate: an amount above its band parks in PENDING_APPROVAL (visible in GET /v1/str/emission-approvals, emissionApprovalId set) and dispatches on quorum; below band it is SUBMITTED. Idempotent — replaying the same X-Idempotency key returns the same emission. The declared amount is forwarded verbatim; no position is summed.

POST /v1/str/messages/compose

Compose and send a curated STR message

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
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

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.

Body

application/json

amount · string · required

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]+)?$

Example:

"150000.00"

capabilityId · string · required

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

Example:

"STR0008"

purposeCode · string · required

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

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

Example:

"00001"

recipient · object · required

Crediting (creditor) participant account receiving the transfer.

Show child attributes

sender · object · required

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.

Example:

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

Example:

"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

Response

202

application/json

Accepted

controlNumber · string · required

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

Example:

"20260621000001"

correlationId · string · required

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

Example:

"req-7a3f9c2e"

messageId · string · required

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

Example:

"6f2c8a1e-..."

nuOp · string · required

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

Example:

"12345678202606210000001"

status · string · required

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

Example:

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

Example:

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

Example:

2