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

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key, max 255 characters.

Path Parameters

idSolicRec
string
required

Identificador da solicitação [a-zA-Z0-9]{29}.

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

Body

application/json
status
enum<string>
required

Status alvo da revisão (apenas CANCELADA).

Available options:
CANCELADA
Example:

"CANCELADA"

Response

Created

atualizacao
object[]
required
calendario
object
required
destinatario
object
required
idRec
string
required
Pattern: ^[a-zA-Z0-9]{29}$
idSolicRec
string
required

Identificador da solicitação.

Pattern: ^[a-zA-Z0-9]{29}$
status
enum<string>
required
Available options:
CRIADA,
ENVIADA,
RECEBIDA,
REJEITADA,
ACEITA,
EXPIRADA,
CANCELADA
recPayload
object