Consultar Saldo

Retorna o saldo total, disponível e em revisão da sua conta.

GET /finance/balance/

Headers

Header	Valor	Obrigatório
Authorization	Bearer mk_<env>_<token>	Sim

Exemplo de Requisição

cURL

curl -X GET https://api.somosmarcha.com/api/v1/finance/balance/ \
  -H "Authorization: Bearer $API_KEY"

Python

import os
import requests

BASE_URL = "https://api.somosmarcha.com/api/v1"

headers = {
    "Authorization": f"Bearer {os.environ['API_KEY']}",
}

response = requests.get(f"{BASE_URL}/finance/balance/", headers=headers)
print(response.json())

Node.js

const BASE_URL = "https://api.somosmarcha.com/api/v1";

const response = await fetch(`${BASE_URL}/finance/balance/`, {
  headers: {
    "Authorization": `Bearer ${process.env.API_KEY}`,
  },
});

const data = await response.json();
console.log(data);

Resposta de Sucesso

Status: 200 OK

{
  "total": 15000,
  "available_balance": 12500,
  "under_review": 2500
}

Campos da Resposta

Notação financeira

Todos os valores monetários são expressos em centavos (inteiro). Exemplo: 15000 = R$ 150,00.

Campo	Tipo	Descrição
total	integer	Saldo total em centavos
available_balance	integer	Saldo disponível para saque em centavos
under_review	integer	Saldo em revisão/processamento em centavos

Saldo em revisão

O campo under_review representa valores de transações já confirmadas que ainda estão dentro do prazo de liberação. Após o período de processamento, esses valores serão transferidos automaticamente para o saldo disponível (available_balance).