> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Compor e enviar uma mensagem STR curada > Superfície de composição de mensagens curada, restrita por catálogo, roteada por maker-checker e por tipo. O capabilityId escolhido deve estar na lista de permissões de composição (STR0004/STR0005/STR0006/STR0007/STR0008/STR0053), resolver no catálogo e ser PUBLICLY_SUBMITTABLE; caso contrário a solicitação é rejeitada com SPB-0003 (HTTP 400). A mensagem é construída através do pipeline de composição compartilhado e herda a comporta de emissão de alçada: um valor acima de sua banda fica retido em PENDING_APPROVAL (visível em GET /v1/str/emission-approvals, com emissionApprovalId definido) e é despachado ao atingir o quórum; abaixo da banda fica SUBMITTED. Idempotente: reenviar a mesma chave X-Idempotency retorna a mesma emissão. O valor declarado é reenviado de forma literal; nenhuma posição é somada. ## OpenAPI ````yaml pt/openapi/v3-current/spb.yaml post /v1/str/messages/compose openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- Interface OpenAPI 3.1 do Lerian SPB, a integração direta entre a instituição e o Sistema de Pagamentos Brasileiro (SPB) sobre a Rede do Sistema Financeiro Nacional (RSFN). Abrange o Sistema de Transferência de Reservas (STR): registro de mensagens e catálogo de capacidades, ciclo de vida das operações (transferências bancárias, repasses IBS, transferências de liquidez, devoluções e cancelamentos), consultas de conta de reservas e de horários, governança de alçada, conciliação e entrega de eventos. license: name: Lerian Studio General License title: Lerian SPB API version: 1.0.0 servers: - url: https://spb.sandbox.lerian.net security: [] tags: - description: >- Trilhas imutáveis de registros de auditoria para operações STR e eventos de ciclo de vida. name: Audit - description: >- Catálogo de capacidades STR que descreve os tipos de mensagem suportados e suas restrições. name: Capabilities - description: >- Inventário de certificados ICP-Brasil com rotação e ativação recarregáveis a quente. name: Certificates - description: >- Fila de aprovação maker-checker para emissões retidas acima de sua banda de alçada: listar pendentes, assinar (aprovar) e negar. name: EmissionApprovals - description: >- Registros de entrega de eventos por webhook com controle de retentativas para despachos falhos. name: EventDeliveries - description: >- Catálogo de eventos de operação que enumera os tipos de evento de domínio emitidos. name: Events - description: >- Registro de avisos recebidos da família GEN (GEN0001 eco de conectividade, GEN0004 erro de transmissão, GEN0005 aviso administrativo). name: GenNotices - description: >- Governança de alçada do SPB: a tabela de bandas de valor e os requisitos de assinatura por tipo de mensagem, recarregados a quente em tempo de execução. name: Governance - description: >- Estado bruto das mensagens STR: listar as mensagens e ler uma mensagem individual por NUOp. name: Messages - description: Resumos e métricas operacionais agregados das operações STR. name: OperationalIntelligence - description: >- Ciclo de vida das operações STR para transferências bancárias e repasses IBS, incluindo devoluções e cancelamentos. name: Operations - description: >- Estado de prontidão do serviço que abrange as autoverificações de inicialização e a saúde das dependências. name: Readiness - description: Casos de conciliação e as ações que resolvem as divergências de operação. name: Reconciliation - description: >- Suíte de relatórios STR: relatórios agregados síncronos por intervalo de datas (movimento financeiro, transações rejeitadas, volumetria) sobre o próprio registro de transmissão do Lerian SPB. name: Reports - description: >- Consultas de saldo de conta de reservas STR0013 e de extrato STR0014 (modo mensagem) e seus resultados assíncronos. name: ReserveQueries - description: >- Lista de responsáveis do participante GEN0019: atualizações de substituição total anunciadas ao BACEN. name: Responsibles - description: >- Programação de janelas de operação do STR que rege quando as operações podem ser enviadas. name: Schedule - description: >- Consultas de horários STR0001 de parte única (consulta de horários do STR) e seus resultados de grade STR0001R1 assíncronos. name: ScheduleQueries - description: Configurações de tempo de execução do SPB para a integração STR. name: Settings - description: >- Registro e gerenciamento de endpoints de webhook para a entrega de eventos. name: Webhooks - description: >- Fluxo (ordem obrigatória): certificado → prontidão → teste-de-conectividade → envio. Ative um certificado, confirme que o rail reporta prontidão, passe em um teste de conectividade e então envie uma operação. Cada etapa é seu próprio recurso; um envio não deve ser tentado antes de a prontidão passar. name: onboarding - description: >- Fluxo (ordem obrigatória): operação pai SETTLED → devolução/cancelamento. Uma devolução ou cancelamento é um sub-recurso de uma operação pai liquidada; o segmento de rota {operationId}/{endToEndID} impõe o pai estruturalmente. name: lifecycle paths: /v1/str/messages/compose: post: tags: - Messages summary: Compor e enviar uma mensagem STR curada description: >- Superfície de composição de mensagens curada, restrita por catálogo, roteada por maker-checker e por tipo. O capabilityId escolhido deve estar na lista de permissões de composição (STR0004/STR0005/STR0006/STR0007/STR0008/STR0053), resolver no catálogo e ser PUBLICLY_SUBMITTABLE; caso contrário a solicitação é rejeitada com SPB-0003 (HTTP 400). A mensagem é construída através do pipeline de composição compartilhado e herda a comporta de emissão de alçada: um valor acima de sua banda fica retido em PENDING_APPROVAL (visível em GET /v1/str/emission-approvals, com emissionApprovalId definido) e é despachado ao atingir o quórum; abaixo da banda fica SUBMITTED. Idempotente: reenviar a mesma chave X-Idempotency retorna a mesma emissão. O valor declarado é reenviado de forma literal; nenhuma posição é somada. operationId: composeStrMessage parameters: - description: >- Bearer JWT token (the maker subject is derived from it for the alçada gate). in: header name: Authorization schema: description: >- Bearer JWT token (the maker subject is derived from it for the alçada gate). type: string - description: Idempotency key (canonical; legacy alias X-Idempotency-Key). in: header name: X-Idempotency schema: description: Idempotency key (canonical; legacy alias X-Idempotency-Key). type: string - description: Idempotency key (legacy alias). in: header name: X-Idempotency-Key schema: description: Idempotency key (legacy alias). type: string - description: Idempotency key TTL in seconds. in: header name: X-TTL schema: description: Idempotency key TTL in seconds. type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ComposeMessageRequest' responses: '202': content: application/json: schema: $ref: '#/components/schemas/ComposeMessageResponse' description: Accepted default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: ComposeMessageRequest: additionalProperties: false properties: amount: description: >- 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. examples: - '150000.00' pattern: ^[0-9]+(\.[0-9]+)?$ type: string capabilityId: description: >- 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). examples: - STR0008 type: string description: description: >- Optional free-text description; mandatory when purposeCode or finlddCli is 99999 (RSTR0034). Serialized into the STR Hist element. examples: - Wire transfer for invoice 2026-Q2-A47 type: string finlddCli: description: >- Optional client-level purpose code (5 digits) carried on STR0004/STR0008. When 99999 the description is required (RSTR0034). examples: - '00001' pattern: ^[0-9]{5}$ type: string metadata: additionalProperties: {} description: >- Opaque client-side metadata forwarded verbatim to the submit DTO (NOT sent to BACEN). Do not include sensitive fields. type: object purposeCode: description: >- BACEN STR purpose code (finalidade), exactly 5 digits. When 99999 (Outros) a description is mandatory (RSTR0034). examples: - '00001' pattern: ^[0-9]{5}$ type: string recipient: $ref: '#/components/schemas/ComposeParticipantAccount' description: Crediting (creditor) participant account receiving the transfer. sender: $ref: '#/components/schemas/ComposeParticipantAccount' description: Debiting (debtor) participant account originating the transfer. required: - capabilityId - sender - recipient - amount - purposeCode type: object ComposeMessageResponse: additionalProperties: false properties: controlNumber: description: >- 14-digit STR control number identifying the message on the SPB network. examples: - '20260621000001' type: string correlationId: description: >- Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace. examples: - req-7a3f9c2e type: string emissionApprovalId: description: >- 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. examples: - 6f2c8a1e-... type: string messageId: description: >- Internal outbound-message id assigned at persistence time; the key for the approval queue when parked. examples: - 6f2c8a1e-... type: string nuOp: description: >- 23-digit STR operation number stamped on the composed message (protocol correlation). examples: - '12345678202606210000001' type: string requiredSignatures: description: >- N-of-M distinct-actor quorum the parked emission must collect (the alçada band requirement). Omitted/0 when SUBMITTED immediately. examples: - 2 format: int64 type: integer status: description: >- Emission status: SUBMITTED (dispatched / liquidatable) or PENDING_APPROVAL (parked awaiting maker-checker quorum). examples: - PENDING_APPROVAL type: string required: - messageId - status - nuOp - controlNumber - correlationId type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string type: object ComposeParticipantAccount: additionalProperties: false properties: account: description: Optional traditional bank account number. examples: - '123456' type: string accountType: description: >- Optional account type: CC (checking/conta corrente) or PP (payment account/conta de pagamento). examples: - CC type: string branch: description: Optional bank branch (agência) number. examples: - '0001' type: string document: description: >- Holder document (CPF/CNPJ, digits only). Carried on the client codes STR0007/STR0008. examples: - '12345678901' type: string ispb: description: Participant ISPB, the 8-digit BACEN institution identifier. examples: - '12345678' maxLength: 8 minLength: 8 pattern: ^[0-9]{8}$ type: string name: description: Holder name. Carried on the client codes STR0007/STR0008. examples: - João da Silva type: string paymentAccount: description: >- Optional payment account identifier (conta de pagamento). Required when accountType is PP. examples: - '00000000123456' type: string required: - ispb type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````