Glossário
Termos usados na documentação e no painel.
Chave de API — segredo que autentica a integração, no header X-API-Key. Formato ky_XXXXX-XXXXX-XXXXX; o ambiente (teste ou produção) é definido na criação e não aparece na string.
Cobrança — pedido de pagamento que gera QR Code e código copia e cola.
Copia e cola — a representação em texto do pagamento PIX, colada no aplicativo do banco.
Chave PIX — identificador do destinatário: CPF/CNPJ, e-mail, telefone ou chave aleatória.
Transferência — envio de PIX a partir do seu saldo.
Reembolso — devolução, total ou parcial, de uma cobrança já paga.
Saldo disponível — o que pode ser movimentado agora.
Saldo pendente — recebido, mas ainda não liberado para movimentação.
Extrato — lista de movimentos da conta, entradas e saídas.
Conciliação — cruzamento entre o extrato e os pedidos do seu sistema.
Webhook — chamada HTTP que a KyvoPay faz no seu servidor quando um evento acontece.
Assinatura HMAC — prova de que a entrega do webhook veio da KyvoPay e não foi alterada.
Idempotência — garantia de que repetir a mesma requisição não cria o recurso duas vezes.
external_reference — o ID do seu sistema, guardado junto ao recurso na KyvoPay.
request_id — identificador de uma requisição, presente em toda resposta. É o que o suporte usa para achar o caso.