InícioReferência

[GET] /account/balance

Verifique o valor atualizado do seu saldo

Para saber mais

Minha conta

Link to a page in the guide

Endpoint de produção

Método GET

Requisição

Headers

Campo

Valor

Tipo

Descrição

Content-Type

application/json

string

Define o conteúdo como JSON

x-api-key

123

string

Sua chave API

cURL

curl --request GET \
  --url https://api-gateway.firebanking.com.br/v1/account/balance \
  --header 'x-api-key: <sua-chave-api>'

Exemplo de resposta

Campos a serem recebidos

Campo

Tipo

Descrição

id

string

Identificador único da sua conta

totalBalance

number

O valor total da conta

blockedBalance

number

O total do valor que está comprometido em movimentações de saque (cash-out) ou de MEDs

availableBalance

number

O valor disponível para saques e movimentações financeiras

JSON

{
	"id": "6642d54caff30523094a6584c",
	"totalBalance": 4.02,
	"blockedBalance": 1.26,
	"availableBalance": 2.76
}