Buscar saldo
GET
https://api.bestfy.io/company/balance
Em uma única chamada, ele retorna o saldo disponível para saque, o valor retido em reserva financeira e o valor a receber proveniente de antecipações de vendas de cartão de crédito.
Autenticação
x-api-key (obrigatório)Chave da empresa para acesso público ao endpoint.
Headers
x-api-key (string, obrigatório)Chave de autenticação da empresa.
Exemplo de Requisição (API Key)
Exemplo de resposta
{
"availableMoney": 100,
"reservedMoney": 50,
"receivableAdvanceMoneyToReceive": 150
}Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
availableMoney | number | Saldo disponível para saque, em reais. |
reservedMoney | number | Valor retido em reserva financeira, em reais. |
receivableAdvanceMoneyToReceive | number | Valor a receber de antecipações de vendas de cartão de crédito, em reais. |
Possíveis erros
401 Unauthorized — header x-api-key ausente ou API Key inválida.403 Forbidden — API Key revogada.Request
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.bestfy.io/company/balance' \
--header 'User-Agent: <nome-do-projeto>' \
--header 'x-api-key: <api-key>'Response Response Example
{
"availableMoney": 1474.07,
"reservedMoney": 571.09,
"receivableAdvanceMoneyToReceive": 279.95
}Modified at 2026-04-13 21:03:52