Extrato e Saldo

Consulta de saldo de contas bancárias.

Endpoints

Método	Endpoint	Descrição	Permissão
GET	/baas/api/v1/accounts/:id/balance	Consultar saldo	BAAS_STATEMENTS_READ

Extrato detalhado em desenvolvimento

O endpoint de extrato detalhado com movimentações (GET /accounts/:id/statements) ainda não está disponível na API. Atualmente, apenas a consulta de saldo está implementada. A funcionalidade de extrato detalhado está prevista para versões futuras.

Atributos do Saldo

Campo	Tipo	Descrição
accountId	string (UUID)	ID da conta bancária
available	number	Saldo disponível para operações
blocked	number	Saldo bloqueado (reservas, garantias, etc.)
total	number	Saldo total (disponível + bloqueado)
currency	string	Moeda (ex: BRL)
updatedAt	datetime	Data/hora da última atualização

---

Consultar Saldo

GET /baas/api/v1/accounts/:id/balance

Retorna o saldo atual da conta bancária, incluindo valores disponíveis e bloqueados.

cURL

curl 'https://baas.stg.catalisa.app/baas/api/v1/accounts/550e8400-e29b-41d4-a716-446655440100/balance' \
  -H 'Authorization: Bearer SEU_TOKEN'

JavaScript

const accountId = '550e8400-e29b-41d4-a716-446655440100';

const response = await fetch(`https://baas.stg.catalisa.app/baas/api/v1/accounts/${accountId}/balance`, {
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const { data } = await response.json();
console.log(`Saldo disponível: R$ ${data.attributes.available.toFixed(2)}`);
console.log(`Saldo bloqueado: R$ ${data.attributes.blocked.toFixed(2)}`);
console.log(`Saldo total: R$ ${data.attributes.total.toFixed(2)}`);

Response (200 OK)

{
  "data": {
    "type": "balance",
    "attributes": {
      "accountId": "550e8400-e29b-41d4-a716-446655440100",
      "available": 52000.00,
      "blocked": 1500.00,
      "total": 53500.00,
      "currency": "BRL",
      "updatedAt": "2024-01-15T15:00:00Z"
    }
  }
}

---

Erros Comuns

Código	Erro	Descrição
404	NOT_FOUND	Conta não encontrada