Cancel a Pix Automático schedule
Cancels a scheduled payment instruction, transitioning it to Cancelled and soft-deleting the local row. Returns the cancellation id (idCancelamento).
Authorizations
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).
Path Parameters
The payment-transaction id (32-char).
Body
motivoCancelamento (0..6).
Destination participant ISPB (ispbDestinatario, string).
Receiver conciliation id (idConciliacaoRecebedor).
solCancelamento (0=PSP pagador, 1=PSP recebedor).
Requester CPF/CNPJ (cpfCnpjSolCancelamento, string).
Requester participant ISPB (ispbSolicitante, string).
tpPessoaSol (0=Pessoa Fisica, 1=Pessoa Juridica).
Response
Accepted
Cancellation timestamp (dtHrCancelamento, UTC).
The payment-transaction id (echoed).
The cancellation id (29-char, CA...).
The receiver conciliation id (echoed).
The resulting local schedule status.

