Cancel a PIX Automatico schedule
Requests the cancellation of a scheduled payment instruction (JDPI 4.4.3) and returns the cancellation id (cancellationId). The schedule keeps its status, and SPI keeps settling it, until the counterparty answers: the situacao-cancelamento-agendamento event cancels it on Aceito and preserves its current status on Rejeitado. requesterIspb has to name the participant the schedule row is booked under, or the answer is 404 PIX-0147 before JDPI is asked; an ISPB this deployment does not act as is 422 PIX-0128, before the row is read.
Authorizations
JWT bearer token issued by the identity provider.
Path Parameters
The payment-transaction id (32-char).
"E00038166202409171500y6j6mt9l0pi"
Body
motivoCancelamento (0..6).
0
Destination participant ISPB (ispbDestinatario, string).
"00038166"
Receiver conciliation id (idConciliacaoRecebedor).
"JDPI2024091700000000000000000000001"
solCancelamento (0=payer's PSP, 1=recipient's PSP).
1
Requester CPF/CNPJ (cpfCnpjSolCancelamento, string).
"04623217035"
Requester participant ISPB (string). The schedule row this cancellation signs for has to be booked in this participant's books, or the cancellation is refused 404 PIX-0147 before JDPI is asked; an ISPB this deployment does not act as is 422 PIX-0128.
"04358798"
tpPessoaSol (0=Pessoa Fisica, 1=Pessoa Juridica).
0
Response
Accepted
The cancellation id (29-char, CA...).
"CA0435879820240605abcd1234567"
Cancellation timestamp (dtHrCancelamento, UTC).
"2024-10-01T10:00:00Z"
The payment-transaction id (echoed).
"E00038166202409171500y6j6mt9l0pi"
The receiver conciliation id (echoed).
"JDPI2024091700000000000000000000001"
The local schedule status, unchanged until the counterparty answers the cancellation.
"Accepted"

