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

# Consult a Pix Automático schedule cancellation

> Consults the live upstream situation of a schedule cancellation, keyed by (endToEndId, idCancelamento).



## OpenAPI

````yaml en/openapi/v3-current/pix.yaml GET /v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento}
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  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/{endToEndId}/cancel/{idCancelamento}:
    get:
      tags:
        - Pix Automático API
      summary: Consult a Pix Automático schedule cancellation
      description: >-
        Consults the live upstream situation of a schedule cancellation, keyed
        by (endToEndId, idCancelamento).
      parameters:
        - description: The payment-transaction id (32-char).
          in: path
          name: endToEndId
          required: true
          schema:
            description: The payment-transaction id (32-char).
            type: string
        - description: The cancellation id (29-char, CA...).
          in: path
          name: idCancelamento
          required: true
          schema:
            description: The cancellation id (29-char, CA...).
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleCancellationResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ScheduleCancellationResponse:
      additionalProperties: false
      properties:
        cancelStatus:
          description: stCancelamento (0=Aceito, 1=Rejeitado; -1 when absent).
          format: int64
          type: integer
        cancelledAt:
          description: Cancellation timestamp (UTC).
          type: string
        endToEndId:
          description: The payment-transaction id.
          type: string
        errorCode:
          description: Upstream error code.
          type: string
        errorDesc:
          description: Upstream error description.
          type: string
        idCancelamento:
          description: The cancellation id (CA...).
          type: string
        localStatus:
          description: Local ScheduleStatus projected from the upstream situation.
          type: string
        localStatusKnown:
          description: False when the upstream situation carries no projected local status.
          type: boolean
        reason:
          description: motivoCancelamento (0..6).
          format: int64
          type: integer
        recipientIspb:
          description: ispbDestinatario (string).
          type: string
        reconciliationId:
          description: The receiver conciliation id.
          type: string
        requestedAt:
          description: Upstream request timestamp (UTC).
          type: string
        requester:
          description: solCancelamento (0=PSP pagador, 1=PSP recebedor).
          format: int64
          type: integer
        requesterDocument:
          description: Requester CPF/CNPJ (string).
          type: string
        requesterIspb:
          description: ispbSolicitante (string).
          type: string
        requesterType:
          description: tpPessoaSol.
          format: int64
          type: integer
        situationAt:
          description: Situation timestamp (UTC).
          type: string
        stJdPi:
          description: Upstream overall situation.
          format: int64
          type: integer
        stJdPiProc:
          description: Upstream intermediate situation.
          format: int64
          type: integer
      required:
        - idCancelamento
        - endToEndId
        - stJdPiProc
        - stJdPi
        - localStatus
        - localStatusKnown
        - requester
        - requesterIspb
        - recipientIspb
        - requesterType
        - requesterDocument
        - reason
        - cancelStatus
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          format: uri
          type: string
        status:
          description: HTTP status code
          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.
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          format: uri
          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:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        JWT Bearer token authentication. Obtain token from
        `/v1/login/oauth/access_token` endpoint

        using client credentials (clientId and clientSecret).


        Include token in Authorization header:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        Token expires after 3600 seconds (1 hour).

````