Docs
Acessar painel

Ajuda

Glossário

Os termos usados na documentação e na API.

TermoSignificado
A receberO que a Koku ainda vai repassar a você: pendente + disponível + reserva contratual (to_receive_cents).
BR CodePadrão do Banco Central para o Pix copia e cola e o QR Code. Na API: pix.qr_code_payload.
BrutoValor pago pelo comprador (amount_cents, gross_cents).
CasoRegistro de devolução, contestação (MED), bloqueio ou revisão ligado a uma cobrança.
CentavosUnidade de todos os valores da API. 15990 = R$ 159,90.
Chave de APICredencial secreta do seu servidor para chamar a API. Gerada no painel.
CobrançaPedido de pagamento Pix criado pela API, com QR Code e validade.
Copia e colaTexto do Pix que o comprador cola no aplicativo do banco.
Correlation IDIdentificador de cada requisição (X-Correlation-Id, correlation_id), usado no suporte.
CursorMarcador opaco da próxima página de uma lista (next_cursor).
DisponívelValor 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 webhookURL do seu servidor que recebe os eventos da Koku.
EscopoPermissão de uma chave de API (ex.: charges:write).
EventoFato da sua conta enviado por webhook e consultável pela API (ex.: charge.paid).
ExpiraçãoFim da validade do QR. Depois dela, a cobrança vira expired.
ExtratoLista de lançamentos que movimentaram o seu saldo.
Idempotency-KeyCabeçalho que torna seguro repetir uma chamada sem duplicar o efeito.
LíquidoBruto menos a tarifa da Koku (net_cents).
MEDMecanismo Especial de Devolução do Pix: contestação aberta pelo pagador no banco dele.
Pagamento duplicadoSegundo pagamento do mesmo QR. Fica retido para devolução ao pagador.
Pagamento tardioPagamento feito depois da expiração. A cobrança vira paid com late_payment: true.
PendenteLíquido de vendas pagas ainda não liquidadas e conciliadas (pending_cents).
Rede de processamentoInfraestrutura usada pela Koku para emitir e liquidar o Pix das suas vendas.
RepasseTransferência do seu saldo para a sua conta bancária, feita pela Koku conforme o contrato.
Reserva contratualParte do líquido retida conforme o contrato. Continua sendo sua e é liberada depois.
TarifaValor cobrado pela Koku em cada venda (fee_cents).
txidIdentificador da transação Pix na cobrança (pix.txid).
WebhookChamada HTTP que a Koku faz ao seu servidor para avisar de um evento.