Consultar saque
curl --request GET \
--url https://api.alphagateway.com.br/v1/pix-out/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-out/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-out/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-out/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 saque consultada com sucesso",
"response": {
"transactionId": "01961234-abcd-7000-8000-000000000002",
"status": "PAID",
"valueRequested": 250,
"valueFee": 0.35,
"valueLiquid": 250.35,
"description": "Saque para conta da empresa",
"pixOut": {
"id": "01961234-abcd-7000-8000-0000000000b1",
"idempotency": "saque-2001",
"keyPix": "financeiro@exemplo.com.br",
"keyPixType": "EMAIL",
"endToEndId": "E98765432202610221310abcdefghijk",
"completedAt": "2026-10-22T13:10:40.000Z",
"messageError": null
},
"customerRequested": {
"id": "01961234-abcd-7000-8000-0000000000c3",
"fullName": "Exemplo Serviços Ltda",
"document": "11222333000181",
"email": null,
"phone": null
},
"updatedAt": "2026-10-22T13:10:40.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"
]
}Saques
Consultar saque
Consulta o status e detalhes de um saque utilizando a chave de idempotência.
GET
/
v1
/
pix-out
/
query
/
{idempotency}
Consultar saque
curl --request GET \
--url https://api.alphagateway.com.br/v1/pix-out/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-out/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-out/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-out/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 saque consultada com sucesso",
"response": {
"transactionId": "01961234-abcd-7000-8000-000000000002",
"status": "PAID",
"valueRequested": 250,
"valueFee": 0.35,
"valueLiquid": 250.35,
"description": "Saque para conta da empresa",
"pixOut": {
"id": "01961234-abcd-7000-8000-0000000000b1",
"idempotency": "saque-2001",
"keyPix": "financeiro@exemplo.com.br",
"keyPixType": "EMAIL",
"endToEndId": "E98765432202610221310abcdefghijk",
"completedAt": "2026-10-22T13:10:40.000Z",
"messageError": null
},
"customerRequested": {
"id": "01961234-abcd-7000-8000-0000000000c3",
"fullName": "Exemplo Serviços Ltda",
"document": "11222333000181",
"email": null,
"phone": null
},
"updatedAt": "2026-10-22T13:10:40.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 do saque.
Minimum string length:
1