Skip to main content
GET
/
v1.1
/
transactions
/
pix
/
{transactionUUID}
Get pix data from a sale
curl --request GET \
  --url https://api.paymee.com.br/v1.1/transactions/pix/{transactionUUID} \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>'
import requests

url = "https://api.paymee.com.br/v1.1/transactions/pix/{transactionUUID}"

headers = {
    "x-api-key": "<x-api-key>",
    "x-api-token": "<x-api-token>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-api-token': '<x-api-token>'}
};

fetch('https://api.paymee.com.br/v1.1/transactions/pix/{transactionUUID}', 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://api.paymee.com.br/v1.1/transactions/pix/{transactionUUID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <x-api-key>",
    "x-api-token: <x-api-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://api.paymee.com.br/v1.1/transactions/pix/{transactionUUID}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("x-api-token", "<x-api-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://api.paymee.com.br/v1.1/transactions/pix/{transactionUUID}")
  .header("x-api-key", "<x-api-key>")
  .header("x-api-token", "<x-api-token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.paymee.com.br/v1.1/transactions/pix/{transactionUUID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-token"] = '<x-api-token>'

response = http.request(request)
puts response.read_body
{
  "status": 0,
  "message": "success",
  "qrCode": {
    "plain": "00020126890014BR.GOV.BCB.PIX2567api-pix.bancobs2.com.br/spi/v2/d4dd5d08-d6ff-4b41-913c-4d9344e9a27c52040000530398654040.015802BR5906PAYMEE6014Belo Horizonte61083038040362070503***63040857",
    "base64": "iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAIAAAAHjs1qAAAGJklEQVR42u3cUW6cQBBF…",
    "url": "https://api.paymee.com.br/resources/payments/pix/qrcode/4ccad173-6206-3b30-a7ce-4ea455040ba1"
  }
}
{
  "errorCount": 1,
  "errors": [
    {
      "error": "Forbidden",
      "message": "Access Denied"
    }
  ],
  "message": "field validation failure",
  "status": -1
}
{
  "status": 998,
  "message": "transaction not found",
  "errorCount": 1,
  "errors": [
    {
      "field": "saleToken",
      "message": "non-existent transaction"
    }
  ]
}

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Path Parameters

​
transactionUUID
string
required

Transaction UUID

Response

success response

​
status
number

Response status code

Example:

0

​
message
string

Response status message

Example:

"success"

​
qrCode
object

PIX QR‑code data