Consultar Saldo
curl --request GET \
--url https://api.example.com/balance \
--header 'Authorization: <authorization>'import requests
url = "https://api.example.com/balance"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.example.com/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/balance")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"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
}
Saldo
Consultar Saldo
Retorna o saldo disponível e pendente da conta
GET
/
balance
Consultar Saldo
curl --request GET \
--url https://api.example.com/balance \
--header 'Authorization: <authorization>'import requests
url = "https://api.example.com/balance"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.example.com/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/balance")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"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
}
Descrição
Retorna o saldo disponível para saque e o saldo pendente (cobranças pagas ainda não liberadas).Headers
string
required
Bearer token de autenticação. Formato:
Bearer sk_live_xxxExemplo de Requisição
curl https://api.flarepayments.com/v1/balance \
-H "Authorization: Bearer sk_live_sua_chave_aqui"
const response = await fetch('https://api.flarepayments.com/v1/balance', {
headers: {
'Authorization': 'Bearer sk_live_sua_chave_aqui'
}
});
const balance = await response.json();
console.log(`Disponível: R$ ${balance.summary.available_balance}`);
import requests
balance = requests.get(
'https://api.flarepayments.com/v1/balance',
headers={'Authorization': 'Bearer sk_live_sua_chave_aqui'}
).json()
print(f"Disponível: R$ {balance['summary']['available_balance']}")
Resposta 200 OK
string
Sempre
"balance"array
object
{
"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.