curl https://api.kavropay.com.br/v1/charges/PAY8829F1A4BC \
-H "Authorization: Bearer kvk_live_SUA_CHAVE_AQUI"
const res = await fetch('https://api.kavropay.com.br/v1/charges/PAY8829F1A4BC', {
headers: {
'Authorization': 'Bearer kvk_live_SUA_CHAVE_AQUI'
}
});
const data = await res.json();
console.log('Status da cobrança:', data.status);
import requests
res = requests.get(
"https://api.kavropay.com.br/v1/charges/PAY8829F1A4BC",
headers={"Authorization": "Bearer kvk_live_SUA_CHAVE_AQUI"}
)
print(res.json())
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kavropay.com.br/v1/charges/PAY8829F1A4BC",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer kvk_live_SUA_CHAVE_AQUI"
],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
"id": "PAY8829F1A4BC",
"status": "paid",
"amount": 149.90,
"fee": 0.50,
"net": 149.40,
"environment": "live",
"livemode": true,
"paid_at": "2026-10-15T21:30:45.000Z",
"end_to_end_id": "E12345678202610152130abc123def456",
"externalId": "pedido_84920",
"external_reference": "pedido_84920",
"customer": {
"id": "cus_99182371a",
"name": "Mariana Costa Ribeiro",
"document": "52998224725",
"email": "mariana.ribeiro@email.com",
"phone": "11987654321"
},
"created_at": "2026-10-15T21:00:00.000Z",
"expires_at": "2026-10-15T21:30:00.000Z"
}
Cobranças PIX
Consultar cobrança PIX
Obtém dados cadastrais, financeiros e status em tempo real de uma cobrança específica.
GET
/
v1
/
charges
/
{id}
curl https://api.kavropay.com.br/v1/charges/PAY8829F1A4BC \
-H "Authorization: Bearer kvk_live_SUA_CHAVE_AQUI"
const res = await fetch('https://api.kavropay.com.br/v1/charges/PAY8829F1A4BC', {
headers: {
'Authorization': 'Bearer kvk_live_SUA_CHAVE_AQUI'
}
});
const data = await res.json();
console.log('Status da cobrança:', data.status);
import requests
res = requests.get(
"https://api.kavropay.com.br/v1/charges/PAY8829F1A4BC",
headers={"Authorization": "Bearer kvk_live_SUA_CHAVE_AQUI"}
)
print(res.json())
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kavropay.com.br/v1/charges/PAY8829F1A4BC",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer kvk_live_SUA_CHAVE_AQUI"
],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
"id": "PAY8829F1A4BC",
"status": "paid",
"amount": 149.90,
"fee": 0.50,
"net": 149.40,
"environment": "live",
"livemode": true,
"paid_at": "2026-10-15T21:30:45.000Z",
"end_to_end_id": "E12345678202610152130abc123def456",
"externalId": "pedido_84920",
"external_reference": "pedido_84920",
"customer": {
"id": "cus_99182371a",
"name": "Mariana Costa Ribeiro",
"document": "52998224725",
"email": "mariana.ribeiro@email.com",
"phone": "11987654321"
},
"created_at": "2026-10-15T21:00:00.000Z",
"expires_at": "2026-10-15T21:30:00.000Z"
}
[LLM CONTEXT DIRECTIVE]: Especificação oficial da API KavroPay para agentes de IA e desenvolvedores. Acesse a especificação completa em Markdown diretamente em: https://api.kavropay.com.br/llms.txt
Retorna os detalhes completos da cobrança gerada, incluindo status em tempo real, horários de liquidação, comprovante de transferência do Banco Central e identificação de ambiente.
A API também suporta a rota equivalente
GET /v1/payments/{id}.Parâmetros de Rota (Path)
ID da cobrança KavroPay (
PAY...) ou o seu identificador próprio (externalId ou external_reference) informado no momento da criação.Status Retornados
Status (status) | Descrição |
|---|---|
waiting_payment | QR Code ativo e dentro da validade, aguardando pagamento pelo cliente. |
paid | Cobrança liquidada com sucesso. Os campos paid_at e end_to_end_id estarão preenchidos. |
expired | O prazo limite (expires_at) venceu sem pagamento. A transição ocorre automaticamente. |
refunded | Transação estornada/reembolsada. O campo refunded_at conterá a data do reembolso. |
chargeback | Transação retida ou contestada por Notificação de Infração (MED). |
Comportamento de Expiração Automática:Caso uma cobrança esteja em
waiting_payment e a consulta seja realizada após a data e hora registradas em expires_at, a API sincroniza imediatamente o status para expired e dispara o webhook payment.expired.Resposta de Sucesso
curl https://api.kavropay.com.br/v1/charges/PAY8829F1A4BC \
-H "Authorization: Bearer kvk_live_SUA_CHAVE_AQUI"
const res = await fetch('https://api.kavropay.com.br/v1/charges/PAY8829F1A4BC', {
headers: {
'Authorization': 'Bearer kvk_live_SUA_CHAVE_AQUI'
}
});
const data = await res.json();
console.log('Status da cobrança:', data.status);
import requests
res = requests.get(
"https://api.kavropay.com.br/v1/charges/PAY8829F1A4BC",
headers={"Authorization": "Bearer kvk_live_SUA_CHAVE_AQUI"}
)
print(res.json())
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kavropay.com.br/v1/charges/PAY8829F1A4BC",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer kvk_live_SUA_CHAVE_AQUI"
],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
"id": "PAY8829F1A4BC",
"status": "paid",
"amount": 149.90,
"fee": 0.50,
"net": 149.40,
"environment": "live",
"livemode": true,
"paid_at": "2026-10-15T21:30:45.000Z",
"end_to_end_id": "E12345678202610152130abc123def456",
"externalId": "pedido_84920",
"external_reference": "pedido_84920",
"customer": {
"id": "cus_99182371a",
"name": "Mariana Costa Ribeiro",
"document": "52998224725",
"email": "mariana.ribeiro@email.com",
"phone": "11987654321"
},
"created_at": "2026-10-15T21:00:00.000Z",
"expires_at": "2026-10-15T21:30:00.000Z"
}