Confido Docs

Início rápido

Da chave de API à primeira venda por Pix, com a consulta do status e o webhook.

1. Crie a chave de API

No painel da Confido, vá em Configurações › Integrações › Chaves de API › Gerar chave:

  1. Escolha os escopos. O padrão (payments:create e payments:read) basta para vender e consultar.
  2. Cadastre o IP público do servidor que vai chamar a API. Sem IP a chave não funciona.
  3. Copie a chave. Ela aparece uma vez só: ch_live_… (produção) ou ch_test_… (teste).

Guarde a chave como segredo do seu servidor (variável de ambiente, cofre de segredos). Ela nunca deve ir para o navegador nem para um aplicativo.

2. Faça uma venda por Pix

curl -X POST https://api.confidoscm.com/api/v1/payments \
  -H "X-API-Key: $CONFIDO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "pix",
    "currency": "BRL",
    "amountCents": 15000,
    "idempotencyKey": "pedido-42",
    "payer": { "name": "Maria da Silva", "document": "52998224725", "email": "maria@exemplo.com" },
    "description": "Pedido 42"
  }'

A resposta (201) traz o QR do Pix e a cobrança criada para a venda:

{
  "data": {
    "payment": {
      "id": "0b6f3c2e-6d1a-4f57-9a0e-2f4d8c9b7a10",
      "publicId": "pay_9f2c4e1a7b3d",
      "status": "pending",
      "method": "pix",
      "currency": "BRL",
      "amountCents": 15000,
      "detail": {
        "qrCode": "00020101021226870014br.gov.bcb.pix…",
        "expiresAt": "2026-11-03T18:30:00Z"
      },
      "livemode": true,
      "chargeId": "5d0a2b9c-3e4f-4a1b-8c7d-6e5f4a3b2c1d",
      "checkoutUrl": "https://checkout.confidoscm.com/c/Xk2pQ9vT"
    }
  },
  "timestamp": "2026-11-03T18:00:00Z"
}

Mostre o detail.qrCode (copia e cola) para o comprador, ou mande o checkoutUrl, a página da Confido onde ele paga e vê o comprovante.

3. Saiba quando foi pago

O jeito certo é o webhook: cadastre uma URL e a Confido avisa com o evento payment.paid.

curl -X POST https://api.confidoscm.com/api/v1/webhook-endpoints \
  -H "X-API-Key: $CONFIDO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://loja.exemplo.com/webhooks/confido", "enabledEvents": ["payment.paid", "payment.declined"] }'

A chave precisa do escopo webhooks:write. Guarde o secret da resposta: é com ele que você confere a assinatura (veja Webhooks).

Para conferir na hora, ou se a resposta da criação se perdeu, consulte o pagamento:

curl https://api.confidoscm.com/api/v1/payments/pay_9f2c4e1a7b3d -H "X-API-Key: $CONFIDO_API_KEY"

4. E se a conexão cair no meio?

Repita a mesma chamada com o mesmo idempotencyKey. Se a venda já tinha sido criada, a Confido devolve a original com 200 e replayed: true, sem cobrar de novo. Veja Idempotência.

Próximos passos