HibouPay Docs API
API · Checkout consignado

Documentação da API
HibouPay Checkout

Crie uma sessão de checkout consignado, envie o comprador para a HibouPay e receba a notificação quando o pagamento for concluído, aprovado, negado, cancelado ou expirado.

Começar

Começar com SDK →
Pacote TypeScript @hiboupay/api-client: criar sessão, consultar status e verificar webhooks.
Começar com OpenAPI (HTTP) →
Integre em qualquer linguagem com HTTP puro, mesmos endpoints, exemplos em curl.
Referência completa (Scalar) →

Guias (ordem sugerida)

  1. Visão geral, fluxo da sessão e webhooks
  2. Autenticação, API key e URLs
  3. Quickstart, primeiro sucesso em ~5 minutos
  4. SDK TypeScript, instalação e uso do cliente
  5. HTTP / OpenAPI, integração sem SDK
  6. Webhooks, eventos e assinatura HMAC
  7. Erros e limites, códigos, rate limit, idempotência
  8. Staging, homologação hospedada
Visão geral →
Criar sessão → checkout → comprador → notificação à loja.
Autenticação →
Header X-Api-Key, URLs de produção e staging.
Quickstart →
Criar sessão, checar status e cancelar, com SDK e curl.
SDK TypeScript →
HibouPayClient, erros tipados e verificação de webhook.
HTTP / OpenAPI →
Mesmos endpoints via HTTP; referência Scalar.
Webhooks →
Eventos de pagamento, HMAC no corpo cru, retry e dedupe.
Erros e limites →
Envelope de erro, status HTTP, rate limit e idempotência.
Staging →
Ambiente de homologação para validar a integração com segurança.