Pular para o conteúdo principal
POST
Cancel a recurring series

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

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. Replaying the same key with a divergent method, URL or body is PIX-0031 @ 412.

Required string length: 1 - 64

Parâmetros de caminho

recurrence_id
string<uuid>
obrigatório

Series identifier.

Exemplo:

"01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0"

Resposta

OK

cancelledOccurrences
integer<int64>
obrigatório

How many occurrences this request moved to CANCELLED. It counts ONLY the ones that were still PENDING, and it is the row count of the write itself rather than a census taken beforehand.

Exemplo:

5

recurrenceId
string
obrigatório

The series that was stopped.

Exemplo:

"01a0d8fb-1a8b-7a10-b3c4-d5e6f7a8b9c0"

skippedOccurrences
integer<int64>
obrigatório

How many materialized occurrences this request did not change, because they were not PENDING. Together with cancelledOccurrences it accounts for every occurrence the series had.

Exemplo:

1

status
enum<string>
obrigatório

The series' status after the operation. Always CANCELLED on a 200 -- a series that could not be stopped answers PIX-0765 instead of reporting an unchanged status.

Opções disponíveis:
ACTIVE,
COMPLETED,
CANCELLED
Exemplo:

"CANCELLED"