Pular para o conteúdo principal
GET
/
api
/
v1
/
spi
/
pix
Consultar Pix recebidos
curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/spi/pix \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://spi.sandbox.lerian.net/api/v1/spi/pix"

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

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

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

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

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://spi.sandbox.lerian.net/api/v1/spi/pix")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/spi/pix")

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
{
  "parametros": {
    "fim": "<string>",
    "inicio": "<string>",
    "paginacao": {
      "itensPorPagina": 123,
      "paginaAtual": 123,
      "quantidadeDePaginas": 123,
      "quantidadeTotalDeItens": 123
    },
    "cnpj": "<string>",
    "cpf": "<string>",
    "devolucaoPresente": true,
    "txIdPresente": true,
    "txid": "<string>"
  },
  "pix": [
    {
      "endToEndId": "<string>",
      "horario": "<string>",
      "valor": "<string>",
      "devolucoes": [
        {
          "id": "<string>",
          "natureza": "<string>",
          "status": "<string>",
          "valor": "<string>",
          "descricao": "<string>",
          "horario": "<string>",
          "rtrId": "<string>"
        }
      ]
    }
  ]
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

inicio
string<date-time>
obrigatório

Window start, RFC 3339 (required).

fim
string<date-time>
obrigatório

Window end, RFC 3339 (required).

txid
string

Optional txid filter ([a-zA-Z0-9]{1,35}).

Pattern: ^[a-zA-Z0-9]{1,35}$
txIdPresente
enum<string>

Optional tri-state filter on whether the Pix carries a txid (true/false; absent = no filter).

Opções disponíveis:
true,
false
devolucaoPresente
enum<string>

Optional tri-state filter on whether the Pix has returns (true/false; absent = no filter).

Opções disponíveis:
true,
false
cpf
string

Optional payer CPF filter; mutually exclusive with cnpj.

Pattern: ^\d{11}$
cnpj
string

Optional payer CNPJ filter ([0-9A-Z]{12}[0-9]{2} — the BACEN alphanumeric-CNPJ PICnpj facet); mutually exclusive with cpf.

Pattern: ^[0-9A-Z]{12}[0-9]{2}$
paginaAtual
integer<int64>
padrão:1

1-based page number (default 1).

Intervalo obrigatório: x >= 1
itensPorPagina
integer<int64>
padrão:20

Page size (default 20, max 100).

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

Resposta

OK

parametros
object
obrigatório

Echoed query parameters plus pagination metadata.

pix
object[] | null
obrigatório

Received Pix matching the filters, each with its devoluções.