Primeiros passos

Integre pagamentos PIX, cartão e boleto no seu projeto em minutos. Todas as requisições partem do seu servidor — nunca exponha as chaves no frontend.

1. Obtenha suas chaves de API

Acesse o painel, selecione seu projeto e vá em Configurações > API Keys. Você receberá dois tokens:

Chave Pública

kls_pk_xxxxxxxxxx

Usada nos endpoints PIX (header Authorization: Bearer)

Chave Secreta

kls_sk_xxxxxxxxxx

Usada junto da pública nos endpoints de Transações, Carteira e Saques

Nunca exponha a chave secreta no frontend ou repositórios públicos. Use variáveis de ambiente no servidor.

2. Autenticação

Dependendo do endpoint, a autenticação é feita de duas formas:

Endpoints:PIX

Authorization: Bearer kls_pk_xxx

Endpoints:Transações · Carteira · Saques · Clientes · Cartões

X-Public-Key: kls_pk_xxx
X-Secret-Key: kls_sk_xxx

3. Exemplos rápidos

Consultar saldo

curl -X GET https://seudominio.com/api/v1/wallet/balance \
  -H "X-Public-Key: kls_pk_SUA_CHAVE_PUBLICA" \
  -H "X-Secret-Key: kls_sk_SUA_CHAVE_SECRETA"

Criar cobrança PIX

curl -X POST https://seudominio.com/api/v1/pix/payments \
  -H "Authorization: Bearer kls_pk_SUA_CHAVE_PUBLICA" \
  -H "Content-Type: application/json" \
  -d '{
    "amountCents": 9990,
    "description": "Produto X",
    "client": {
      "name": "Joao Silva",
      "email": "joao@email.com"
    }
  }'

Códigos de resposta HTTP

201Created

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Entity

429Rate Limit

500Internal Server Error

Estrutura de erro padrão

{
  "error": true,
  "code": "slug_do_erro",
  "message": "Descrição legível do erro",
  "status": 400
}