GET/api/Balance/balance/{companyId}?currency=BRL

Consultar Saldo (Balance)

Consulta o saldo disponível de uma empresa. Valores monetários são sempre em centavos (R$ 25,00 → 2500).

💡 Dica Importante

Normalmente você já tem o companyId no retorno de /api/v1/transactions/create. Use esse mesmo valor nas chamadas de balance e withdraw.

Endpoint

GET /api/Balance/balance/{companyId}?currency=BRL

Headers

AcceptObrigatório

application/json

X-Client-IdObrigatório

Client ID do aplicativo

X-API-KeyObrigatório

Secret Key (Company)

Path Parameters

companyIdintegerObrigatório

ID da empresa (obtido do retorno de create transaction)

Query Parameters

currencystringObrigatório

Moeda padrão: BRL

Exemplo de Requisição (cURL)

bash

curl -X GET 'https://api.splitgames.com.br/api/Balance/balance/1?currency=BRL' \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33' \
  -H 'X-API-Key: y7M96h1M6aHI-pqKtE4a8cZGStRZ4hOLbt6UX_DyvPPdra8ettG8WM5Q3VEsXXyptSooRm042pCMlKpPDxMsig'

Resposta de Sucesso (200 OK)

Exemplo real de resposta:

json

{
  "id": 1,
  "companyId": 1,
  "currency": "BRL",
  "enBalanceStatus": "Released",
  "accBalance": 5.00,
  "accBalanceCredit": 0.00,
  "accBalanceCreditAwaiting": 0.00
}

Campos da Resposta

accBalance

Saldo disponível para saque (em reais)

enBalanceStatus

Status do saldo (Released = disponível)

accBalanceCredit

Saldo em créditos

accBalanceCreditAwaiting

Saldo em créditos aguardando liberação

Possíveis Erros

404

Not Found

Não há saldo cadastrado para esse companyId/moeda

403

Forbidden

Sem permissão (se usar JWT sem acesso à empresa)

500

Internal Server Error

Erro interno do servidor