Skip to main content
PATCH
Revise recurrence (Pix Automático)

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Idempotency key, max 255 characters.

Parâmetros de caminho

idRec
string
obrigatório

Identificador da recorrência [a-zA-Z0-9]{29}.

Pattern: ^[a-zA-Z0-9]{29}$

Corpo

application/json
ativacao
object

Patch da ativação (apenas dadosJornada.txid, somente enquanto status == CRIADA).

calendario
object

Patch do calendário (apenas dataInicial).

cancelamento
object

Detalhe do cancelamento (registrado em encerramento.cancelamento).

loc
integer<int64>

Id da location (locrec) a vincular. Alterável inclusive após a confirmação.

Intervalo obrigatório: x >= 1
status
enum<string>

Novo status da recorrência (CANCELADA cancela o mandato — único destino de status aceito no PATCH, RecRevisada.status v2.9).

Opções disponíveis:
CANCELADA
vinculo
object

Patch do vínculo (apenas devedor.nome).

Resposta

OK

atualizacao
object[]
obrigatório
calendario
object
obrigatório
idRec
string
obrigatório

Identificador da recorrência.

Pattern: ^[a-zA-Z0-9]{29}$
politicaRetentativa
enum<string>
obrigatório
Opções disponíveis:
NAO_PERMITE,
PERMITE_3R_7D
recebedor
object
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
CRIADA,
APROVADA,
REJEITADA,
EXPIRADA,
CANCELADA
vinculo
object
obrigatório
atestacaoTitularidade
object
ativacao
object
encerramento
object
loc
object
solicitacao
object[]
valor
object