API Reference/Account
GET

Retrieve account balance

Retrieve account balance. See the request, response and integration notes.

GET/v1/balance
https://integrate.api.kyvopay.com.br
cURL
curl -X GET https://integrate.api.kyvopay.com.br/v1/balance \
  -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX"
Resposta200 OK
{
  "data": {
    "available_centavos": "4990",
    "pending_centavos": "4990",
    "reserved_centavos": "4990"
  },
  "error": {
    "code": "string",
    "details": {},
    "message": "string"
  },
  "request_id": "req_01HZ8K3M5N"
}

Authentication

X-API-Keystring · headerrequired

Use the ky_... key created under Integrations → API Keys in the KyvoPay dashboard.

Use this endpoint to retrieve account balance.

Request

Note

Private endpoints require the X-API-Key header. Keep credentials on your backend and log the response request_id for diagnostics.

Response

Implementation notes

  • Validate required input before sending the request.
  • Store returned public identifiers without assuming their format.
  • Treat 4xx validation errors as non-retryable until the request is corrected.
  • Retry timeouts, 429 and temporary 5xx responses with exponential backoff.
Need help? Contact support
© 2026 KyvoPay