INTEGRAÇÃO PIX POR API

Integração Pix para o seu sistema, do QR Code à confirmação.

Automatize cobranças Pix no seu ERP, e-commerce, SaaS ou aplicativo. A API do Calebe Pay cria a cobrança e entrega QR Code e Pix copia e cola; seu sistema acompanha o pagamento por webhook e consulta de status. Pix a partir de R$ 0,50 por recebimento.

API REST
JSON e autenticação por chave
1 min a 24 h
validade configurável do Pix
R$ 0,50
a partir de, por Pix recebido
Teste simulado
sem movimentar dinheiro

PASSO A PASSO

Como fazer uma integração Pix

Conecte o backend do seu produto à API, valide o fluxo em teste e solicite a liberação da conta para cobranças reais.

  1. 01

    Prepare a conta e a chave

    Gere uma chave de teste no portal, com pix:write e transactions:read. Guarde o segredo somente no seu servidor. A API identifica a conta pela chave.

  2. 02

    Crie a cobrança Pix

    Envie POST /v1/pix com valor em centavos, referência do pedido, descrição, dados completos do pagador e validade. Persista o corpo e o Idempotency-Key antes da chamada.

  3. 03

    Apresente os dados de pagamento

    Use pix_qr_code e pix_copy_paste quando disponíveis na resposta. Guarde o ID da transação junto ao pedido. No teste, o payload é simulado e não pode ser pago.

  4. 04

    Confirme pelo backend

    Confira a assinatura do webhook transaction.updated e o estado da transação. Libere um pedido real somente com status paid em produção, nunca pelo comprovante ou retorno do navegador.

EXEMPLO REAL DA API

Exemplo de integração Pix por API

A chamada usa JSON e o cabeçalho X-API-Key. Comece com uma chave de teste; os dados do exemplo são fictícios.

  • 15990 representa R$ 159,90. Telefone e endereço do pagador são obrigatórios.
  • expires_in aceita de 60 a 86.400 segundos; o padrão é 3.600.
  • Em caso de timeout, preserve a chave e o corpo originais e consulte a tentativa. Não crie outra cobrança automaticamente.
Ler a documentação completa ↗
cURLcriar-pix.sh
curl --fail-with-body https://api.calebepay.com.br/v1/pix \
  -H "X-API-Key: $CALEBE_API_KEY" \
  -H "Idempotency-Key: pedido-1042-pix" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 15990,
    "reference": "pedido-1042",
    "description": "Pedido 1042 da loja",
    "expires_in": 3600,
    "customer": {
      "name": "Cliente de demonstração",
      "document": "00000000000",
      "email": "cliente@example.com",
      "phone": "11999998888",
      "address": {
        "zip_code": "01310100", "street": "Avenida Paulista", "number": "1000",
        "district": "Bela Vista", "city": "São Paulo", "state": "SP"
      }
    }
  }'

# Resposta 201: { "data": { "id": "txn_...", "status": "pending",
#   "pix_qr_code": "...", "pix_copy_paste": "000201...", "expires_at": "..." } }

RECURSOS

Recursos para automatizar recebimentos Pix

Da emissão ao acompanhamento, a referência do pedido mantém a cobrança ligada ao seu sistema.

01

QR Code e Pix copia e cola

Use os dados retornados pela API no checkout do seu site ou aplicativo. A resposta também pode trazer a página de pagamento pronta.

02

Webhook de pagamento Pix

Receba eventos assinados quando o status mudar e mantenha consultas limitadas para reconciliar pedidos pendentes.

03

Idempotência na criação

A mesma chave e o mesmo corpo recuperam a tentativa registrada. Um resultado incerto deve ser consultado antes de nova emissão.

04

Validade por cobrança

Defina o prazo do código. Após o vencimento, a atualização para expired depende da confirmação de ausência de pagamento pelo provedor.

05

Teste de pagamento e expiração

Com a chave de teste, simule paid ou expired e valide o tratamento dos eventos sem produzir um Pix pagável.

06

Contas para plataformas

Organize clientes em contas vinculadas, cada uma com sua chave e configuração de cobrança, conforme a estrutura habilitada.

O que é integração Pix e quando usar uma API Pix

