Buscar claves PIX

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/dict/keys/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/keys/search', 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://spi.sandbox.lerian.net/api/v1/dict/keys/search",
  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://spi.sandbox.lerian.net/api/v1/dict/keys/search"

	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://spi.sandbox.lerian.net/api/v1/dict/keys/search")

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

{
  "items": [
    {
      "createdAt": "<string>",
      "id": "<string>",
      "keyType": "<string>",
      "keyValue": "<string>",
      "ownerName": "<string>",
      "ownerTaxId": "<string>",
      "participantISPB": "<string>",
      "status": "<string>",
      "updatedAt": "<string>",
      "accountNumber": "<string>",
      "branch": "<string>",
      "openingDate": "2023-11-07T05:31:56Z",
      "ownerTradeName": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "correlationId": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

GET

api

dict

keys

Buscar claves PIX

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/dict/keys/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://spi.sandbox.lerian.net/api/v1/dict/keys/search', 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://spi.sandbox.lerian.net/api/v1/dict/keys/search",
  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://spi.sandbox.lerian.net/api/v1/dict/keys/search"

	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://spi.sandbox.lerian.net/api/v1/dict/keys/search")

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

{
  "items": [
    {
      "createdAt": "<string>",
      "id": "<string>",
      "keyType": "<string>",
      "keyValue": "<string>",
      "ownerName": "<string>",
      "ownerTaxId": "<string>",
      "participantISPB": "<string>",
      "status": "<string>",
      "updatedAt": "<string>",
      "accountNumber": "<string>",
      "branch": "<string>",
      "openingDate": "2023-11-07T05:31:56Z",
      "ownerTradeName": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "correlationId": "<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

JWT bearer token issued by the identity provider.

Parámetros de consulta

limit

integer<int64>

predeterminado:25

Page size (default 25, max 100)

Rango requerido: 1 <= x <= 100

offset

integer<int64>

predeterminado:0

Page offset (default 0)

Rango requerido: x >= 0

keyType

enum<string>

Filter by PIX key type

Opciones disponibles:

CPF,

CNPJ,

PHONE,

EMAIL,

EVP

status

enum<string>

Filter by key status

Opciones disponibles:

ACTIVE,

INACTIVE,

PENDING_CLAIM,

PENDING_BACEN_SYNC

participantISPB

string

Filter by participant ISPB (8-digit institution code)

Respuesta

items

object[] | null

requerido

PIX keys for the requested limit/offset window.

Show child attributes

limit

integer<int64>

requerido

Effective page size applied to this response.

offset

integer<int64>

requerido

Zero-based offset of the first item in this page.

correlationId

string

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

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

Buscar claves PIX

Autorizaciones

Parámetros de consulta

Respuesta