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

# Crear operación de cancelación de transferencia bancaria

> Prerrequisito: la operación padre debe existir y admitir cancelación; lee su estado mediante getOperation (GET /v1/str/operations/{operationId}); el segmento de ruta {operationId} vincula estructuralmente la cancelación con su padre. El handler resuelve la original por operationId, controla el ciclo de vida (SPB-3006 si el estado lo prohíbe) y delega en la ruta de cancelación STR0011.



## OpenAPI

````yaml es/openapi/v3-current/spb.yaml post /v1/str/operations/bank-transfers/{operationId}/cancellations
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Interfaz OpenAPI 3.1 de Lerian SPB, la integración directa entre la
    institución y el Sistema de Pagos Brasileño (SPB) sobre la Red del Sistema
    Financiero Nacional (RSFN). Cubre el Sistema de Transferencia de Reservas
    (STR): registro de mensajes y catálogo de capacidades, ciclo de vida de las
    operaciones (transferencias bancarias, repasses IBS, transferencias de
    liquidez, devoluciones y cancelaciones), consultas de cuenta de reservas y
    de horarios, gobernanza de alçada, conciliación y 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: >-
      Rastros inmutables de registros de auditoría para operaciones STR y
      eventos de ciclo de vida.
    name: Audit
  - description: >-
      Catálogo de capacidades STR que describe los tipos de mensaje admitidos y
      sus restricciones.
    name: Capabilities
  - description: >-
      Inventario de certificados ICP-Brasil con rotación y activación
      recargables en caliente.
    name: Certificates
  - description: >-
      Cola de aprobación maker-checker para emisiones retenidas por encima de su
      banda de alçada: listar pendientes, firmar (aprobar) y denegar.
    name: EmissionApprovals
  - description: >-
      Registros de entrega de eventos por webhook con control de reintentos para
      despachos fallidos.
    name: EventDeliveries
  - description: >-
      Catálogo de eventos de operación que enumera los tipos de evento de
      dominio emitidos.
    name: Events
  - description: >-
      Registro de avisos entrantes de la familia GEN (GEN0001 eco de
      conectividad, GEN0004 error de transmisión, GEN0005 aviso administrativo).
    name: GenNotices
  - description: >-
      Gobernanza de alçada del SPB: la tabla de bandas de valor y los requisitos
      de firma por tipo de mensaje, recargados en caliente en tiempo de
      ejecución.
    name: Governance
  - description: >-
      Estado crudo de los mensajes STR: listar los mensajes y leer un mensaje
      individual por NUOp.
    name: Messages
  - description: Resúmenes y métricas operativas agregadas de las operaciones STR.
    name: OperationalIntelligence
  - description: >-
      Ciclo de vida de las operaciones STR para transferencias bancarias y
      repasses IBS, incluyendo devoluciones y cancelaciones.
    name: Operations
  - description: >-
      Estado de disponibilidad del servicio que abarca las autopruebas de
      arranque y la salud de las dependencias.
    name: Readiness
  - description: >-
      Casos de conciliación y las acciones que resuelven las discrepancias de
      operación.
    name: Reconciliation
  - description: >-
      Suite de reportes STR: reportes agregados síncronos por rango de fechas
      (movimiento financiero, transacciones rechazadas, volumetria) sobre el
      propio registro de transmisión de Lerian SPB.
    name: Reports
  - description: >-
      Consultas de saldo de cuenta de reservas STR0013 y de extrato STR0014
      (modo mensaje) y sus resultados asíncronos.
    name: ReserveQueries
  - description: >-
      Lista de responsáveis del participante GEN0019: actualizaciones de
      reemplazo total anunciadas a BACEN.
    name: Responsibles
  - description: >-
      Programación de ventanas de operación del STR que rige cuándo pueden
      enviarse las operaciones.
    name: Schedule
  - description: >-
      Consultas de horarios STR0001 de parte única (consulta de horários do STR)
      y sus resultados de grilla STR0001R1 asíncronos.
    name: ScheduleQueries
  - description: >-
      Ajustes de configuración del SPB en tiempo de ejecución para la
      integración STR.
    name: Settings
  - description: Registro y gestión de endpoints de webhook para la entrega de eventos.
    name: Webhooks
  - description: >-
      Flujo (orden obligatorio): certificado → disponibilidad →
      prueba-de-conectividad → envío. Activa un certificado, confirma que el
      rail reporta listo, pasa una prueba de conectividad y luego envía una
      operación. Cada paso es su propio recurso; no debes intentar un envío
      antes de que la disponibilidad pase.
    name: onboarding
  - description: >-
      Flujo (orden obligatorio): operación padre SETTLED →
      devolución/cancelación. Una devolución o cancelación es un sub-recurso de
      una operación padre liquidada; el segmento de ruta
      {operationId}/{endToEndID} impone el padre estructuralmente.
    name: lifecycle
