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

# Validate an inbound PIX Automatico schedule cancellation

> Validates an inbound schedule cancellation request (camt.055) pushed by JDPI (section 5.3.2, the plugin is the server). The cancellation is valid iff a live schedule exists and the FSM permits a transition to Cancelled from its current status; the result is returned inline (200).



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules/inbound/cancellation/validate
openapi: 3.1.0
info:
  description: Brazilian PIX Direct (DICT + SPI) plugin API.
  title: plugin-br-pix-jd
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
paths:
  /v1/pix-automatico/schedules/inbound/cancellation/validate:
    post:
      tags:
        - PIX Automatico
      summary: Validate an inbound PIX Automatico schedule cancellation
      description: >-
        Validates an inbound schedule cancellation request (camt.055) pushed by
        JDPI (section 5.3.2, the plugin is the server). The cancellation is
        valid iff a live schedule exists and the FSM permits a transition to
        Cancelled from its current status; the result is returned inline (200).
      operationId: validateInboundPixAutomaticoScheduleCancellation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateScheduleCancellationBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateScheduleCancellationResponse'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ValidateScheduleCancellationBody:
      additionalProperties: true
      properties:
        cpfCnpjSolCancelamento:
          description: Requester CPF/CNPJ (a v5.5.0 string).
          examples:
            - '77379362038'
          type: string
        dtHrCancelamento:
          description: Cancellation timestamp (UTC).
          examples:
            - '2024-09-20T10:10:05.025Z'
          type: string
        endToEndId:
          description: Unique payment-instruction id (32-char).
          examples:
            - E11111111202409201500y6j6mt9l1pi
          type: string
        idCancelamento:
          description: Unique cancellation id (29-char, CA...).
          examples:
            - CA0435879820240920bcdb1fhn43a
          type: string
        idConciliacaoRecebedor:
          description: Receiver conciliation id (35-char).
          examples:
            - JDPI2024091800000000000000000000002
          type: string
        idRecorrencia:
          description: Unique recurrence id (29-char, RR...).
          examples:
            - RR0435879820240919njua7shf40o
          type: string
        ispbDestinatario:
          description: Destination PSP ISPB (8 digits, a v5.5.0 string).
          examples:
            - '11111111'
          type: string
        ispbSolicitante:
          description: Requesting PSP ISPB (8 digits, a v5.5.0 string).
          examples:
            - '04358798'
          type: string
        motivoCancelamento:
          description: Cancellation reason (0..6).
          examples:
            - 5
          format: int64
          type: integer
        solCancelamento:
          description: Requesting PSP (0=pagador, 1=recebedor).
          examples:
            - 0
          format: int64
          type: integer
        tpPessoaSol:
          description: Requester person type (0=PF, 1=PJ).
          examples:
            - 0
          format: int64
          type: integer
      required:
        - idCancelamento
        - idRecorrencia
        - solCancelamento
        - ispbSolicitante
        - ispbDestinatario
        - idConciliacaoRecebedor
        - tpPessoaSol
        - cpfCnpjSolCancelamento
        - motivoCancelamento
        - endToEndId
        - dtHrCancelamento
      type: object
    ValidateScheduleCancellationResponse:
      additionalProperties: false
      properties:
        dtHrValidacao:
          description: Validation timestamp (UTC).
          examples:
            - '2024-09-20T14:12:05.025Z'
          type: string
        motivoRejeicao:
          description: Rejection reason code (required when resultado=0).
          examples:
            - CH16
          type: string
        resultado:
          description: Validation result (0=Invalido, 1=Valido).
          examples:
            - 1
          format: int64
          type: integer
      required:
        - resultado
        - dtHrValidacao
      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
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      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
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````