Listar Devoluções

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

import requests

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

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

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

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-0c53-7a8d-8e29-67971d96d0e3",
      "originalEndToEndId": "E123456789BR1234567890123456789",
      "returnEndToEndId": "D123456789BR1234567890123456789",
      "amount": "100.00",
      "status": "COMPLETED",
      "type": "CASHOUT",
      "description": "Cliente relatou transação não autorizada",
      "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
      "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": {}
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 42
}

GET

refunds

Listar Devoluções

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

import requests

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

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

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

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-0c53-7a8d-8e29-67971d96d0e3",
      "originalEndToEndId": "E123456789BR1234567890123456789",
      "returnEndToEndId": "D123456789BR1234567890123456789",
      "amount": "100.00",
      "status": "COMPLETED",
      "type": "CASHOUT",
      "description": "Cliente relatou transação não autorizada",
      "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
      "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": {}
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 42
}

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

sort_order

enum<string>

padrão:asc

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

Opções disponíveis:

asc,

desc

end_to_end

string

Filtra pelo identificador end-to-end da transferência Pix original.

status

enum<string>

Filtra pelo status da devolução (CREATED, PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED).

Opções disponíveis:

CREATED,

PENDING,

PROCESSING,

COMPLETED,

FAILED,

CANCELLED

type

enum<string>

Filtra pela direção da devolução (CASHOUT ou CASHIN).

Opções disponíveis:

CASHOUT,

CASHIN

modified_after

string

Filtrar por registros modificados após este timestamp (formato RFC3339: 2024-01-15T10:30:00Z).

modified_before

string

Filtrar por registros modificados antes deste timestamp (formato RFC3339: 2024-01-15T10:30:00Z).

Resposta

Lista de devoluções recuperada com sucesso.

items

object[]

Show child attributes

limit

integer

Exemplo:

10

page

integer

Exemplo:

1

total

integer

Exemplo:

42

⌘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 Devoluções

Autorizações

Cabeçalhos

Parâmetros de consulta

Resposta