List Transaction Reports

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

}

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

GET

transaction-reports

List Transaction Reports

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

}

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

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

integer

default:10

Maximum number of items per page.

Required range: 1 <= x <= 100

page

integer

default:1

Page number for pagination.

Required range: x >= 1

sort_order

enum<string>

default:asc

Sort direction: asc or desc.

Available options:

asc,

desc

end_to_end_id

string

Filter by the PIX end-to-end identifier

return_identification

string

Filter by the return identification (refund reports)

initiation_type

enum<string>

Filter by initiation type; case-insensitive

Available options:

MANUAL,

DICT,

STATIC_QRCODE,

DYNAMIC_QRCODE

status

array

Transaction statuses (comma-separated)

created_at_start

string<date-time>

Filter by reports created on or after this timestamp (RFC3339)

created_at_end

string<date-time>

Filter by reports created on or before this timestamp (RFC3339)

Response

items

object[]

Items contains the list of transaction reports

Show child attributes

limit

integer

Limit is the maximum number of items per page

Example:

10

page

integer

Page is the current page number (1-based)

Example:

1

total

integer

Total is the total count of matching items

Example:

42

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

List Transaction Reports

Authorizations

Query Parameters

Response