Cash-In (Pix In)
Cash-In is the service responsible for generating and managing
received Pix charges (cash-in): creation of dynamic QR Codes (both the
gateway's own format and the Bacen/cob standard), batch processing,
recurrences (automatic/scheduled Pix), and querying/refunding/canceling
transactions.
All endpoints (except health-check and login) require authentication via
the Authorization header and, for most of them, the Channel-ID header.
Base path
All routes described in this section are under the /api prefix.
Authentication
Authorization (JWT)
Most requests require the header:
Authorization: Bearer <token>
The token is a JWT issued by the POST /api/login endpoint. If
missing, malformed, or invalid/expired, the API returns 401
Unauthorized:
{ "error": "Token ausente ou inválido" }
or
{ "error": "Token inválido" }
Channel-ID
Most routes also require the Channel-ID: <channel_uuid> header,
identifying the channel/integrator making the request. If missing, the API
returns 400 Bad Request:
{ "error": "Insira o Channel-ID na header" }
In addition to being present, the authenticated user must have access to the informed channel; otherwise it returns 403 Forbidden:
{ "error": "unauthorized channel" }
Modules
Initial content generated from an analysis of the service's source code. Expand with additional examples and use cases as needed.