For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusDashboard
  • Getting Started
    • Introduction
    • Authentication
    • Rate Limits
    • Error Handling
  • Guides
    • Cash-In (Receiving Payments)
    • Cash-Out (Sending Payments)
    • PIX Keys Management
    • Webhooks Integration
    • MED (Special Returns)
  • API Reference
      • GETHealth Check
      • GETReadiness Check
LogoLogo
StatusDashboard
API ReferenceService Health

Health Check

GET
https://api.brzip.com.br/health
GET
/health
$curl https://api.brzip.com.br/health
200Retrieved
1{
2  "status": "healthy",
3  "service": "brz-api"
4}

Basic service health check. Returns HTTP 200 if the service is running.

Response: {"status":"healthy","service":"brz-api"}

Was this page helpful?
Previous

Readiness Check

Next
Built with

Response

Service is healthy
statusstring
servicestring