Skip to main content
GET
/
v1
/
transactions
/
{transactionId}
Retrieve transaction status
curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/transactions/{transactionId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/transactions/{transactionId}"

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-direct.api.lerian.net/v1/transactions/{transactionId}', 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-direct.api.lerian.net/v1/transactions/{transactionId}",
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-direct.api.lerian.net/v1/transactions/{transactionId}"

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

}
HttpResponse<String> response = Unirest.get("https://plugin-pix-direct.api.lerian.net/v1/transactions/{transactionId}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/transactions/{transactionId}")

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
{
  "id": "txn_123456789",
  "jdpiRequestId": "req_abc123xyz",
  "endToEndId": "E1234567820230615123456789012345",
  "status": "EXECUTED",
  "payer": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "accountId": "019c96a0-0a98-7287-9a31-786e0809c769",
    "bankAccountType": 0,
    "key": "+5511987654321",
    "keyType": 3
  },
  "payee": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "accountId": "019c96a0-0a98-7287-9a31-786e0809c769",
    "bankAccountType": 0,
    "key": "+5511987654321",
    "keyType": 3
  },
  "amount": 100.5,
  "description": "Payment for services"
}

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Path Parameters

transactionId
string
required

Transaction identifier.

Response

Transaction details retrieved successfully

id
string
required

Unique transaction identifier.

Example:

"txn_123456789"

jdpiRequestId
string
required

Upstream request identifier.

Example:

"req_abc123xyz"

endToEndId
string
required

End-to-end transaction identifier.

Example:

"E1234567820230615123456789012345"

status
enum<string>
required

Transaction processing status. String values indicating the current state of a Pix transaction.

Valid values:

  • PENDING = Transaction has been initiated and is awaiting processing by the payment system
  • PENDING_CONFIRM = Transaction is awaiting final confirmation
  • EXECUTED = Transaction successfully completed and funds transferred
  • REVERSAL = Transaction was reversed (refunded)
  • REPROVED = Transaction was rejected or failed validation
  • SCHEDULE = Transaction is scheduled for future execution
  • CANCELLED = Transaction was cancelled by the user before execution
  • ERROR = A processing error occurred during transaction execution
Available options:
PENDING,
PENDING_CONFIRM,
EXECUTED,
REVERSAL,
REPROVED,
SCHEDULE,
CANCELLED,
ERROR
Example:

"EXECUTED"

payer
object
required

Bank account information.

payee
object
required

Bank account information.

amount
number<double>
required

Transaction amount.

Example:

100.5

description
string
required

Transaction description.

Example:

"Payment for services"