Documentação

Uma API REST para criar cobranças PIX, acompanhar recebimentos e movimentar seu saldo.

Como funciona

Você cria uma cobrança informando o valor em centavos. A SlimPay devolve um código PIX copia e cola e um QR Code para apresentar ao seu cliente. Quando o pagamento é confirmado, enviamos um evento para o seu webhook e o valor entra no seu saldo a liberar, já com a taxa descontada.

Antes de começar

  1. Crie sua conta e confirme seu e-mail.
  2. Envie seus documentos de verificação. A aprovação é necessária para movimentar dinheiro real.
  3. Gere uma chave de API no painel.

URL base

Todos os endpoints ficam sob /v1. O ambiente é definido pela chave que você usa, não pela URL.

Base URL
https://app.slimpay.com.br/api/v1

Sua primeira cobrança

O exemplo abaixo cria uma cobrança de R$ 149,90. Note que o valor vai em centavos e que o cabeçalho Idempotency-Key é obrigatório em toda requisição que cria ou movimenta dinheiro.

cURL
curl https://app.slimpay.com.br/api/v1/charges \
  -H "Authorization: Bearer ax_sua_chave" \
  -H "Idempotency-Key: pedido-1042" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 14990,
    "description": "Pedido #1042",
    "expires_in": 1800,
    "customer": { "name": "Maria Silva", "tax_id": "12345678909" }
  }'

Resposta

201 Created
{
  "id": "chg_01j9x2m4k8p3q7r5t1v6w8y0",
  "status": "awaiting_payment",
  "amount": 14990,
  "fee_amount": 373,
  "net_amount": 14617,
  "brcode": "00020126580014br.gov.bcb.pix...",
  "qrcode_url": "https://app.slimpay.com.br/api/v1/charges/chg_.../qrcode.png",
  "expires_at": "2026-07-25T15:30:00Z",
  "created_at": "2026-07-25T14:30:00Z"
}

Apresente brcode como texto copia e cola, ou renderize qrcode_url como imagem. Não fique consultando o status em loop: assine o evento charge.paid e reaja a ele.

Próximos passos