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

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
recurrencePayloadUrl
string
required

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

Example:

"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-9]{8}$
Example:

"12345678"

Response

OK

contractNumber
string
required

Contract/order identifier (nrContrato).

Example:

"1234567890ABC"

debtor
object
required

The recurrence devedor.

frequency
integer<int64>
required

tpFrequencia.

Example:

4

recipient
object
required

The recurrence recebedor.

recurrenceId
string
required

Unique recurrence id.

Example:

"RR0435879820240605njua7shf40o"

retry
integer<int64>
required

retentativa policy.

Example:

1

startDate
string
required

First payment date (aaaa-mm-dd).

Example:

"2024-01-10"

amount
integer<int64>

Fixed payment amount in centavos.

Example:

0

contractDesc
string

Free-text contract description.

Example:

"Conta de energia"

createdDateTime
string

QR creation timestamp.

Example:

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

endDate
string

Last payment date (aaaa-mm-dd).

Example:

"2026-01-10"

maxFloorAmount
integer<int64>

Floor amount in centavos (pisoValorMaximo).

Example:

55000

presentedDateTime
string

QR presentation timestamp (dtHrApresentacao).

Example:

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

updates
object[] | null

Recurrence status history (atualizacoes).