> ## 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 Automatico schedule cancellation > Consults the live JDPI situation of a schedule cancellation (JDPI 4.4.4), keyed by (endToEndId, idCancelamento). ## OpenAPI ````yaml /en/openapi/v3-current/pix.yaml get /v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento} 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/{endToEndId}/cancel/{idCancelamento}: get: tags: - PIX Automatico summary: Consult a PIX Automatico schedule cancellation description: >- Consults the live JDPI situation of a schedule cancellation (JDPI 4.4.4), keyed by (endToEndId, idCancelamento). operationId: getPixAutomaticoScheduleCancellation parameters: - description: The payment-transaction id (32-char). in: path name: endToEndId required: true schema: description: The payment-transaction id (32-char). examples: - E00038166202409171500y6j6mt9l0pi type: string - description: The cancellation id (29-char, CA...). in: path name: idCancelamento required: true schema: description: The cancellation id (29-char, CA...). examples: - CA0435879820240605abcd1234567 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScheduleCancellationResponse' 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: ScheduleCancellationResponse: additionalProperties: false properties: cancelStatus: description: stCancelamento (0=Aceito, 1=Rejeitado; -1 when absent). examples: - 0 format: int64 type: integer cancelledAt: description: Cancellation timestamp (UTC). examples: - '2024-10-01T10:00:00Z' type: string endToEndId: description: The payment-transaction id. examples: - E00038166202409171500y6j6mt9l0pi type: string errorCode: description: JDPI error code. examples: - '' type: string errorDesc: description: JDPI error description. examples: - '' type: string idCancelamento: description: The cancellation id (CA...). examples: - CA0435879820240605abcd1234567 type: string localStatus: description: Local ScheduleStatus projected from the JDPI situation. examples: - Cancelled type: string localStatusKnown: description: False when the JDPI situation carries no projected local status. examples: - true type: boolean reason: description: motivoCancelamento (0..6). examples: - 0 format: int64 type: integer recipientIspb: description: ispbDestinatario (string). examples: - '00038166' type: string reconciliationId: description: The receiver conciliation id. examples: - JDPI2024091700000000000000000000001 type: string requestedAt: description: JDPI request timestamp (UTC). examples: - '2024-10-01T10:00:00Z' type: string requester: description: solCancelamento (0=PSP pagador, 1=PSP recebedor). examples: - 1 format: int64 type: integer requesterDocument: description: Requester CPF/CNPJ (string). examples: - '04623217035' type: string requesterIspb: description: ispbSolicitante (string). examples: - '04358798' type: string requesterType: description: tpPessoaSol. examples: - 0 format: int64 type: integer situationAt: description: Situation timestamp (UTC). examples: - '2024-10-01T10:05:00Z' type: string stJdPi: description: JDPI overall situation. examples: - 9 format: int64 type: integer stJdPiProc: description: JDPI intermediate situation. examples: - 9 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: -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 ````