Skip to main content
GET
/
v1
/
qrcodes
/
list
List the PSP's Pix QR codes
curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/qrcodes/list \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/qrcodes/list"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-direct.api.lerian.net/v1/qrcodes/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://plugin-pix-direct.api.lerian.net/v1/qrcodes/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://plugin-pix-direct.api.lerian.net/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))

}
HttpResponse<String> response = Unirest.get("https://plugin-pix-direct.api.lerian.net/v1/qrcodes/list")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/qrcodes/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "consultedAt": "<string>",
  "dynamicQrCodes": [
    {
      "amount": 123,
      "city": "<string>",
      "documentId": "<string>",
      "format": 123,
      "key": "<string>",
      "recipientName": "<string>",
      "status": 123,
      "categoryCode": "<string>",
      "conciliationId": "<string>",
      "description": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "expirationTime": 123,
      "payloadUrl": "<string>",
      "zipCode": "<string>"
    }
  ],
  "staticQrCodes": [
    {
      "amount": 123,
      "city": "<string>",
      "format": 123,
      "key": "<string>",
      "recipientName": "<string>",
      "additionalData": "<string>",
      "bankIdFss": "<string>",
      "categoryCode": "<string>",
      "conciliationId": "<string>",
      "zipCode": "<string>"
    }
  ]
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Query Parameters

qrCodeType
integer<int64>

tpQRCode filter (11=static, 12=immediate dynamic, 13=cobv, 14-17=composite).

startDateTime
string

Window start (dtHrInicial; aaaa-mm-ddTHH:mm:ss.sssZ).

endDateTime
string

Window end (dtHrFinal; aaaa-mm-ddTHH:mm:ss.sssZ; ≤90d from start).

page
integer<int64>

Page number (pagina; default 1).

pageSize
integer<int64>

Page size (tamanhoPagina; default 50, max 100).

Response

OK

consultedAt
string
required

The upstream consult timestamp (upstream timestamp).

dynamicQrCodes
object[] | null

The immediate-dynamic QR codes (qrCodeDinamico).

staticQrCodes
object[] | null

The static QR codes (qrCodeEstatico).