Consultar cobrança
curl --request GET \
--url https://api.alphagateway.com.br/v1/pix-in/query/{idempotency} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.alphagateway.com.br/v1/pix-in/query/{idempotency}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.alphagateway.com.br/v1/pix-in/query/{idempotency}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alphagateway.com.br/v1/pix-in/query/{idempotency}",
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: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"message": "Transação PIX consultada com sucesso",
"response": {
"transactionId": "01961234-abcd-7000-8000-000000000001",
"status": "PAID",
"valueRequested": 149.9,
"valueFee": 0.35,
"valueLiquid": 149.55,
"description": "Pedido 1001",
"pix": {
"id": "01961234-abcd-7000-8000-0000000000a1",
"idempotency": "pedido-1001",
"txId": "7f3c9a1e2b4d4c8e9a0b1c2d3e4f5a6b",
"pixCopyPaste": "00020101021226870014br.gov.bcb.pix2565qrcode.exemplo.com.br/cob/7f3c9a1e5204000053039865406149.905802BR5913LOJA EXEMPLO6007CUIABA62070503***6304ABCD",
"endToEndId": "E12345678202610221305abcdefghijk",
"qrcodeExpiresAt": "2026-10-22T14:00:00.000Z",
"completedAt": "2026-10-22T13:05:12.000Z",
"messageError": null
},
"customerRequested": {
"id": "01961234-abcd-7000-8000-0000000000c1",
"fullName": "Maria Oliveira Santos",
"document": "12345678909",
"email": "maria@exemplo.com.br",
"phone": "65999998888"
},
"customerPayer": {
"id": "01961234-abcd-7000-8000-0000000000c2",
"fullName": "Maria Oliveira Santos",
"document": "12345678909",
"email": null,
"phone": null
},
"updatedAt": "2026-10-22T13:05:12.000Z"
}
}{
"response": null,
"errors": [
"O valor da transação deve ser maior ou igual a R$1,00"
]
}{
"response": null,
"errors": [
"API key inválida ou expirada"
]
}{
"response": null,
"errors": [
"Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."
]
}{
"response": null,
"errors": [
"Transação não encontrada"
]
}{
"response": null,
"errors": [
"Limite de requisições excedido"
]
}{
"response": null,
"errors": [
"Erro interno"
]
}{
"response": null,
"errors": [
"Este serviço está temporariamente indisponível devido a manutenção"
]
}Cobranças PIX
Consultar cobrança
Consulta o status e detalhes de uma cobrança PIX utilizando a chave de idempotência.
GET
/
v1
/
pix-in
/
query
/
{idempotency}
Consultar cobrança
curl --request GET \
--url https://api.alphagateway.com.br/v1/pix-in/query/{idempotency} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.alphagateway.com.br/v1/pix-in/query/{idempotency}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.alphagateway.com.br/v1/pix-in/query/{idempotency}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alphagateway.com.br/v1/pix-in/query/{idempotency}",
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: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"message": "Transação PIX consultada com sucesso",
"response": {
"transactionId": "01961234-abcd-7000-8000-000000000001",
"status": "PAID",
"valueRequested": 149.9,
"valueFee": 0.35,
"valueLiquid": 149.55,
"description": "Pedido 1001",
"pix": {
"id": "01961234-abcd-7000-8000-0000000000a1",
"idempotency": "pedido-1001",
"txId": "7f3c9a1e2b4d4c8e9a0b1c2d3e4f5a6b",
"pixCopyPaste": "00020101021226870014br.gov.bcb.pix2565qrcode.exemplo.com.br/cob/7f3c9a1e5204000053039865406149.905802BR5913LOJA EXEMPLO6007CUIABA62070503***6304ABCD",
"endToEndId": "E12345678202610221305abcdefghijk",
"qrcodeExpiresAt": "2026-10-22T14:00:00.000Z",
"completedAt": "2026-10-22T13:05:12.000Z",
"messageError": null
},
"customerRequested": {
"id": "01961234-abcd-7000-8000-0000000000c1",
"fullName": "Maria Oliveira Santos",
"document": "12345678909",
"email": "maria@exemplo.com.br",
"phone": "65999998888"
},
"customerPayer": {
"id": "01961234-abcd-7000-8000-0000000000c2",
"fullName": "Maria Oliveira Santos",
"document": "12345678909",
"email": null,
"phone": null
},
"updatedAt": "2026-10-22T13:05:12.000Z"
}
}{
"response": null,
"errors": [
"O valor da transação deve ser maior ou igual a R$1,00"
]
}{
"response": null,
"errors": [
"API key inválida ou expirada"
]
}{
"response": null,
"errors": [
"Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."
]
}{
"response": null,
"errors": [
"Transação não encontrada"
]
}{
"response": null,
"errors": [
"Limite de requisições excedido"
]
}{
"response": null,
"errors": [
"Erro interno"
]
}{
"response": null,
"errors": [
"Este serviço está temporariamente indisponível devido a manutenção"
]
}Autorizações
API Key da organização
Parâmetros de caminho
Identificador único informado na criação da cobrança.
Minimum string length:
1