Listar los QR Pix del PSP

curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/qrcodes/list \
  --header 'Authorization: Bearer <token>'

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))

}

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"
}

GET

qrcodes

list

Listar los QR Pix del PSP

curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/qrcodes/list \
  --header 'Authorization: Bearer <token>'

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))

}

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"
}

Autorizaciones

Authorization

string

header

requerido

Autenticación con token JWT Bearer. Obtén el token desde el endpoint /v1/login/oauth/access_token usando credenciales de cliente (clientId y clientSecret).

Incluye el token en el encabezado Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

El token expira después de 3600 segundos (1 hora).

Parámetros de consulta

qrCodeType

integer<int64>

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

startDateTime

string

Window start (dtHrInicial; aaaa-mm-ddTHH:mm:ss.sssZ). Inicio de la ventana (dtHrInicial; aaaa-mm-ddTHH:mm:ss.sssZ).

endDateTime

string

Window end (dtHrFinal; aaaa-mm-ddTHH:mm:ss.sssZ; ≤90d from start). Fin de la ventana (dtHrFinal; aaaa-mm-ddTHH:mm:ss.sssZ; ≤90 días desde el inicio).

page

integer<int64>

Page number (pagina; default 1). Número de página (pagina; por defecto 1).

pageSize

integer<int64>

Page size (tamanhoPagina; default 50, max 100). Tamaño de página (tamanhoPagina; por defecto 50, máx. 100).

Respuesta

consultedAt

string

requerido

La marca de tiempo de la consulta al upstream (marca de tiempo del upstream).

dynamicQrCodes

object[] | null

Los QR dinámicos inmediatos (qrCodeDinamico).

Show child attributes

staticQrCodes

object[] | null

Los QR estáticos (qrCodeEstatico).

Show child attributes

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Listar los QR Pix del PSP

Autorizaciones

Parámetros de consulta

Respuesta