Decode a composite PIX Automatico QR code from its URL
Decodes a composite PIX QR code from its embedded recurrence URL (urlPayloadJsonRec), returning the recurring-payment authorization configuration. Optional ispb makes the decode AS that direct participant.
Call it on the paying side, after the payer scans a composite QR and before the authorization is requested; it reads and changes nothing. JDPI fetches the URL from the server of the institution receiving the payment, so the answer depends on that server as well as on JDPI.
Refusals: 400 PIX-0061 when recurrencePayloadUrl is blank; 422 PIX-1065 when JDPI answered that the payload could not be fetched from the URL’s host — the detail names the host and carries JDPI’s reason, and the failure is that host’s, not JDPI’s, so retrying only helps once the receiving institution serves it; 404 PIX-1005 when JDPI found no payload at the URL; 422 PIX-1047 when JDPI refused the URL; 400 PIX-1001 when what the URL served is not a valid recurrence payload; 503 PIX-1050 when JDPI is unavailable, 503 PIX-1054 when it cannot be reached, and 504 PIX-1051 when it does not answer in time.
Authorizations
JWT bearer token issued by the identity provider.
Body
The recurrence JWS host URL to decode (urlPayloadJsonRec; no scheme).
"pix.example.com/rec/2353c790eefb11eaadc10242ac120004"
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.
^[0-9]{8}$"12345678"
Response
OK
Contract/order identifier (nrContrato).
"1234567890ABC"
The recurrence devedor.
tpFrequencia.
4
The recurrence recebedor.
Unique recurrence id.
"RR0435879820240605njua7shf40o"
retentativa policy.
1
First payment date (aaaa-mm-dd).
"2024-01-10"
Fixed payment amount in centavos.
0
Free-text contract description.
"Conta de energia"
QR creation timestamp.
"2024-11-08T14:24:15.043Z"
Last payment date (aaaa-mm-dd).
"2026-01-10"
Floor amount in centavos (pisoValorMaximo).
55000
QR presentation timestamp (dtHrApresentacao).
"2024-11-10T10:21:34.107Z"
Recurrence status history (atualizacoes).

