Acessar minha contaAbrir uma conta
GET/api/v2/baas/balances/period

Saldo por período

Produto BaaS (titular). Requer Bearer JWT do login da conta e assinatura HMAC obrigatória. Scope: baas.balances.read. Guia: documentação técnica.

Parâmetros

AcceptObrigatório
header
Tipo:string
X-SignatureObrigatório
header

Assinatura HMAC-SHA256 da requisição (hex).

Tipo:string
X-TimestampObrigatório
header

Timestamp Unix (segundos, UTC) usado na assinatura.

Tipo:string
X-NonceObrigatório
header

Nonce único por requisição (anti-replay).

Tipo:string
start_dateObrigatório
query

Data de início do período (Y-m-d).

Tipo:string
end_dateObrigatório
query

Data de fim do período (Y-m-d).

Tipo:string

Autenticação e headers

Requer Bearer JWT do login da conta e assinatura HMAC obrigatórios. Scope: baas.balances.read.

Envie X-Signature, X-Timestamp e X-Nonce em todo pedido assinado. Veja Autenticação do parceiro (HMAC).

HeaderObrigatórioDescrição
AuthorizationSimBearer {{access_token}}
AcceptSimapplication/json
X-SignatureSimAssinatura HMAC
X-TimestampSimTimestamp da assinatura
X-NonceSimNonce único por requisição

GET assinado: use o literal [] como BODY na mensagem HMAC (sem corpo no fio).

Query

ParâmetroObrigatórioFormatoDescrição
start_dateSimY-m-dInício do período
end_dateSimY-m-dFim do período (start_date ≤ end_date)

Valores monetários

Cada balance no array é saldo ao final do dia, em centavos. Agregado para gráficos; não prova transação individual.

Códigos

CódigoDescrição
200OK
201Recurso criado
400Parâmetros inválidos
401Token ou HMAC inválido
403Scope ausente
404Não encontrado
422Validação ou regra de negócio
500Erro interno

Notas

curl --request GET \
  --url 'https://api-h.nuvende.com.br/api/v2/baas/balances/period?start_date=2025-01-01&end_date=2025-01-31' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'X-Timestamp: {{timestamp}}' \
  --header 'X-Nonce: {{nonce}}' \
  --header 'X-Signature: {{signature}}'

const axios = require("axios");

axios({
  method: "get",
  url: "https://api-h.nuvende.com.br/api/v2/baas/balances/period",
  params: {
    start_date: "2025-01-01",
    end_date: "2025-01-31",
  },
  headers: {
    Accept: "application/json",
    Authorization: "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
  },
})
  .then((response) => console.log(JSON.stringify(response.data)))
  .catch((error) => console.log(error.response?.data || error.message));

import requests

url = "https://api-h.nuvende.com.br/api/v2/baas/balances/period"
params = {
    "start_date": "2025-01-01",
    "end_date": "2025-01-31",
}
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "X-Timestamp": "{{timestamp}}",
    "X-Nonce": "{{nonce}}",
    "X-Signature": "{{signature}}",
}
response = requests.get(url, params=params, headers=headers)
print(response.text)

<?php
$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api-h.nuvende.com.br/api/v2/baas/balances/period?start_date=2025-01-01&end_date=2025-01-31',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Accept: application/json',
    'Authorization: Bearer {{access_token}}',
    'X-Timestamp: {{timestamp}}',
    'X-Nonce: {{nonce}}',
    'X-Signature: {{signature}}',
  ],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;

[
  {
    "date": "2025-01-01",
    "balance": 120000
  },
  {
    "date": "2025-01-02",
    "balance": 135000
  }
]

{
  "message": {
    "start_date": ["The start date field is required."],
    "end_date": ["The end date field is required."]
  }
}