Referência da API/Introdução

Visão geral

Base URL, autenticação, formato das respostas e caminhos principais da API KyvoPay.

A API pública da KyvoPay permite criar e acompanhar cobranças Pix, consultar saldo, solicitar saques, reembolsar pagamentos e integrar eventos em tempo real.

Base URL

https://integrate.api.kyvopay.com.br/v1

Todas as rotas documentadas nesta referência usam esse endereço, exceto o WebSocket, que possui endpoint próprio wss://api.kyvopay.com.br/v1/ws.

Autenticação

Crie sua chave em Integrações → Chaves de API e envie em todas as requisições privadas:

X-API-Key: ky_XXXXX-XXXXX-XXXXX
Content-Type: application/json

A empresa é identificada pela chave. Não envie business_id no corpo ou na URL.

Guarde a chave somente no servidor, bot ou worker. Nunca publique uma chave secreta no código do navegador.

Formato das respostas

As rotas REST usam o envelope padrão:

{
  "data": {},
  "error": null,
  "request_id": "req_01HZ8K3M5N"
}

Quando ocorrer um erro, error informa o código e a mensagem para tratamento da integração.

Atualização de pagamentos em tempo real

Você tem duas opções:

Webhook: recomendado para servidores com uma URL HTTPS pública.
WebSocket: recomendado para bots, workers e aplicações sem URL pública.

Receber Pix

Crie uma cobrança e receba o QR Code e o Pix copia e cola.

WebSocket

Receba payment.paid em tempo real sem precisar hospedar um webhook público.

Precisa de ajuda? Fale com o suporte