Cash-In (Pix In)
O Cash-In é o serviço responsável pela geração e gestão de cobranças
Pix recebidas (cash-in): criação de QR Codes dinâmicos (próprios e no padrão
Bacen/cob), processamento em lote, recorrências (Pix automático/agendado) e
consulta/estorno/cancelamento de transações.
Todos os endpoints (exceto health-check e login) exigem autenticação via
header Authorization e, para a maioria, o header Channel-ID.
Base path
Todas as rotas descritas nesta seção estão sob o prefixo /api.
Autenticação
Authorization (JWT)
A maioria das requisições exige o header:
Authorization: Bearer <token>
O token é um JWT emitido pelo endpoint POST /api/login. Se
ausente, mal formatado ou inválido/expirado, a API retorna 401
Unauthorized:
{ "error": "Token ausente ou inválido" }
ou
{ "error": "Token inválido" }
Channel-ID
Grande parte das rotas também exige o header Channel-ID: <uuid_do_canal>,
identificando o canal/integrador que está fazendo a requisição. Se ausente,
a API retorna 400 Bad Request:
{ "error": "Insira o Channel-ID na header" }
Além de presente, o usuário autenticado precisa ter acesso ao canal informado; caso contrário retorna 403 Forbidden:
{ "error": "unauthorized channel" }
Módulos
Conteúdo inicial gerado a partir da análise do código-fonte do serviço. Expanda com exemplos adicionais e casos de uso conforme necessário.