Skip to main content

Autenticação e segredo

  • Token de produção em cofre (variáveis, secret manager) — nunca no repositório.
  • Authorization: Bearer e Content-Type: application/json em chamadas com corpo.
  • Rotação e procedimento de emergência se o segredo vazar.
  • X-Correlation-ID em todas as chamadas.

Identidade e persistência

  • Persistir id (UUID) e externalId imediatamente após o 201.
  • Manter trilha de transactionId (parceiro) e endToEndId (Pix) quando retornos ou apontarem divergência.
  • Refund: POST /api/pix/refund-in/{id} com id do cash-in; GET /api/pix/refund/{id} com id do refund-in (identidade).

Webhook do comerciante

  • Registro concluído (URL, eventos) — referência de API (há TODO de corpo no material de origem).
  • TLS válido, rota acessível publicamente, timeout compatível.
  • Verificação de Digital-Signature no corpo bruto; chave pública de GET /public-key com cache e plano de rotação.
  • Resposta 2xx em poucos segundos; processamento pesado fora do request.
  • Idempotência no consumidor, atento à tabela de event.id (referência de eventos).

Reconciliação e monitoramento

  • Painéis para volume de itens PENDING, PROVIDER_RESULT_UNKNOWN e RECONCILIATION_REQUIRED com idade (a origem recomenda alinhar se passar de > 30 min).
  • Roteiro quando consulta e webhook divergirem (ver tratamento de erros).
  • Rotina de conciliação: ledger e extratos do parceiro.

Observabilidade

  • Correlacionar logs com X-Correlation-ID e event.correlation_id quando presente.
  • Acompanhar latência p95 e taxa de 5xx no endpoint de webhook.
TODO: SLO/SLA contratuais com a operação — a origem não cita; negociar com a ClearPago/clearpago.

Política de suporte (origem)

CanalContato
E-mailtech@clearpago.com.br
Documentação (referência)https://docs.clearpago.com.br
Statushttps://status.clearpago.com.br
O documento de origem ainda cita runbooks em docs/runbooks/ do repositório (interno) para incidentes.

Pós cutover

  • Exercitar refund e reversão em carga/ambiente apropriado antes do pico.
  • Definir template de pós‑mortem de incidente Pix com id e endToEndId.

Ver também


Marca: ClearPago é a marca desta documentação; a API descrita é a clearpago. Ajuste domínio e assets de docs.json (logo/favicon) no deploy.