Skip to main content
POST
Decode a composite PIX Automatico QR code from its URL

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json
recurrencePayloadUrl
string
obrigatório

The recurrence JWS host URL to decode (urlPayloadJsonRec; no scheme).

Exemplo:

"pix.example.com/rec/2353c790eefb11eaadc10242ac120004"

Resposta

OK

contractNumber
string
obrigatório

Contract/order identifier (nrContrato).

Exemplo:

"1234567890ABC"

debtor
object
obrigatório

The recurrence devedor.

frequency
integer<int64>
obrigatório

tpFrequencia.

Exemplo:

4

recipient
object
obrigatório

The recurrence recebedor.

recurrenceId
string
obrigatório

Unique recurrence id.

Exemplo:

"RR0435879820240605njua7shf40o"

retry
integer<int64>
obrigatório

retentativa policy.

Exemplo:

1

startDate
string
obrigatório

First payment date (aaaa-mm-dd).

Exemplo:

"2024-01-10"

amount
integer<int64>

Fixed payment amount in centavos.

Exemplo:

0

contractDesc
string

Free-text contract description.

Exemplo:

"Conta de energia"

createdDateTime
string

QR creation timestamp (dtHrCriacao).

Exemplo:

"2024-11-08T14:24:15.043Z"

endDate
string

Last payment date (aaaa-mm-dd).

Exemplo:

"2026-01-10"

maxFloorAmount
integer<int64>

Floor amount in centavos (pisoValorMaximo).

Exemplo:

55000

presentedDateTime
string

QR presentation timestamp (dtHrApresentacao).

Exemplo:

"2024-11-10T10:21:34.107Z"

updates
object[] | null

Recurrence status history (atualizacoes).