Consulta de saldo

Retorna as variações de saldo da empresa, assim como a data na qual esse saldo foi atualizado. Ou seja, quando houve entrada ou saída de valor.

Request

A chamada deverá ser feita utilizando o método GET.

URL

{BaseUrl}/api/v1/balance

HTTP Headers - Exemplo:

Authorization: Bearer {ACCESS_TOKEN}
Content-Type: application/json

Exemplo cURL - bash:

curl -X GET https://api.moneyguard.com.br/api/v1/balance \
-H "Authorization: Bearer seu_access_token" \
-H "User-Agent: seu_user_agent"

Response

Em caso de sucesso, será retornado uma mensagem HTTP 200 – OK, contendo os dados, conforme apresentado abaixo:

HTTP 200 Response Body - Exemplo

{
        "available": "0.65",
        "blocked": "0.0",
        "total": "0.65",
        "updated_at": "2026-02-09T11:50:25.673Z"
}

Descrição dos Atributos

ATRIBUTO	DESCRIÇÃO	TIPO
available (Obrigatório)	Valor disponível para saque, em reais. Pode ter até 2 casas decimais.	DECIMAL Igual ou maior que zero
blocked (Obrigatório)	Valor não disponível para saque, em reais. Um valor pode estar indisponível por estar sendo processado em algum saque em andamento, por exemplo. Pode ter até 2 casas decimais.	DECIMAL Igual ou maior que zero
total (Obrigatório)	Valor total de saldo na conta, em reais. Pode ter até 2 casas decimais.	DECIMAL Igual ou maior que zero
updated_at (Obrigatório)	Data em que foi realizada a última entrada ou saída de valores no saldo.	STRING formato datetime ISO 8601

Caso a conta ainda não possua registro de saldo, será retornado HTTP 200 com os valores zerados:

HTTP 200 Response Body - Conta sem movimentação

{
    "available": 0,
    "blocked": 0,
    "total": 0,
    "updated_at": null
}