Pular para o conteúdo principal
GET
/
v1
/
transaction-reports
Listar relatórios de transação
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/transaction-reports \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/transaction-reports"

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-indirect.api.lerian.net/v1/transaction-reports', 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/transaction-reports",
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-indirect.api.lerian.net/v1/transaction-reports"

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

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

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": [
    {
      "amount": "100.50",
      "clientRequestId": "550e8400-e29b-41d4-a716-446655440000",
      "confirmedAt": "2024-01-15T10:32:00Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "creditParty": {
        "account": "123456",
        "accountType": "CACC",
        "bank": "12345678",
        "branch": "0001",
        "document": "12345678901",
        "key": "email@test.com"
      },
      "debitParty": {
        "account": "123456",
        "accountType": "CACC",
        "bank": "12345678",
        "branch": "0001",
        "document": "12345678901",
        "key": "email@test.com"
      },
      "endToEndId": "E12345678202411241430ABCDEFGHIJK",
      "id": "01989f9e-6508-79f8-9540-835be49fbd0d",
      "initiationType": "DICT",
      "pactualId": "550e8400-e29b-41d4-a716-446655440001",
      "returnId": "D12345678202411241430ABCDEFGHIJK",
      "status": "CONFIRMED",
      "submittedAt": "2024-01-15T10:31:00Z",
      "transactionDate": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:32:00Z"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 42
}
{
"code": "<string>",
"title": "<string>",
"message": "<string>"
}
{
"code": "<string>",
"title": "<string>",
"message": "<string>"
}

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de consulta

limit
integer
padrão:10

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

Intervalo obrigatório: 1 <= x <= 100
page
integer
padrão:1

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

Intervalo obrigatório: x >= 1
sort_order
enum<string>
padrão:asc

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

Opções disponíveis:
asc,
desc
end_to_end_id
string

Filtrar pelo identificador end-to-end do PIX

return_identification
string

Filtrar pela identificação de devolução (relatórios de devolução)

initiation_type
enum<string>

Filtrar por tipo de initiation; não diferencia maiúsculas de minúsculas

Opções disponíveis:
MANUAL,
DICT,
STATIC_QRCODE,
DYNAMIC_QRCODE
status
array

Status de transação (separados por vírgula)

created_at_start
string<date-time>

Filtrar por relatórios criados nesta data/hora ou depois dela (RFC3339)

created_at_end
string<date-time>

Filtrar por relatórios criados nesta data/hora ou antes dela (RFC3339)

Resposta

OK

items
object[]

Items contém a lista de relatórios de transação

limit
integer

Limit é o número máximo de itens por página

Exemplo:

10

page
integer

Page é o número da página atual (começando em 1)

Exemplo:

1

total
integer

Total é a contagem total de itens correspondentes

Exemplo:

42