curl --request GET \
--url https://api.example.com/v1/qrcodes/list \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/qrcodes/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/qrcodes/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/v1/qrcodes/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"cobvQrCodes": [
{
"city": "Sao Paulo",
"daysAfterDue": 30,
"discount": 200,
"documentId": "52c43361-caa1-4ddb-9152-708426a25db3",
"dueDate": "2026-01-30",
"finalAmount": 10400,
"fine": 400,
"format": 1,
"interest": 300,
"key": "recipient@bank.com",
"originalAmount": 10000,
"payerName": "John Doe",
"rebate": 100,
"recipientName": "Jane Doe",
"recipientStreet": "Rua 1",
"reusable": false,
"state": "SP",
"status": 0,
"zipCode": "01310100",
"categoryCode": "0000",
"conciliationId": "TX-001",
"description": [
{
"name": "order",
"value": "42"
}
],
"payerCnpj": "01234567000199",
"payerCpf": "01234567890",
"payerRequest": "Informe o pedido",
"payloadUrl": "pix.example.com/qr/abc",
"recipientCnpj": "61695227000193",
"recipientCpf": "01234567890",
"recipientTradeName": "Jane ME",
"recurrence": {
"amount": 1050,
"contractNumber": "1234567890ABC",
"debtor": {
"cpfCnpj": "04623217035",
"name": "Ciclano da Silva",
"personType": 0
},
"frequency": 1,
"maxFloorAmount": 55000,
"recipient": {
"cnpj": "61695227000193",
"ispb": "04358798",
"name": "Enel"
},
"recurrenceId": "RR0435879820240605njua7shf40o",
"retryPolicy": 1,
"startDate": "2024-01-10",
"certificateIspb": "04358798",
"contractDescription": "Conta de energia",
"endDate": "2026-01-10",
"jwkUrl": "pix.example.com/jwks",
"payloadUrl": "pix.example.com/qr/abc",
"updates": [
{
"status": 0,
"statusDateTime": "2024-11-08T14:25:49.025Z"
}
]
}
}
],
"consultedAt": "2024-11-26T18:08:49.025Z",
"dynamicQrCodes": [
{
"amount": 10050,
"city": "Sao Paulo",
"documentId": "52c43361-caa1-4ddb-9152-708426a25db3",
"format": 1,
"key": "recipient@bank.com",
"recipientName": "Jane Doe",
"status": 0,
"categoryCode": "0000",
"conciliationId": "TX-001",
"description": [
{
"name": "order",
"value": "42"
}
],
"expirationTime": 3600,
"payloadUrl": "pix.example.com/qr/abc",
"recurrence": {
"amount": 1050,
"contractNumber": "1234567890ABC",
"debtor": {
"cpfCnpj": "04623217035",
"name": "Ciclano da Silva",
"personType": 0
},
"frequency": 1,
"maxFloorAmount": 55000,
"recipient": {
"cnpj": "61695227000193",
"ispb": "04358798",
"name": "Enel"
},
"recurrenceId": "RR0435879820240605njua7shf40o",
"retryPolicy": 1,
"startDate": "2024-01-10",
"certificateIspb": "04358798",
"contractDescription": "Conta de energia",
"endDate": "2026-01-10",
"jwkUrl": "pix.example.com/jwks",
"payloadUrl": "pix.example.com/qr/abc",
"updates": [
{
"status": 0,
"statusDateTime": "2024-11-08T14:25:49.025Z"
}
]
},
"zipCode": "01310100"
}
],
"recurrenceQrCodes": [
{
"amount": 1050,
"city": "Sao Paulo",
"contractNumber": "1234567890ABC",
"debtor": {
"cpfCnpj": "04623217035",
"name": "Ciclano da Silva",
"personType": 0
},
"documentId": "52c43361-caa1-4ddb-9152-708426a25db3",
"format": 1,
"frequency": 4,
"maxFloorAmount": 55000,
"recipient": {
"cnpj": "61695227000193",
"ispb": "04358798",
"name": "Enel"
},
"recurrenceId": "RR0435879820240605njua7shf40o",
"retryPolicy": 1,
"startDate": "2024-01-10",
"certificateIspb": "04358798",
"conciliationId": "TX-001",
"contractDescription": "Conta de energia",
"endDate": "2026-01-10",
"jwkUrl": "pix.example.com/jwks",
"payloadUrl": "pix.example.com/qr/abc",
"updates": [
{
"status": 0,
"statusDateTime": "2024-11-08T14:25:49.025Z"
}
]
}
],
"staticQrCodes": [
{
"amount": 10050,
"city": "Sao Paulo",
"format": 0,
"key": "recipient@bank.com",
"recipientName": "Jane Doe",
"additionalData": "Invoice 42",
"categoryCode": "0000",
"conciliationId": "***",
"ispbFss": "04358798",
"recurrence": {
"amount": 1050,
"contractNumber": "1234567890ABC",
"debtor": {
"cpfCnpj": "04623217035",
"name": "Ciclano da Silva",
"personType": 0
},
"frequency": 1,
"maxFloorAmount": 55000,
"recipient": {
"cnpj": "61695227000193",
"ispb": "04358798",
"name": "Enel"
},
"recurrenceId": "RR0435879820240605njua7shf40o",
"retryPolicy": 1,
"startDate": "2024-01-10",
"certificateIspb": "04358798",
"contractDescription": "Conta de energia",
"endDate": "2026-01-10",
"jwkUrl": "pix.example.com/jwks",
"payloadUrl": "pix.example.com/qr/abc",
"updates": [
{
"status": 0,
"statusDateTime": "2024-11-08T14:25:49.025Z"
}
]
},
"zipCode": "01310100"
}
]
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}List the PSP's PIX QR codes
Lists the PIX QR codes the PSP created (JDPI §8.3.12), filtered by type and a registration window (≤90 days). Returns the static and immediate-dynamic blocks; composite / cobv / recurrence QR codes are out of this context’s scope and not projected.
curl --request GET \
--url https://api.example.com/v1/qrcodes/list \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/qrcodes/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/qrcodes/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/v1/qrcodes/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"cobvQrCodes": [
{
"city": "Sao Paulo",
"daysAfterDue": 30,
"discount": 200,
"documentId": "52c43361-caa1-4ddb-9152-708426a25db3",
"dueDate": "2026-01-30",
"finalAmount": 10400,
"fine": 400,
"format": 1,
"interest": 300,
"key": "recipient@bank.com",
"originalAmount": 10000,
"payerName": "John Doe",
"rebate": 100,
"recipientName": "Jane Doe",
"recipientStreet": "Rua 1",
"reusable": false,
"state": "SP",
"status": 0,
"zipCode": "01310100",
"categoryCode": "0000",
"conciliationId": "TX-001",
"description": [
{
"name": "order",
"value": "42"
}
],
"payerCnpj": "01234567000199",
"payerCpf": "01234567890",
"payerRequest": "Informe o pedido",
"payloadUrl": "pix.example.com/qr/abc",
"recipientCnpj": "61695227000193",
"recipientCpf": "01234567890",
"recipientTradeName": "Jane ME",
"recurrence": {
"amount": 1050,
"contractNumber": "1234567890ABC",
"debtor": {
"cpfCnpj": "04623217035",
"name": "Ciclano da Silva",
"personType": 0
},
"frequency": 1,
"maxFloorAmount": 55000,
"recipient": {
"cnpj": "61695227000193",
"ispb": "04358798",
"name": "Enel"
},
"recurrenceId": "RR0435879820240605njua7shf40o",
"retryPolicy": 1,
"startDate": "2024-01-10",
"certificateIspb": "04358798",
"contractDescription": "Conta de energia",
"endDate": "2026-01-10",
"jwkUrl": "pix.example.com/jwks",
"payloadUrl": "pix.example.com/qr/abc",
"updates": [
{
"status": 0,
"statusDateTime": "2024-11-08T14:25:49.025Z"
}
]
}
}
],
"consultedAt": "2024-11-26T18:08:49.025Z",
"dynamicQrCodes": [
{
"amount": 10050,
"city": "Sao Paulo",
"documentId": "52c43361-caa1-4ddb-9152-708426a25db3",
"format": 1,
"key": "recipient@bank.com",
"recipientName": "Jane Doe",
"status": 0,
"categoryCode": "0000",
"conciliationId": "TX-001",
"description": [
{
"name": "order",
"value": "42"
}
],
"expirationTime": 3600,
"payloadUrl": "pix.example.com/qr/abc",
"recurrence": {
"amount": 1050,
"contractNumber": "1234567890ABC",
"debtor": {
"cpfCnpj": "04623217035",
"name": "Ciclano da Silva",
"personType": 0
},
"frequency": 1,
"maxFloorAmount": 55000,
"recipient": {
"cnpj": "61695227000193",
"ispb": "04358798",
"name": "Enel"
},
"recurrenceId": "RR0435879820240605njua7shf40o",
"retryPolicy": 1,
"startDate": "2024-01-10",
"certificateIspb": "04358798",
"contractDescription": "Conta de energia",
"endDate": "2026-01-10",
"jwkUrl": "pix.example.com/jwks",
"payloadUrl": "pix.example.com/qr/abc",
"updates": [
{
"status": 0,
"statusDateTime": "2024-11-08T14:25:49.025Z"
}
]
},
"zipCode": "01310100"
}
],
"recurrenceQrCodes": [
{
"amount": 1050,
"city": "Sao Paulo",
"contractNumber": "1234567890ABC",
"debtor": {
"cpfCnpj": "04623217035",
"name": "Ciclano da Silva",
"personType": 0
},
"documentId": "52c43361-caa1-4ddb-9152-708426a25db3",
"format": 1,
"frequency": 4,
"maxFloorAmount": 55000,
"recipient": {
"cnpj": "61695227000193",
"ispb": "04358798",
"name": "Enel"
},
"recurrenceId": "RR0435879820240605njua7shf40o",
"retryPolicy": 1,
"startDate": "2024-01-10",
"certificateIspb": "04358798",
"conciliationId": "TX-001",
"contractDescription": "Conta de energia",
"endDate": "2026-01-10",
"jwkUrl": "pix.example.com/jwks",
"payloadUrl": "pix.example.com/qr/abc",
"updates": [
{
"status": 0,
"statusDateTime": "2024-11-08T14:25:49.025Z"
}
]
}
],
"staticQrCodes": [
{
"amount": 10050,
"city": "Sao Paulo",
"format": 0,
"key": "recipient@bank.com",
"recipientName": "Jane Doe",
"additionalData": "Invoice 42",
"categoryCode": "0000",
"conciliationId": "***",
"ispbFss": "04358798",
"recurrence": {
"amount": 1050,
"contractNumber": "1234567890ABC",
"debtor": {
"cpfCnpj": "04623217035",
"name": "Ciclano da Silva",
"personType": 0
},
"frequency": 1,
"maxFloorAmount": 55000,
"recipient": {
"cnpj": "61695227000193",
"ispb": "04358798",
"name": "Enel"
},
"recurrenceId": "RR0435879820240605njua7shf40o",
"retryPolicy": 1,
"startDate": "2024-01-10",
"certificateIspb": "04358798",
"contractDescription": "Conta de energia",
"endDate": "2026-01-10",
"jwkUrl": "pix.example.com/jwks",
"payloadUrl": "pix.example.com/qr/abc",
"updates": [
{
"status": 0,
"statusDateTime": "2024-11-08T14:25:49.025Z"
}
]
},
"zipCode": "01310100"
}
]
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}Authorizations
JWT bearer token issued by the identity provider.
Query Parameters
tpQRCode filter (11=static, 12=immediate dynamic, 13=cobv, 14=recurrence, 15-17=composite). Omit to list every type.
12
Window start (dtHrInicial; aaaa-mm-ddTHH:mm:ss.sssZ).
"2024-10-01T00:00:00.001Z"
Window end (dtHrFinal; aaaa-mm-ddTHH:mm:ss.sssZ; ≤90d from start).
"2024-11-25T23:59:59.999Z"
Page number (pagina; default 1).
1
Page size (tamanhoPagina; default 50, max 100).
100
Response
OK
The due-date dynamic QR codes (qrCodeDinamicoCobv).
Show child attributes
Show child attributes
The JDPI consult timestamp (dtHrJdPi).
"2024-11-26T18:08:49.025Z"
The immediate-dynamic QR codes (qrCodeDinamico).
Show child attributes
Show child attributes
The recurrence-only composite QR codes (qrCodeRecorrencia).
Show child attributes
Show child attributes
The static QR codes (qrCodeEstatico).
Show child attributes
Show child attributes
Was this page helpful?

