Get Balance by Account

cURL

curl --request GET \
  --url https://www.pierre.finance/tools/api/get-balance-by-account \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://www.pierre.finance/tools/api/get-balance-by-account"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.pierre.finance/tools/api/get-balance-by-account', 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://www.pierre.finance/tools/api/get-balance-by-account",
  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: Bearer <token>"
  ],
]);

$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://www.pierre.finance/tools/api/get-balance-by-account"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.pierre.finance/tools/api/get-balance-by-account")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "name": "Conta Principal",
    "balance": 1000.00,
    "account_type": "BANK",
    "account_subtype": "CHECKING_ACCOUNT"
  },
  "timestamp": "2024-01-01T00:00:00.000Z"
}

GET

tools

api

get-balance-by-account

cURL

curl --request GET \
  --url https://www.pierre.finance/tools/api/get-balance-by-account \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://www.pierre.finance/tools/api/get-balance-by-account"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.pierre.finance/tools/api/get-balance-by-account', 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://www.pierre.finance/tools/api/get-balance-by-account",
  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: Bearer <token>"
  ],
]);

$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://www.pierre.finance/tools/api/get-balance-by-account"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.pierre.finance/tools/api/get-balance-by-account")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "name": "Conta Principal",
    "balance": 1000.00,
    "account_type": "BANK",
    "account_subtype": "CHECKING_ACCOUNT"
  },
  "timestamp": "2024-01-01T00:00:00.000Z"
}

Este endpoint obtém o saldo e detalhes de uma conta bancária específica pelo seu ID.

Descrição

O endpoint GET /tools/api/get-balance-by-account retorna o saldo e detalhes de uma conta bancária específica por accountId.

Autenticação

Este endpoint requer autenticação via Bearer token e assinatura ativa.

string

required

Bearer token com a API key do usuário. Formato: Bearer sk-your-api-key-here

Parâmetros de Query

Response

{
  "success": true,
  "data": {
    "name": "Conta Principal",
    "balance": 1000.00,
    "account_type": "BANK",
    "account_subtype": "CHECKING_ACCOUNT"
  },
  "timestamp": "2024-01-01T00:00:00.000Z"
}

Response Fields

Respostas de Erro

{
  "error": "Account ID is required"
}

{
  "error": "Account is not a bank account"
}

{
  "error": "Invalid or inactive API key",
  "message": "Invalid or inactive API key",
  "type": "invalid_api_key",
  "nextSteps": [
    "Visit https://pierre.finance/api-key to generate a new API key",
    "Make sure the API key is active and not expired"
  ]
}

{
  "error": "Account not found"
}

{
  "error": "Failed to get balance by account id from database"
}

Exemplos de Uso

cURL

curl -X GET "https://www.pierre.finance/tools/api/get-balance-by-account?accountId=123456" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json"

JavaScript

const accountId = '123456';
const response = await fetch(`https://www.pierre.finance/tools/api/get-balance-by-account?accountId=${accountId}`, {
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log('Nome da conta:', data.data.name);
console.log('Saldo:', data.data.balance);

Python

import requests

account_id = '123456'
headers = {
    'Authorization': 'Bearer sk-your-api-key-here',
    'Content-Type': 'application/json'
}

response = requests.get(
    f'https://www.pierre.finance/tools/api/get-balance-by-account?accountId={account_id}', 
    headers=headers
)
data = response.json()

print(f"Nome da conta: {data['data']['name']}")
print(f"Saldo: {data['data']['balance']}")

Observações

Apenas contas bancárias são suportadas por este endpoint
Contas de cartão de crédito retornarão um erro 400
O accountId pode ser obtido do endpoint /tools/api/get-accounts
Os saldos das contas são em tempo real e refletem o estado atual da conta conectada
Se a conta não for encontrada ou não pertencer ao usuário autenticado, um erro 404 será retornado

Authorizations

Authorization

string

header

required

API key in Bearer token format. Example: Bearer sk-your-api-key-here

Query Parameters

accountId

string

required

Identificador único da conta bancária

Response

Dados de saldo da conta

success

boolean

Example:

true

data

any

timestamp

string<date-time>

Getting Started

Accounts & Balance

Transactions

Credit Cards

Spending Limits

Payment Reminders

Analytics

Memories

Open Finance

Synchronization

MCP Server

Descrição

Autenticação

Parâmetros de Query

Response

Response Fields

Respostas de Erro

Exemplos de Uso

cURL

JavaScript

Python

Observações

Authorizations

Query Parameters

Response

​Descrição

​Autenticação

​Parâmetros de Query

​Response

​Response Fields

​Respostas de Erro

​Exemplos de Uso

​cURL

​JavaScript

​Python

​Observações

Authorizations

Query Parameters

Response

Descrição

Autenticação

Parâmetros de Query

Response

Response Fields

Respostas de Erro

Exemplos de Uso

cURL

JavaScript

Python

Observações