Consultar pagamento Pix por QR Code
curl --request GET \
--url http://localhost:3030/v1/payouts/pix-qr/{paymentId} \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'import requests
url = "http://localhost:3030/v1/payouts/pix-qr/{paymentId}"
headers = {
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-client-id': '<api-key>', 'x-client-secret': '<api-key>'}
};
fetch('http://localhost:3030/v1/payouts/pix-qr/{paymentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3030",
CURLOPT_URL => "http://localhost:3030/v1/payouts/pix-qr/{paymentId}",
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-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);
$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 := "http://localhost:3030/v1/payouts/pix-qr/{paymentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3030/v1/payouts/pix-qr/{paymentId}")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3030/v1/payouts/pix-qr/{paymentId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"paymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "QUEUED",
"amountCents": 1,
"feeCents": 1,
"totalDebitedCents": 1,
"currency": "BRL",
"endToEndId": "<string>",
"failureCode": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Payouts
Consultar pagamento por QR Pix
Consulta o estado público e os dados de conciliação de um pagamento por QR Pix.
GET
/
v1
/
payouts
/
pix-qr
/
{paymentId}
Consultar pagamento Pix por QR Code
curl --request GET \
--url http://localhost:3030/v1/payouts/pix-qr/{paymentId} \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'import requests
url = "http://localhost:3030/v1/payouts/pix-qr/{paymentId}"
headers = {
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-client-id': '<api-key>', 'x-client-secret': '<api-key>'}
};
fetch('http://localhost:3030/v1/payouts/pix-qr/{paymentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3030",
CURLOPT_URL => "http://localhost:3030/v1/payouts/pix-qr/{paymentId}",
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-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);
$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 := "http://localhost:3030/v1/payouts/pix-qr/{paymentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3030/v1/payouts/pix-qr/{paymentId}")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3030/v1/payouts/pix-qr/{paymentId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"paymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "QUEUED",
"amountCents": 1,
"feeCents": 1,
"totalDebitedCents": 1,
"currency": "BRL",
"endToEndId": "<string>",
"failureCode": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Caso de uso
Use esta operação para acompanhar um pagamento iniciado por Solicitar pagamento por QR Pix.Autenticação
x-client-idx-client-secret- Escopo
payout:read
Request
paymentId(path): UUID retornado ao solicitar o pagamento.
Resposta
Em200, a API retorna paymentId, status, amountCents, feeCents, totalDebitedCents, currency, endToEndId e failureCode. endToEndId e failureCode podem ser null. currency é sempre BRL. Quando status é FAILED, failureCode é PIX_QR_PAYMENT_FAILED.
Os estados públicos são QUEUED, PROCESSING, RECONCILIATION_REQUIRED, COMPLETED e FAILED. A consulta é restrita ao merchant autenticado. Um paymentId inexistente ou pertencente a outro merchant retorna 404.
Próximos passos
- Para iniciar um pagamento, siga o fluxo em Pagar com QR Pix.
- Use o
endToEndIdretornado quando disponível para conciliação.
Authorizations
Headers
Response
Default Response
Last modified on November 12, 2026