Como Funciona o PixGo?
Integre Pix em 3 passos e gere QR Codes em tempo real.
1. Configure Suas Chaves
Após o registro, acesse "Minha Chave API" para duas configurações essenciais:
- Sua API Key PixGo: Chave de 64 caracteres gerada automaticamente no registro e usada para autenticar suas chamadas.
- Sua Chave do Mercado Pago: Você armazena sua `AccessToken` de produção, que é mantida de forma criptografada em nosso banco de dados.
2. Recarregue Seus Créditos
Nosso sistema opera com créditos pré-pagos. Você recarrega um valor (mínimo R$ 10,00) e esse valor é convertido em requisições à API, conforme a tabela de preços.
O processo de recarga gera um Pix para pagamento, e seus créditos são adicionados apenas quando o pagamento é confirmado (via webhook, em um sistema real).
Recarregar3. Chame o Endpoint
Para gerar um Pix, você fará uma chamada simples ao nosso Endpoint único: `/gerar-pix`.
O Input requer: valor, descrição e sua chave do Mercado Pago (implícita, pois já está cadastrada).
O Output retorna: O QR Code em `base64` e o link de pagamento.
Cada chamada bem-sucedida deduz o custo da requisição do seu saldo.
Ver Geração PixDocumentação Técnica da API PixGo
Nossa API foi desenhada para ser RESTful, segura (requer API Key no cabeçalho Authorization) e extremamente simples. Utilize os seguintes endpoints para integrar o Pix ao seu sistema.
Detalhes do Endpoint
Este endpoint é responsável por deduzir os créditos do seu saldo e acionar a API do Mercado Pago (usando sua chave cadastrada) para gerar o QR Code Pix e o link de pagamento.
URL
POST https://pixgo.api.br/gerar-pix
Autenticação (Obrigatória)
Deve ser fornecida no cabeçalho HTTP:
Authorization: Bearer SUA_API_KEY_PIXGO
Corpo da Requisição (JSON)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
valor | Decimal | Sim | Valor total da transação. Formato decimal (ex: 15.50). |
descricao | String | Sim | Descrição da cobrança Pix (Será exibida no extrato do pagador). |
Exemplo de Resposta de Sucesso (HTTP 200)
{
"success": true,
"valor": 15.5,
"descricao": "Pedido de Teste #12345",
"pix_copia_cola": "00020126...",
"qr_code_base64": "data:image/png;base64,iVBORw0GgoA...",
"link_pagamento": "https://checkout.mercadopago.com.br/...",
"external_reference": "PEDIDO_101",
"custo_requisição": 0.02,
"novo_saldo": 9.98
}
Exemplos de Uso
PHP (cURL)
$api_key = 'SUA_API_KEY_PIXGO';
$endpoint = 'https://pixgo.api.br/gerar-pix';
$payload = json_encode([
'valor' => 50.00,
'descricao' => 'Compra de Ebook XYZ'
]);
$ch = curl_init($endpoint);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $api_key,
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
if ($data['success']) {
// Exibe o código Copia e Cola
echo "PIX COPIA E COLA: " . $data['pix_copia_cola'];
} else {
echo "Erro: " . $data['message'];
}
Javascript (Fetch API)
const apiKey = 'SUA_API_KEY_PIXGO';
const endpoint = 'https://pixgo.api.br/gerar-pix';
const payload = {
valor: 15.50,
descricao: 'Serviço de Consultoria'
};
fetch(endpoint, {
method: 'POST',
headers: {
'Authorization': `Bearer ${apiKey}`,
'Content-Type': 'application/json'
},
body: JSON.stringify(payload)
})
.then(response => response.json())
.then(data => {
if (data.success) {
// Usa a base64 para exibir o QR Code
document.getElementById('qrcode-img').src = data.qr_code_base64;
console.log("Link de Pagamento: ", data.link_pagamento);
} else {
console.error('Falha na Geração: ', data.message);
}
})
.catch(error => {
console.error('Erro de Conexão:', error);
});
Python (Requests)
import requests
import json
api_key = 'SUA_API_KEY_PIXGO'
endpoint = 'https://pixgo.api.br/gerar-pix'
headers = {
'Authorization': f'Bearer {api_key}',
'Content-Type': 'application/json'
}
payload = {
'valor': 25.00,
'descricao': 'Doacao Mensal'
}
try:
response = requests.post(endpoint, headers=headers, data=json.dumps(payload))
response.raise_for_status() # Lança exceção para erros HTTP (4xx ou 5xx)
data = response.json()
if data.get('success'):
print(f"PIX gerado. Referência: {data['external_reference']}")
print(f"Novo Saldo: R$ {data['novo_saldo']}")
else:
print(f"Erro na API: {data.get('message', 'Erro desconhecido')}")
except requests.exceptions.RequestException as e:
print(f"Erro de Conexão ou HTTP: {e}")
Detalhes do Endpoint
Utilize este endpoint para verificar o status de uma cobrança Pix específica (registrada na tabela transactions do PixGo [6]).
URL
GET https://pixgo.api.br/consultar-pix?reference=PEDIDO_XXX
Autenticação (Obrigatória)
Deve ser fornecida no cabeçalho HTTP:
Authorization: Bearer SUA_API_KEY_PIXGO
Parâmetros da Query String
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
reference | String | Sim | A referência externa (external_reference, ex: PEDIDO_101) retornada pelo endpoint /gerar-pix. |
Exemplo de Resposta de Sucesso (HTTP 200)
{
"success": true,
"status": "aprovado",
"valor": 15.50,
"descricao": "Serviço de Consultoria",
"data_criacao": "2025-05-15 10:30:00"
}
Possíveis status de retorno: pendente, aprovado, recusado, cancelado, erro.
Exemplos de Uso
PHP (cURL)
$api_key = 'SUA_API_KEY_PIXGO';
$external_reference = 'PEDIDO_101';
$endpoint = 'https://pixgo.api.br/consultar-pix?reference=' . $external_reference;
$ch = curl_init($endpoint);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $api_key
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
if ($data['success']) {
echo "Status da Cobrança ({$external_reference}): " . strtoupper($data['status']);
} else {
echo "Erro ao consultar: " . $data['message'];
}
Javascript (Fetch API)
const apiKey = 'SUA_API_KEY_PIXGO';
const externalReference = 'PEDIDO_101';
const endpoint = `https://pixgo.api.br/consultar-pix?reference=${externalReference}`;
fetch(endpoint, {
method: 'GET',
headers: {
'Authorization': `Bearer ${apiKey}`
}
})
.then(response => response.json())
.then(data => {
if (data.success) {
alert(`Status: ${data.status.toUpperCase()}`);
} else {
console.error('Falha na Consulta: ', data.message);
}
})
.catch(error => {
console.error('Erro de Conexão:', error);
});
Python (Requests)
import requests
api_key = 'SUA_API_KEY_PIXGO'
external_reference = 'PEDIDO_101'
endpoint = 'https://pixgo.api.br/consultar-pix'
headers = {
'Authorization': f'Bearer {api_key}'
}
params = {
'reference': external_reference
}
try:
response = requests.get(endpoint, headers=headers, params=params)
response.raise_for_status()
data = response.json()
if data.get('success'):
print(f"Referência {external_reference} status: {data['status'].upper()}")
else:
print(f"Erro na API: {data.get('message', 'Erro desconhecido')}")
except requests.exceptions.RequestException as e:
print(f"Erro de Conexão ou HTTP: {e}")
Tecnologia e Escalabilidade
O PixGo é desenvolvido usando as tecnologias mais avançadas sem abrir mão da segurança, robustez e confiabilidade para gerenciar clientes e transações. A arquitetura é preparada para futuras integrações (como Stripe e/ou PayPal) e para monitoramento de logs e métricas.
Nossa documentação é clara e voltada para desenvolvedores, permitindo que você gere QR Codes Pix com apenas algumas linhas de código.