Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.kiwify.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
A única API Pix 100% gratuita do Brasil

O uso da API é totalmente gratuito e ilimitado, você pode gerar QR Codes, receber e enviar pagamentos Pix, consultar transações, tudo com zero custo por transação. Sem pegadinhas.
Para utilizar a API, você deve ter uma conta PJ ativa. Não é possível usar a API com conta PF.

​
URL Base

Todas as requisições da API devem ser feitas para: 
https://conta-public-api.kiwify.com

​
Versionamento da API

A API usa versionamento por caminho na URL. A versão atual é v1. Todos os endpoints versionados são prefixados com /v1/.

​
Formato de Erros

Todos os erros seguem um formato JSON consistente: 
{
  "error": {
    "code": "error_code",
    "message": "Descrição do erro legível",
    "details": {}
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

​
Códigos de Status HTTP Comuns

Status HTTPDescrição
200Sucesso
401Falha na autenticação - assinatura inválida, timestamp expirado ou access ID inválido
403Acesso negado - IP não está na lista de permitidos ou permissões insuficientes
404Recurso não encontrado
500Erro interno do servidor

​
Próximos Passos

Autenticação

Aprenda a autenticar usando EdDSA Proof-of-Possession

Endpoints da API

Explore os endpoints disponíveis da API