API v1
Referência de endpoints
Use este índice para localizar uma operação. Para parâmetros, schemas e respostas, abra a referência OpenAPI no Swagger.
Base URL e autenticação
Authorization: Bearer sk_live_sua_chave para https://meu.casepay.com.br/api/v1. Cada chave aceita 60 requisições por minuto e cada endpoint exige o escopo indicado; veja Autenticação.Horários no horário de Brasília
2026-09-30T21:15:00-03:00. É o mesmo instante de antes: quem lê com um parser ISO não precisa mudar nada. Datas sem hora (AAAA-MM-DD) são o dia em Brasília. Nas entradas, data e hora sem fuso (2026-12-31T23:59:00) valem no horário de Brasília; com Z ou -03:00 valem aquele instante. Os cabeçalhos HTTP seguem o padrão do protocolo: Date é sempre em GMT e Retry-After vem em segundos.CobrançasLink direto para a seção Cobranças
/api/v1/manual-pix
Gera código PIX, QR Code ou um link /pay persistente.
Ver guia de implementação →/api/v1/payments
Cria uma cobrança única e retorna o link público do pagador.
Ver guia de implementação →Clientes do CRMLink direto para a seção Clientes do CRM
Exigem o escopo customers, que só o proprietário do workspace pode conceder. Ver escopos.
/api/v1/crm/customers
Lista os clientes da carteira do CRM. Aceita q, page e size (de 1 a 100).
/api/v1/crm/customers
Cria um cliente. Envie creationRequestId (UUID) no corpo ou em Idempotency-Key; repetir a criação devolve o mesmo cliente.
/api/v1/crm/customers/search
Busca clientes por nome, documento, e-mail ou telefone (q é obrigatório).
/api/v1/crm/customers/:id
Consulta um cliente e devolve a versão no cabeçalho ETag.
/api/v1/crm/customers/:id
Atualiza nome, e-mail, telefone ou documento. Envie a versão em If-Match ou expectedVersion; sem ela, a API responde 428.
Webhooks enviadosLink direto para a seção Webhooks enviados
A CasePay envia um POST JSON para a URL configurada no painel. O OpenAPI descreve cada evento na seção webhooks. Ver payloads e assinatura.
PIX pela conta Sicoob
payment_intent/completed: Cobrança paga, confirmada pelo banco (provider: sicoob).payment_request/updated: Cobrança expirada (EXPIRED), cancelada (CANCELED) ou com erro (ERROR).
PIX manual (link com comprovante)
manual_pix/receipt_received: O pagador enviou um comprovante. Não confirma o pagamento.manual_pix/receipt_removed: A equipe removeu o comprovante e reabriu o envio.
OpenAPI 3.1
Explore o contrato completo
O Swagger reúne os schemas de entrada e saída, códigos de resposta e requisitos de autenticação de cada operação.