List Pix Transfers

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

import requests

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

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/transfers', 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/transfers",
  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/transfers"

	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/transfers")
  .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/transfers")

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-0c21-71f9-a487-66a1258278a1",
      "endToEndId": "E123456789BR1234567890123456789",
      "amount": "100.00",
      "status": "COMPLETED",
      "type": "CASHOUT",
      "description": "Pix Cashout Transfer",
      "source": {
        "key": "john.doe@example.com",
        "account": {
          "branch": "0001",
          "number": "123456789",
          "participant": "12345678",
          "type": "CACC"
        },
        "owner": {
          "document": "12345678901",
          "name": "John Doe",
          "tradeName": "John's Business",
          "type": "NATURAL_PERSON"
        }
      },
      "destination": {
        "key": "john.doe@example.com",
        "account": {
          "branch": "0001",
          "number": "123456789",
          "participant": "12345678",
          "type": "CACC"
        },
        "owner": {
          "document": "12345678901",
          "name": "John Doe",
          "tradeName": "John's Business",
          "type": "NATURAL_PERSON"
        }
      },
      "paymentType": "IMMEDIATE",
      "initiationType": "KEY",
      "urgency": "HIGH",
      "purpose": "TRANSFER",
      "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
      "aliasId": "01989f9e-6508-79f8-9540-835be49fbd0e",
      "initiatedAt": "2024-01-15T10:30:00Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "ledger": {
        "transactionId": "550e8400-e29b-41d4-a716-446655440011",
        "sourceOperationId": "550e8400-e29b-41d4-a716-446655440012",
        "destinationOperationId": "550e8400-e29b-41d4-a716-446655440013",
        "revert": {
          "transactionId": "550e8400-e29b-41d4-a716-446655440014",
          "sourceOperationId": "550e8400-e29b-41d4-a716-446655440015",
          "destinationOperationId": "550e8400-e29b-41d4-a716-446655440016"
        }
      },
      "metadata": {},
      "feeCharge": {
        "applied": true,
        "calculationType": "segment",
        "totalAmount": "2.50",
        "netAmount": "97.50",
        "fees": [
          {
            "feeLabel": "PIX_FEE",
            "amount": "1.50",
            "creditAccount": "01989f9e-6508-79f8-9540-835be49fbd0d",
            "calculationType": "PERCENTAGE",
            "calculationValue": "1.5"
          }
        ]
      }
    }
  ],
  "limit": 10,
  "offset": 0
}

GET

transfers

List Pix Transfers

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

import requests

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

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/transfers', 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/transfers",
  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/transfers"

	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/transfers")
  .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/transfers")

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-0c21-71f9-a487-66a1258278a1",
      "endToEndId": "E123456789BR1234567890123456789",
      "amount": "100.00",
      "status": "COMPLETED",
      "type": "CASHOUT",
      "description": "Pix Cashout Transfer",
      "source": {
        "key": "john.doe@example.com",
        "account": {
          "branch": "0001",
          "number": "123456789",
          "participant": "12345678",
          "type": "CACC"
        },
        "owner": {
          "document": "12345678901",
          "name": "John Doe",
          "tradeName": "John's Business",
          "type": "NATURAL_PERSON"
        }
      },
      "destination": {
        "key": "john.doe@example.com",
        "account": {
          "branch": "0001",
          "number": "123456789",
          "participant": "12345678",
          "type": "CACC"
        },
        "owner": {
          "document": "12345678901",
          "name": "John Doe",
          "tradeName": "John's Business",
          "type": "NATURAL_PERSON"
        }
      },
      "paymentType": "IMMEDIATE",
      "initiationType": "KEY",
      "urgency": "HIGH",
      "purpose": "TRANSFER",
      "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
      "aliasId": "01989f9e-6508-79f8-9540-835be49fbd0e",
      "initiatedAt": "2024-01-15T10:30:00Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "ledger": {
        "transactionId": "550e8400-e29b-41d4-a716-446655440011",
        "sourceOperationId": "550e8400-e29b-41d4-a716-446655440012",
        "destinationOperationId": "550e8400-e29b-41d4-a716-446655440013",
        "revert": {
          "transactionId": "550e8400-e29b-41d4-a716-446655440014",
          "sourceOperationId": "550e8400-e29b-41d4-a716-446655440015",
          "destinationOperationId": "550e8400-e29b-41d4-a716-446655440016"
        }
      },
      "metadata": {},
      "feeCharge": {
        "applied": true,
        "calculationType": "segment",
        "totalAmount": "2.50",
        "netAmount": "97.50",
        "fees": [
          {
            "feeLabel": "PIX_FEE",
            "amount": "1.50",
            "creditAccount": "01989f9e-6508-79f8-9540-835be49fbd0d",
            "calculationType": "PERCENTAGE",
            "calculationValue": "1.5"
          }
        ]
      }
    }
  ],
  "limit": 10,
  "offset": 0
}

Authorizations

Authorization

string

header

required

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

Headers

X-Account-Id

string

required

Unique identifier of the Midaz Ledger Account (UUID format).

Query Parameters

limit

integer

default:10

Maximum number of items per page.

Required range: 1 <= x <= 100

offset

integer

default:0

The number of items to skip before starting to collect the result set.

sort_order

enum<string>

default:asc

Sort direction: asc or desc.

Available options:

asc,

desc

end_to_end

string

Filter by the Pix transfer end-to-end identifier.

status

enum<string>

Filter by the transfer status (CREATED, PENDING, PROCESSING, COMPLETED, FAILED, REVERSED).

Available options:

CREATED,

PENDING,

PROCESSING,

COMPLETED,

FAILED,

REVERSED

type

enum<string>

Filter by transfer direction (CASHOUT or CASHIN).

Available options:

CASHOUT,

CASHIN

modified_after

string

Filter by records modified after this timestamp (RFC3339 format: 2024-01-15T10:30:00Z).

modified_before

string

Filter by records modified before this timestamp (RFC3339 format: 2024-01-15T10:30:00Z).

Response

List of Pix transfers retrieved successfully.

items

object[]

Show child attributes

limit

integer

Example:

10

offset

integer

Example:

0

⌘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 Pix Transfers

Authorizations

Headers

Query Parameters

Response