DESENVOLVEDORES

API Pix para conectar seu produto à Hodle

API Pix é a integração que conecta seu software a recebimentos e pagamentos. Na Hodle, a API REST reúne depósitos por Pix, saída em reais a partir de ativos digitais, extrato e webhooks, com requisitos definidos para cada fluxo.

PixPix
USDCUSDC
USDTUSDT

Uma API de pagamentos com operações documentadas

Escolha a operação pelo resultado esperado. Gerar uma cobrança de depósito converte reais em um ativo digital; criar um produto de checkout gera um link de venda; um payout envia reais ao destino a partir do saldo em ativo. As três operações não são intercambiáveis.

  • POST /api/deposit/asset: cobrança de depósito com valor em reais e destino em ativo digital.
  • POST /api/checkout/products: produto do checkout hospedado, com disponibilidade condicionada à conta.
  • POST /api/wallet/payout: pagamento Pix financiado pelo saldo em ativo digital.
  • GET /api/account/statement: extrato de operações para conferência por período.

Como integrar Pix ao seu sistema

A integração começa no backend da sua empresa. Mantenha as credenciais fora do navegador e use a documentação da operação escolhida para definir os campos e tratar falhas.

  1. 1Obtenha uma chave da API no ambiente adequado e autentique com Authorization: Bearer.
  2. 2Conclua a verificação cadastral aplicável ao titular e às subcontas.
  3. 3Teste o depósito ou o payout com os ativos e destinos permitidos para sua conta.
  4. 4Persista o identificador retornado, acompanhe o estado e reconcilie a operação.

Webhook Pix para confirmação e conciliação

Webhooks comunicam eventos como conclusão ou falha de depósito e pagamento. Verifique a assinatura e o timestamp antes de atualizar seu pedido. Consulte o recurso e o extrato para recuperar o estado quando necessário.

A criação de um QR Code não confirma o recebimento. Uma resposta de criação de payout também não garante que o Pix já foi entregue. Modele os estados de processamento e falha para evitar baixa prematura ou pagamentos duplicados.

Sandbox da API Pix: teste antes da produção

O sandbox usa um host e uma chave próprios, sem dinheiro real. Nos fluxos cobertos, o Pix é simulado e a etapa on-chain ocorre na Base Sepolia com token de teste. O QR Code de teste não deve ser pago no aplicativo do banco.

A cobertura é específica por operação. Conta nominal PJ está disponível só em produção; outros recursos dependem do parceiro e da rede. Confira a tabela de cobertura da documentação antes de montar seu teste.

API da Hodle, API Pix do BC e recebimento de terceiros

A especificação API Pix do Banco Central e a API de integração da Hodle têm contratos diferentes. A API da Hodle acrescenta orquestração de ativos digitais, carteiras e parceiros; não presuma que uma biblioteca feita para outro PSP funcionará sem adaptação.

No depósito, por padrão o pagador deve ser o titular da conta da operação. Receber de terceiros exige habilitação específica. A criação de subcontas também não concede, por si só, uma conta nominal ou autorização para movimentar recursos.

Perguntas frequentes

Respostas para avaliar a solução e preparar sua operação.

Como integrar uma API Pix?

Escolha o fluxo, obtenha a chave do ambiente, implemente a chamada no backend e acompanhe o status. Na Hodle, comece pelo guia de integração e teste os casos cobertos no sandbox antes da produção.

A API Pix da Hodle tem sandbox?

Sim, para os fluxos cobertos na documentação. Ele usa Pix simulado e ativos de teste na Base Sepolia. Conta nominal PJ não tem equivalente em sandbox.

Como confirmar um pagamento Pix por webhook?

Valide X-Hodle-Signature com o segredo do webhook, confira X-Hodle-Timestamp e só então processe o evento. Use a referência técnica para conferir o payload e consulte o estado da operação se houver dúvida.

Posso migrar a integração de outro provedor de API Pix?

É possível avaliar a migração, mas contratos de API, identificação de clientes, liquidação, webhooks e limites precisam ser adaptados. Faça um teste do seu fluxo real em vez de apenas substituir a URL.

Pronto para começar?

Converse com a Hodle sobre o seu fluxo, a habilitação da conta e as condições comerciais.