Introdução
O que é a API da KyvoPay, formato das respostas e ambientes.
Visão geral#
A API da KyvoPay é REST, aceita e devolve JSON e usa os verbos HTTP padrão. Todos os valores em dinheiro são inteiros em centavos — 12990 é R$ 129,90. Nunca há ponto flutuante em campos financeiros.
Toda resposta usa o mesmo envelope: data com o resultado, error com o detalhe da falha (ou null) e request_id, que identifica a requisição nos nossos registros e nos seus.
URL base#
Produção e sandbox usam a mesma URL. O que separa os ambientes é o prefixo da chave de API.
https://api.kyvopay.com.brVai integrar usando IA?
Baixe o llms.txt com Pix, transferência Pix, webhooks e exemplos prontos para IA.
{
"data": { "id": "pay_3Kq8Zx91", "status": "pending" },
"error": null,
"request_id": "req_7f2c9a10"
}Ambientes#
O sandbox é isolado: cobranças criadas ali não movimentam dinheiro real e não aparecem no seu saldo de produção. Use-o à vontade para desenvolver e testar.
| Prefixo | Ambiente | Disponível |
|---|---|---|
kyvo_test_ | Sandbox | Assim que a conta é criada |
kyvo_live_ | Produção | Disponível; o perfil da conta define taxas, limites e recursos |
Comece pelo sandbox
kyvo_test_ e desenvolva. A verificação só é necessária para receber de verdade.curl https://api.kyvopay.com.br/v1/balance \
-H "X-API-Key: kyvo_test_..."