Skip to main content
PUT
Update a recurrence-only composite PIX Automatico QR code

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

id
string
required

The recurrence/charge document id (idDocumento, GUID).

Example:

"52c43361-caa1-4ddb-9152-708426a25db3"

Body

application/json
recurrenceStatus
integer<int64>
required

stRecorrencia transition (0=Created,1=Approved,2=Rejected,3=Expired,4=Cancelled).

Example:

1

certificateIspb
string

Indirect-PSP certificate ISPB (ispbCertificadoJws, string).

Example:

"04358798"

debtorName
string

Updated debtor name (devedor.nome).

Example:

"Fulano dos Santos"

jwkUrl
string

New JWK Set URL (urlJwk; no scheme).

Example:

"example.com/jwks"

recurrencePayloadUrl
string

New recurrence JWS host URL (urlPayloadJsonRec; no scheme).

Example:

"pix.example.com/rec/abc"

startDate
string

New first payment date (dtInicialRecorrencia; aaaa-mm-dd).

Example:

"2025-02-10"

txId
string

Conciliation id (idConciliacaoRecebedor).

Example:

"JDPI2024110800000000000000000000002"

Response

OK

qrCode
string
required

The regenerated EMV composite-QR payload (base64-decoded, ready to render).

Example:

"00020126..."

documentId
string

The recurrence/charge document id (idDocumento, GUID).

Example:

"52c43361-caa1-4ddb-9152-708426a25db3"

payloadJws
string

The signed payment JWS (payloadJws; dynamic + cobv).

Example:

"eyJhbGciOiJQUzUxMi..."

recurrencePayload
string

The signed recurrence JWS (payloadJwsRecorrencia).

Example:

"eyJhbGciOiJQUzUxMi..."

revision
integer<int64>

The JDPI-computed charge revision (revisao; dynamic + cobv updates only).

Example:

2