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

# Registrar una cancelación de programación entrante de Pix Automático

> Registra un resultado de cancelación de programación entregado por el sistema upstream. Una cancelación aceptada (stCancelamento=0) transiciona la programación a Cancelled y elimina la fila de forma lógica; una cancelación rechazada (stCancelamento=1) se acusa sin cambio de estado. Devuelve el id local del settlement-gateway.



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml POST /v1/pix-automatico/schedules/inbound/cancellation/register
openapi: 3.0.3
info:
  title: Plugin BR Pix Directo - API completa
  description: >
    API completa para el sistema de pagos instantáneos Pix de Brasil,

    que incluye operaciones del diccionario de claves Pix,
    generación/decodificación

    de códigos QR, transacciones y límites transaccionales.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/pix-automatico/schedules/inbound/cancellation/register:
    post:
      tags:
        - Pix Automático API
      summary: Registrar una cancelación de programación entrante de Pix Automático
      description: >-
        Registra un resultado de cancelación de programación entregado por el
        sistema upstream. Una cancelación aceptada (stCancelamento=0)
        transiciona la programación a Cancelled y elimina la fila de forma
        lógica; una cancelación rechazada (stCancelamento=1) se acusa sin cambio
        de estado. Devuelve el id local del settlement-gateway.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterScheduleCancellationBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterScheduleCancellationResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    RegisterScheduleCancellationBody:
      additionalProperties: false
      properties:
        codigoErro:
          description: Código de error del upstream (100 caracteres; en un rechazo).
          type: string
        cpfCnpjSolCancelamento:
          description: CPF/CNPJ del solicitante (una cadena v5.5.0).
          type: string
        descCodigoErro:
          description: Descripción del error del upstream (100 caracteres).
          type: string
        dtHrCancelamento:
          description: Marca de tiempo de la cancelación (UTC).
          type: string
        endToEndId:
          description: Id único de la instrucción de pago (32 caracteres).
          type: string
        idCancelamento:
          description: Id de cancelación único (29 caracteres, CA...).
          type: string
        idConciliacaoRecebedor:
          description: Id de conciliación del receptor (35 caracteres).
          type: string
        idRecorrencia:
          description: Id de recurrencia único (29 caracteres, RR...).
          type: string
        ispbDestinatario:
          description: ISPB del PSP de destino (8 dígitos, una cadena v5.5.0).
          type: string
        ispbSolicitante:
          description: ISPB del PSP solicitante (8 dígitos, una cadena v5.5.0).
          type: string
        motivoCancelamento:
          description: Motivo de cancelación (0..6).
          format: int64
          type: integer
        solCancelamento:
          description: PSP solicitante (0=pagador, 1=recebedor).
          format: int64
          type: integer
        stCancelamento:
          description: Estado de la cancelación (0=Aceito, 1=Rejeitado).
          format: int64
          type: integer
        tpPessoaSol:
          description: Tipo de persona del solicitante (0=PF, 1=PJ).
          format: int64
          type: integer
      required:
        - idCancelamento
        - idRecorrencia
        - stCancelamento
        - solCancelamento
        - ispbSolicitante
        - ispbDestinatario
        - idConciliacaoRecebedor
        - tpPessoaSol
        - cpfCnpjSolCancelamento
        - motivoCancelamento
        - endToEndId
        - dtHrCancelamento
      type: object
    RegisterScheduleCancellationResponse:
      additionalProperties: false
      properties:
        dtHrSgct:
          description: Marca de tiempo de registro del settlement-gateway (UTC).
          type: string
        idSgct:
          description: >-
            Id de cancelación local del settlement-gateway (GUID de 36
            caracteres).
          type: string
      required:
        - idSgct
        - dtHrSgct
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de error de dominio estable y legible por máquina, acotado al
            servicio emisor (formato: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            Una explicación legible para humanos específica de esta ocurrencia
            del problema.
          type: string
        errors:
          description: Lista opcional de detalles de error individuales
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            Una referencia URI que identifica la ocurrencia específica del
            problema.
          format: uri
          type: string
        status:
          description: Código de estado HTTP
          format: int64
          type: integer
        title:
          description: >-
            Un resumen breve y legible para humanos del tipo de problema. Este
            valor no debería cambiar entre ocurrencias del error.
          type: string
        type:
          default: about:blank
          description: >-
            Una referencia URI a la documentación legible para humanos del
            error.
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Dónde ocurrió el error, p. ej. 'body.items[3].tags' o
            'path.thing-id'
          type: string
        message:
          description: Texto del mensaje de error
          type: string
        value:
          description: El valor en la ubicación indicada
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticación con token JWT Bearer. Obtén el token desde el endpoint
        `/v1/login/oauth/access_token`

        usando credenciales de cliente (`clientId` y `clientSecret`).


        Incluye el token en el encabezado Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        El token expira después de 3600 segundos (1 hora).

````