Ajuda
Glossário
Os termos usados na documentação e na API.
| Termo | Significado |
|---|---|
| A receber | O que a Koku ainda vai repassar a você: pendente + disponível + reserva contratual (to_receive_cents). |
| BR Code | Padrão do Banco Central para o Pix copia e cola e o QR Code. Na API: pix.qr_code_payload. |
| Bruto | Valor pago pelo comprador (amount_cents, gross_cents). |
| Caso | Registro de devolução, contestação (MED), bloqueio ou revisão ligado a uma cobrança. |
| Centavos | Unidade de todos os valores da API. 15990 = R$ 159,90. |
| Chave de API | Credencial secreta do seu servidor para chamar a API. Gerada no painel. |
| Cobrança | Pedido de pagamento Pix criado pela API, com QR Code e validade. |
| Copia e cola | Texto do Pix que o comprador cola no aplicativo do banco. |
| Correlation ID | Identificador de cada requisição (X-Correlation-Id, correlation_id), usado no suporte. |
| Cursor | Marcador opaco da próxima página de uma lista (next_cursor). |
| Disponível | Valor liquidado e conciliado, pronto para o repasse (available_cents). |
| E2E (fim a fim) | Identificador único de um Pix no Banco Central (end_to_end_id). |
| Endpoint de webhook | URL do seu servidor que recebe os eventos da Koku. |
| Escopo | Permissão de uma chave de API (ex.: charges:write). |
| Evento | Fato da sua conta enviado por webhook e consultável pela API (ex.: charge.paid). |
| Expiração | Fim da validade do QR. Depois dela, a cobrança vira expired. |
| Extrato | Lista de lançamentos que movimentaram o seu saldo. |
| Idempotency-Key | Cabeçalho que torna seguro repetir uma chamada sem duplicar o efeito. |
| Líquido | Bruto menos a tarifa da Koku (net_cents). |
| MED | Mecanismo Especial de Devolução do Pix: contestação aberta pelo pagador no banco dele. |
| Pagamento duplicado | Segundo pagamento do mesmo QR. Fica retido para devolução ao pagador. |
| Pagamento tardio | Pagamento feito depois da expiração. A cobrança vira paid com late_payment: true. |
| Pendente | Líquido de vendas pagas ainda não liquidadas e conciliadas (pending_cents). |
| Rede de processamento | Infraestrutura usada pela Koku para emitir e liquidar o Pix das suas vendas. |
| Repasse | Transferência do seu saldo para a sua conta bancária, feita pela Koku conforme o contrato. |
| Reserva contratual | Parte do líquido retida conforme o contrato. Continua sendo sua e é liberada depois. |
| Tarifa | Valor cobrado pela Koku em cada venda (fee_cents). |
| txid | Identificador da transação Pix na cobrança (pix.txid). |
| Webhook | Chamada HTTP que a Koku faz ao seu servidor para avisar de um evento. |