Skip to main content
GET
/
balance
Consultar Saldo
curl --request GET \
  --url https://api.example.com/balance \
  --header 'Authorization: <authorization>'
{
  "object": "balance",
  "available": [
    { "amount": 150000, "currency": "brl" }
  ],
  "pending": [
    { "amount": 25000, "currency": "brl" }
  ],
  "summary": {
    "available_balance": 1500.00,
    "pending_balance": 250.00,
    "total_earned": 5000.00,
    "total_withdrawn": 3250.00,
    "currency": "BRL"
  },
  "livemode": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.flarepayments.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Descrição

Retorna o saldo disponível para saque e o saldo pendente (cobranças pagas ainda não liberadas).

​
Headers

​
Authorization
string
required
Bearer token de autenticação. Formato: Bearer flare_xxx

​
Exemplo de Requisição

curl https://api.flarepayments.com/v1/balance \
  -H "Authorization: Bearer flare_sua_chave_aqui"

​
Resposta 200 OK

​
object
string
Sempre "balance"
​
available
array
Saldo disponível por moeda
​
pending
array
Saldo pendente por moeda
​
summary
object
Resumo em Reais
{
  "object": "balance",
  "available": [
    { "amount": 150000, "currency": "brl" }
  ],
  "pending": [
    { "amount": 25000, "currency": "brl" }
  ],
  "summary": {
    "available_balance": 1500.00,
    "pending_balance": 250.00,
    "total_earned": 5000.00,
    "total_withdrawn": 3250.00,
    "currency": "BRL"
  },
  "livemode": true
}

​
Cálculo do Saldo Disponível

disponível = 
  soma(net_amount de cobranças pagas)
  - soma(amount de saques concluídos)
  - soma(amount de saques em processamento)
O available_balance já considera as taxas descontadas (net_amount) e os saques já solicitados.