Integração Pix conecta a criação de uma cobrança ao pedido que a originou e devolve seu estado ao sistema. Em vez de gerar um código manualmente e conferir comprovantes, a empresa pode emitir a cobrança pelo backend e atualizar o pedido quando o pagamento for confirmado.

No Calebe Pay, essa comunicação usa uma API REST autenticada por chave. A sua aplicação envia o contrato público da Calebe Pay, sem precisar implementar a autenticação ou o formato de cada provedor de pagamento.

Integração Pix para ERP, e-commerce e SaaS

A cobrança deve nascer do fluxo que sua empresa já utiliza. A API permite manter a referência do documento ou pedido em cada transação.

  • ERP e sistema de gestão: associe cada Pix à fatura e atualize o contas a receber após a confirmação.
  • E-commerce: mostre QR Code e copia e cola no checkout, com prazo adequado ao pedido.
  • SaaS e software house: crie cobranças das faturas do seu produto e organize estabelecimentos em contas vinculadas.
  • Aplicativos: conecte o app ao seu backend, que guarda a chave e conversa com a API.

API Pix com Node.js, PHP, Python e outras linguagens

Qualquer backend que envie HTTPS e JSON pode integrar. A documentação reúne exemplos executáveis em Node.js, Python e Go, contrato OpenAPI e orientações para autenticação, webhooks e tratamento dos estados. PHP, Java e C# também podem consumir os mesmos endpoints HTTP.

Uma integração completa precisa tratar pagamento, expiração, repetição de eventos e resposta incerta. O modo de teste permite validar esses caminhos; ele é uma simulação da Calebe Pay. O provedor não oferece sandbox remoto para Pix, e a emissão real exige a conta liberada para produção.

Quanto custa receber Pix pela API

O Calebe Pay oferece Pix a partir de R$ 0,50 por recebimento. As condições dependem do volume, do perfil da operação e da configuração contratada. Consulte as tarifas aplicáveis à sua conta antes de emitir.

Para comparar propostas, considere o número de pagamentos confirmados e o valor médio de cada venda. Uma tarifa fixa e uma tarifa percentual têm impactos diferentes conforme o ticket do negócio.

PERGUNTAS FREQUENTES

Dúvidas sobre integração Pix

Não achou a resposta? Fale com um especialista pelo WhatsApp.

Como integrar Pix ao meu sistema?

Crie uma conta no Calebe Pay, gere uma chave de teste e faça POST /v1/pix pelo seu backend. Guarde a chave de idempotência e o ID da cobrança, apresente os dados retornados e acompanhe o status por webhook e consulta. Para cobrar de verdade, a conta precisa estar liberada para produção.

Preciso de certificado digital para usar a API Pix?

Na API do Calebe Pay, a autenticação da sua aplicação usa X-API-Key por HTTPS. Não é necessário configurar certificado cliente ou mTLS nessa integração.

Como confirmar automaticamente o pagamento de um Pix?

Receba o webhook transaction.updated, valide a assinatura HMAC-SHA256 e confira a transação no backend. Pagamento real exige status paid, livemode true, environment production e simulated false. GET /v1/transactions/{id} consulta o estado persistido.

Posso testar a integração Pix sem dinheiro real?

Sim. Uma chave cp_test_ cria cobranças simuladas e permite simular pagamento ou expiração. O código de teste não é pagável. Esse modo não é um sandbox remoto do provedor e não substitui a liberação da conta para produção.

O que acontece quando o QR Code Pix vence?

A validade é de 1 minuto a 24 horas, com padrão de 1 hora. Depois do prazo, a Calebe Pay verifica se houve pagamento antes de marcar expired. Se a consulta ao provedor estiver indisponível, o status pode continuar pending até a reconciliação.

A integração Pix funciona em WordPress ou WooCommerce?

Um desenvolvedor pode conectar o backend da loja à API REST. Esta oferta é uma integração por API; não pressupõe um plugin oficial pronto para instalar em WordPress, WooCommerce ou outra plataforma.

CADASTRO 100% ONLINE · CERCA DE 6 MINUTOS

Prepare sua operação com o Calebe Pay.

Criar minha conta →Falar com um especialista ↗