Cancel a single scheduled debit at the payer's request

Cancels ONE scheduled debit at the payer’s request (Guia v1.2 §4.1).

The AUTHORIZATION IS NOT AFFECTED. This stops a single charge; the mandate keeps billing and future cycles are still scheduled. To end the mandate itself — which cascades over every debit scheduled under it — use POST /v1/payer/authorizations//cancel instead. The two are told apart on the wire by the camt.055 reason: SLBD here, CCLD there.

THE WINDOW CLOSES AT MIDNIGHT of the settlement date, in America/Sao_Paulo: the payer may cancel up to 23:59:59 of the day before, and a request at or after 00:00 is refused with PIX-0825. That boundary is where the 00:00-08:00 settlement window opens, so a cancellation admitted past it would race the debit it is trying to stop.

A DEBIT ARISING FROM A POST-DUE RETRY (purpose NTAG) CANNOT BE CANCELLED HERE, at any hour, and is refused with PIX-0826 (Guia v1.2 §5.1): the retry is a collection the payer already authorized, and ending the mandate is the payer’s remedy. The receiving side may still cancel that same charge.

The cancellation is communicated to the receiving PSP by camt.055, raised asynchronously from an obligation written in the same transaction as the cancellation. The payer is notified of the cancellation unconditionally, including when scheduling notifications are disabled.

POST /payer/scheduled-payments/{scheduled_payment_id}/cancel

Cancel a single scheduled debit at the payer's request

cURL

curl --request POST \
  --url https://api.example.com/pixauto/v1/payer/scheduled-payments/{scheduled_payment_id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>'

202

{
  "amount": "149.90",
  "cancelledAt": "2026-09-09T15:00:00Z",
  "counterpartyReason": "SLBD",
  "endToEndId": "E1234567820260810120011a2b3c4d5e",
  "scheduledDate": "2026-09-10",
  "scheduledPaymentId": "0198f3a2-1c4e-7c8b-9d1e-2f3a4b5c6d40",
  "status": "CANCELLED"
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Account-Id · string<uuid> · obrigatório

Non-zero UUID of the payer account selected by the calling PSP. The PSP must authorize its end user for that account before calling this API. A resource outside the selected account returns 404; a read with no records returns an empty page. See the API overview for the complete trust boundary.

Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$

X-Idempotency · string · obrigatório

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. An identical resend within 1 hour returns the original response, status included, with X-Idempotency-Replayed: true. Reusing the key with a divergent method, URL or body is PIX-0031 @ 412. X-Account-Id is part of the compared request too, so replaying one account's key under another account is divergent rather than a replay.

Required string length: 1 - 64

Parâmetros de caminho

scheduled_payment_id · string<uuid> · obrigatório

Internal identifier of the scheduled debit being cancelled. A debit that exists under a DIFFERENT account than X-Account-Id names is answered 404, not 403: the lookup carries the account as a predicate, so this end never learns that a debit exists elsewhere and cannot confirm it.

Exemplo:

"0198f3a2-1c4e-7c8b-9d1e-2f3a4b5c6d40"

Resposta

202

application/json

Scheduled debit cancelled. The camt.055 that tells the counterparty is raised asynchronously from an obligation committed with the cancellation.

amount · string · obrigatório

Amount in BRL that will not be debited, as a decimal string with two places. Money never travels as a number.

Exemplo:

"150.00"

cancelledAt · string<date-time> · obrigatório

Instant the cancellation took effect on this end, in UTC. It is this end's own clock reading, not a value from the request.

Exemplo:

"2026-09-09T15:00:00Z"

counterpartyReason · string · obrigatório

camt.055 motivoDoCancelamento sent to the receiving PSP. Always SLBD on this route — the paying user ended ONE debit. It is never CCLD, which would state that the authorization itself fell.

Exemplo:

"SLBD"

endToEndId · string · obrigatório

BACEN end-to-end identifier of the charge. It is the key the receiving PSP reconciles the camt.055 against; the internal identifier above names nothing the other institution can match.

Exemplo:

"E1234567820260810120011a2b3c4d5e"

scheduledDate · string<date> · obrigatório

Business date the debit would have settled on, as a YYYY-MM-DD calendar date. It is a date and not an instant: there is no time of day and no time zone to interpret.

Exemplo:

"2026-09-10"

scheduledPaymentId · string<uuid> · obrigatório

Internal identifier of the scheduled debit that was cancelled.

Exemplo:

"0198f3a2-1c4e-7c8b-9d1e-2f3a4b5c6d40"

status · string · obrigatório

Lifecycle status the debit now holds. Always CANCELLED on a 202; it is returned rather than assumed so the caller reads a fact.

Exemplo:

"CANCELLED"