Retrieve a Pix Transfer

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}

Retrieve a Pix Transfer

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

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

Path Parameters

transfer_id

string

required

Unique identifier of the Pix transfer (UUID format).

Response

Pix transfer details retrieved successfully.

string

Transfer unique identifier.

Example:

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

endToEndId

string

End-to-end identifier.

Example:

"E123456789BR1234567890123456789"

amount

string

Transfer amount in BRL (format 0.00).

Example:

"100.00"

status

enum<string>

Transfer status.

Available options:

CREATED,

PENDING,

PROCESSING,

COMPLETED,

FAILED,

REVERSED

Example:

"COMPLETED"

type

enum<string>

Transfer type.

Available options:

CASHOUT,

CASHIN

Example:

"CASHOUT"

description

string

Optional description or message.

Maximum string length: 140

Example:

"Pix Cashout Transfer"

source

object

Account party (source or destination) information.

Show child attributes

destination

object

Account party (source or destination) information.

Show child attributes

paymentType

enum<string>

Payment type.

Available options:

IMMEDIATE,

SCHEDULED

Example:

"IMMEDIATE"

initiationType

enum<string>

Initiation type.

Available options:

MANUAL,

KEY,

QR_CODE

Example:

"KEY"

urgency

enum<string>

Transfer urgency.

Available options:

HIGH,

NORMAL

Example:

"HIGH"

purpose

enum<string>

Transaction purpose type. Defaults to TRANSFER.

Available options:

TRANSFER,

INSTANT_PAYMENT_REFUND

Example:

"TRANSFER"

accountId

string

Account identifier (UUID).

Example:

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

aliasId

string

Alias identifier (UUID).

Example:

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

initiatedAt

string<date-time>

Initiation timestamp (ISO 8601 UTC).

Example:

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

createdAt

string<date-time>

Example:

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

updatedAt

string<date-time>

Example:

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

ledger

object

Midaz ledger transaction and operation identifiers.

Show child attributes

metadata

object

Custom key-value attributes associated with this transfer. Maximum 50 keys, key max 100 chars, value max 2000 chars.

feeCharge

object

Fee calculation details (if applicable).

Show child attributes

Refund a Received Pix Transfer

Unblock a Pix Refund

⌘I

Lerian SPB

Lerian SPI

Lerian SILOC

Lerian SLC

Lerian STA

Lerian SISBAJUD

Lerian Consignado

Pix — Direct via JD

Pix — Indirect via BTG

TED — via JD

Payments — via BTG

Retrieve a Pix Transfer

Authorizations

Headers

Path Parameters

Response