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: Basic {base64(client_id:client_secret)}
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. Pode ter até 4 casas decimais.	DECIMAL Igual ou maior que zero
blocked (Obrigatório)	Valor não disponível para saque. Um valor pode estar indisponível por estar sendo processado em algum saque em andamento, por ecemplo. Pode ter até 4 casas decimais.	DECIMAL Igual ou maior que zero
total (Obrigatório)	Valor total de saldo na conta. Pode ter até 4 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 YYYY-mm-ddTHH:MM:ss. z

Error

Em caso de erros, será retornado um json com o atributo error especificando o motivo de a operação ter sido invalidada.

HTTP 404 Response Body - Exemplo

{
    "error": "Balance not found."
}