Consultar saldo

Consulta o saldo disponível da conta.

GET/v1/balance

https://integrate.api.kyvopay.com.br

cURL

curl -X GET "https://api.kyvopay.com.br/v1/balance" \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN" \
  -H "X-Business-Id: UUID_DA_EMPRESA"

Autenticação

X-API-Keystring · headerobrigatório

Use a chave ky_... criada em Integrações → Chaves de API no painel KyvoPay.

Operação do Core implementada por DashboardController.getBalance().

GET/v1/balance

Sessão do lojista. Requer JWT válido e empresa ativa/selecionada; o Core aplica MerchantBusinessGuard.

Guards encontrados no controller: JwtAuthGuard, MerchantBusinessGuard.

Arquivo: modules/dashboard/dashboard.controller.ts
Handler: DashboardController.getBalance()

Esta página foi sincronizada do Core atual. Campos específicos de corpo e resposta devem permanecer alinhados ao controller e aos DTOs do Core.