Recuperar uma Transferência Pix

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

import requests

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

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/{transfer_id}', 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/{transfer_id}",
  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/{transfer_id}"

	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/{transfer_id}")
  .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/{transfer_id}")

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

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

GET

transfers

{transfer_id}

Recuperar uma Transferência Pix

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

import requests

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

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/{transfer_id}', 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/{transfer_id}",
  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/{transfer_id}"

	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/{transfer_id}")
  .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/{transfer_id}")

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

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

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 caminho

transfer_id

string

obrigatório

Identificador único da transferência Pix (formato UUID).

Resposta

Detalhes da transferência Pix recuperados com sucesso.

string

Identificador único da transferência.

Exemplo:

"019c96a0-0c21-71f9-a487-66a1258278a1"

endToEndId

string

Identificador end-to-end.

Exemplo:

"E123456789BR1234567890123456789"

amount

string

Valor da transferência em BRL (formato 0.00).

Exemplo:

"100.00"

status

enum<string>

Status da transferência.

Opções disponíveis:

CREATED,

PENDING,

PROCESSING,

COMPLETED,

FAILED,

REVERSED

Exemplo:

"COMPLETED"

type

enum<string>

Tipo de transferência.

Opções disponíveis:

CASHOUT,

CASHIN

Exemplo:

"CASHOUT"

description

string

Descrição ou mensagem opcional.

Maximum string length: 140

Exemplo:

"Pix Cashout Transfer"

source

object

Informações da parte da conta (origem ou destino).

Show child attributes

destination

object

Informações da parte da conta (origem ou destino).

Show child attributes

paymentType

enum<string>

Tipo de pagamento.

Opções disponíveis:

IMMEDIATE,

SCHEDULED

Exemplo:

"IMMEDIATE"

initiationType

enum<string>

Tipo de iniciação.

Opções disponíveis:

MANUAL,

KEY,

QR_CODE

Exemplo:

"KEY"

urgency

enum<string>

Urgência da transferência.

Opções disponíveis:

HIGH,

NORMAL

Exemplo:

"HIGH"

purpose

enum<string>

Tipo de finalidade da transação. O padrão é TRANSFER.

Opções disponíveis:

TRANSFER,

INSTANT_PAYMENT_REFUND

Exemplo:

"TRANSFER"

accountId

string

Identificador da conta (UUID).

Exemplo:

"01989f9e-6508-79f8-9540-835be49fbd0d"

aliasId

string

Identificador do alias (UUID).

Exemplo:

"01989f9e-6508-79f8-9540-835be49fbd0e"

initiatedAt

string<date-time>

Timestamp de iniciação (ISO 8601 UTC).

Exemplo:

"2024-01-15T10:30:00Z"

createdAt

string<date-time>

Exemplo:

"2024-01-15T10:30:00Z"

updatedAt

string<date-time>

Exemplo:

"2024-01-15T10:30:00Z"

ledger

object

Identificadores de transação e operação do ledger Midaz.

Show child attributes

metadata

object

Atributos personalizados de chave-valor associados a esta transferência. Máximo de 50 chaves, chave com no máximo 100 caracteres, valor com no máximo 2000 caracteres.

feeCharge

object

Detalhes do cálculo de tarifas (se aplicável).

Show child attributes

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

Recuperar uma Transferência Pix

Autorizações

Cabeçalhos

Parâmetros de caminho

Resposta