Listar entradas

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/entries', 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-indirect.api.lerian.net/v1/dict/entries",
  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>",
    "X-Account-Id: <x-account-id>"
  ],
]);

$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-indirect.api.lerian.net/v1/dict/entries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	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-indirect.api.lerian.net/v1/dict/entries")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/dict/entries")

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

request = Net::HTTP::Get.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "019c96a0-0c0c-7221-8cf3-13313fb60081",
      "key": "john.doe@example.com",
      "keyType": "EMAIL",
      "status": "ACTIVE",
      "account": {
        "branch": "0001",
        "number": "123456789",
        "participant": "12345678",
        "type": "TRAN"
      },
      "owner": {
        "name": "John Doe",
        "taxIdNumber": "12345678901",
        "type": "NATURAL_PERSON"
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "page": 1,
  "limit": 10
}

GET

dict

entries

Listar entradas

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/entries"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/entries', 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-indirect.api.lerian.net/v1/dict/entries",
  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>",
    "X-Account-Id: <x-account-id>"
  ],
]);

$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-indirect.api.lerian.net/v1/dict/entries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Account-Id", "<x-account-id>")
	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-indirect.api.lerian.net/v1/dict/entries")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/dict/entries")

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

request = Net::HTTP::Get.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "019c96a0-0c0c-7221-8cf3-13313fb60081",
      "key": "john.doe@example.com",
      "keyType": "EMAIL",
      "status": "ACTIVE",
      "account": {
        "branch": "0001",
        "number": "123456789",
        "participant": "12345678",
        "type": "TRAN"
      },
      "owner": {
        "name": "John Doe",
        "taxIdNumber": "12345678901",
        "type": "NATURAL_PERSON"
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "page": 1,
  "limit": 10
}

Autorizações

Authorization

string

header

obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

X-Account-Id

string

obrigatório

Identificador único da Conta do Ledger Midaz (formato UUID).

Parâmetros de consulta

page

integer

padrão:1

Número da página para paginação.

Intervalo obrigatório: x >= 1

limit

integer

padrão:10

Número máximo de itens por página.

Intervalo obrigatório: 1 <= x <= 100

key_type

enum<string>

Filtrar por tipo de chave: CPF, CNPJ, EMAIL, PHONE, EVP.

Opções disponíveis:

CPF,

CNPJ,

EMAIL,

PHONE,

EVP

key_value

string

Filtrar pelo valor da chave (por exemplo, endereço de e-mail ou número de telefone).

entry_id

string

Filtrar pelo ID da entrada (formato UUID).

sort_order

enum<string>

padrão:asc

Direção da ordenação: asc ou desc.

Opções disponíveis:

asc,

desc

Resposta

Lista de entradas Pix recuperada com sucesso.

items

object[]

obrigatório

Show child attributes

page

integer

obrigatório

Número da página atual.

Exemplo:

1

limit

integer

obrigatório

Número de itens por página.

Exemplo:

10

⌘I

Pix — Lerian SPI (mensageria nativa)

Pix — JD (interface, direto)

Pix — BTG (interface, indireto)

TED — Lerian SPB (mensageria nativa)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (mensageria nativa)

Lerian SLC (mensageria nativa)

Lerian STA (mensageria nativa)

Lerian SISBAJUD (mensageria nativa)

Lerian Consignado (mensageria nativa)

Listar entradas

Autorizações

Cabeçalhos

Parâmetros de consulta

Resposta