Cancel a PIX Automatico authorization
Requests the cancellation of a recurring-payment authorization (JDPI 4.3.5) and returns the cancellation id (idCancelamento). The authorization keeps its status, and SPI keeps honouring it, until the counterparty answers: the situacao-cancelamento-autorizacao event cancels it on Aceito and preserves its current status on Rejeitado. Optional ispb names the direct participant this write acts for: named, the recurrence row has to be booked in that participant’s books, 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 recurrence id (29-char, RR...).
"RR0435879820240605njua7shf40o"
Query Parameters
The ISPB of the direct participant this request acts for. OPTIONAL: omit it and the request is answered exactly as before. Named, the recurrence row this write addresses has to be booked in that participant's books, or the answer is 404 PIX-0147 and nothing is sent to JDPI or changed. An ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply, never a credential, and a token confined to one participant has to name it here. Sending it empty (ispb=) reads the same as omitting it.
^[0-9]{8}$"12345678"
Body
Response
OK
The cancellation id (29-char, IC...).
"IC0435879820240605abcd1234567"
When the cancellation was requested (dtHrCancelamento, UTC); the counterparty has not answered yet.
"2024-02-01T10:00:00Z"
The recurrence id.
"RR0435879820240605njua7shf40o"
The local authorization status, unchanged until the counterparty answers the cancellation.
"Active"