paths:
  /v1/str/operations/bank-transfers/{operationId}/cancellations:
    post:
      tags:
        - Operations
        - lifecycle
      summary: Crear operación de cancelación de transferencia bancaria
      description: >-
        Prerrequisito: la operación padre debe existir y admitir cancelación;
        lee su estado mediante getOperation (GET
        /v1/str/operations/{operationId}); el segmento de ruta {operationId}
        vincula estructuralmente la cancelación con su padre. El handler
        resuelve la original por operationId, controla el ciclo de vida
        (SPB-3006 si el estado lo prohíbe) y delega en la ruta de cancelación
        STR0011.
      operationId: createBankTransferCancellationOperation
      parameters:
        - description: Original bank-transfer operation UUID.
          in: path
          name: operationId
          required: true
          schema:
            description: Original bank-transfer operation UUID.
            type: string
        - description: Bearer JWT token.
          in: header
          name: Authorization
          schema:
            description: Bearer JWT token.
            type: string
        - description: Idempotency key (canonical).
          in: header
          name: X-Idempotency
          schema:
            description: Idempotency key (canonical).
            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/CreateBankTransferCancellationRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationAcceptedResponse'
          description: Created
          links:
            prerequisite:
              description: >-
                Lifecycle prerequisite: the parent operation read by
                getOperation gates cancellation eligibility.
              operationId: getOperation
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    CreateBankTransferCancellationRequest:
      additionalProperties: false
      properties:
        metadata:
          additionalProperties: {}
          description: >-
            Opaque client-side metadata forwarded verbatim to the legacy submit
            DTO; not persisted on the cancellation intent.
          type: object
        reason:
          description: Optional free-text reason for the cancellation.
          examples:
            - Client requested cancellation
          type: string
        senderIspb:
          description: >-
            ISPB of the participant requesting the cancellation, the 8-digit
            BACEN institution identifier.
          examples:
            - '12345678'
          type: string
      required:
        - senderIspb
      type: object
    OperationAcceptedResponse:
      additionalProperties: false
      properties:
        acceptedAt:
          description: UTC RFC 3339 timestamp at which the command was accepted.
          examples:
            - '2026-05-06T18:30:00Z'
          format: date-time
          type: string
        capabilityId:
          description: >-
            STR capability identifier resolved for the accepted operation (e.g.
            STR0004).
          examples:
            - STR0004
          type: string
        correlationId:
          description: >-
            Request correlation identifier for tracing the accept across logs
            and traces.
          examples:
            - req-7c8b3a2e-9f1d-4a55-9b8e-1e1234567890
          type: string
        isReplay:
          description: >-
            True when this response replays a prior idempotent accept rather
            than creating a new operation.
          examples:
            - false
          type: boolean
        operationFamily:
          description: >-
            Operation family the accepted command belongs to (e.g.
            bankTransfer).
          examples:
            - bankTransfer
          type: string
        operationId:
          description: >-
            Server-assigned operation aggregate UUID used for subsequent status,
            return, and cancellation calls.
          examples:
            - 7c8b3a2e-9f1d-4a55-9b8e-1e1234567890
          format: uuid
          type: string
        protocolMetadata:
          $ref: '#/components/schemas/OperationProtocolMetadata'
          description: >-
            Optional SAFE protocol correlation fields; present once the
            operation is mapped to STR wire identifiers.
        status:
          description: >-
            Current control-plane lifecycle status of the operation; ACCEPTED on
            initial accept.
          examples:
            - ACCEPTED
          type: string
      required:
        - operationId
        - operationFamily
        - capabilityId
        - status
        - acceptedAt
        - isReplay
        - correlationId
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-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
    OperationProtocolMetadata:
      additionalProperties: false
      properties:
        controlNumber:
          description: >-
            STR control number, 14 digits identifying the message on the SPB
            network.
          examples:
            - '20260506000001'
          maxLength: 14
          minLength: 14
          type: string
        nuOp:
          description: >-
            STR operation number (NUOp), 23 digits: 8-digit ISPB + 8-digit date
            + 7-digit sequence.
          examples:
            - '12345678202605060000001'
          maxLength: 23
          minLength: 23
          pattern: ^[0-9]{8}[0-9]{8}[0-9]{7}$
          type: string
      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

````