Skip to main content
GET
List the PSP's PIX QR codes

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

qrCodeType
integer<int64>

tpQRCode filter: 11 static, 12 immediate dynamic, 13 dynamic with due date, 14 QRCode Composto, 15-17 QRCode Composto carrying static, immediate-dynamic or due-date data. Omit to list every type.

Example:

12

startDateTime
string<date-time>
required

Window start (dtHrInicial), an RFC 3339 date-time with any offset; milliseconds optional. Sent to JD in UTC as aaaa-mm-ddTHH:mm:ss.sssZ.

Example:

"2024-10-01T00:00:00Z"

endDateTime
string<date-time>
required

Window end (dtHrFinal), an RFC 3339 date-time, not before startDateTime and at most 90 days after it.

Example:

"2024-11-25T23:59:59.999Z"

page
integer<int64>

Page number (pagina; default 1).

Example:

1

pageSize
integer<int64>

Page size (tamanhoPagina): 1-100; omit it for the default of 50. Sent outside 1-100 (0 included) is 400 PIX-0061.

Required range: 1 <= x <= 100
Example:

100

ispb
string

The ISPB of the direct participant whose QR codes are listed. This deployment may act as SEVERAL direct SPI participants - one ISPB each, each with its own customers and its own JDPI credential - and this field is the only thing on the request that says which of them acts. OPTIONAL while it acts as a single participant: omit it and that one acts. REQUIRED once it acts as several - omitted is 422 PIX-0127, and an ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply and guarantee, exactly like payerIspb on a transaction: never a credential, never read from a header or a path, and it never widens what your token can reach. JDPI answers this listing for the participant whose credential signs the call, so reading as another one lists that institution's charges, not yours. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9]{8}$
Example:

"12345678"

Response

OK

cobvQrCodes
object[] | null
required

The due-date dynamic QR codes (qrCodeDinamicoCobv).

consultedAt
string
required

The JDPI consult timestamp (dtHrJdPi).

Example:

"2024-11-26T18:08:49.025Z"

dynamicQrCodes
object[] | null
required

The immediate-dynamic QR codes (qrCodeDinamico).

recurrenceQrCodes
object[] | null
required

The recurrence-only composite QR codes (qrCodeRecorrencia).

staticQrCodes
object[] | null
required

The static QR codes (qrCodeEstatico).