Saltar al contenido principal
POST
Decode a composite PIX Automatico QR code from its URL

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json
recurrencePayloadUrl
string
requerido

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

Ejemplo:

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

ispb
string

The ISPB of the direct participant this decode is asked AS. OPTIONAL: omit it and the decode is made on the default credential, exactly as before. Named, JDPI is asked with that participant's credential. An ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply, never a credential, and a token confined to one participant has to name it here.

Pattern: ^[0-9A-Z]{8}$
Ejemplo:

"12345678"

Respuesta

OK

contractNumber
string
requerido

Contract/order identifier (nrContrato).

Ejemplo:

"1234567890ABC"

debtor
object
requerido

The recurrence devedor.

frequency
integer<int64>
requerido

tpFrequencia.

Ejemplo:

4

recipient
object
requerido

The recurrence recebedor.

recurrenceId
string
requerido

Unique recurrence id.

Ejemplo:

"RR0435879820240605njua7shf40o"

retry
integer<int64>
requerido

retentativa policy.

Ejemplo:

1

startDate
string
requerido

First payment date (aaaa-mm-dd).

Ejemplo:

"2024-01-10"

amount
integer<int64>

Fixed payment amount in centavos.

Ejemplo:

0

contractDesc
string

Free-text contract description.

Ejemplo:

"Conta de energia"

createdDateTime
string

QR creation timestamp.

Ejemplo:

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

endDate
string

Last payment date (aaaa-mm-dd).

Ejemplo:

"2026-01-10"

maxFloorAmount
integer<int64>

Floor amount in centavos (pisoValorMaximo).

Ejemplo:

55000

presentedDateTime
string

QR presentation timestamp (dtHrApresentacao).

Ejemplo:

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

updates
object[] | null

Recurrence status history (atualizacoes).