Get Installments

cURL

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

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

fetch('https://www.pierre.finance/tools/api/get-installments', 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-installments",
  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-installments"

	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-installments")

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": {
    "summary": {
      "totalAmount": 5000.00,
      "totalInstallments": 12,
      "totalPurchases": 3,
      "installmentDistribution": [
        {
          "totalInstallments": 12,
          "count": 1,
          "totalAmount": 3000.00
        },
        {
          "totalInstallments": 6,
          "count": 2,
          "totalAmount": 2000.00
        }
      ]
    },
    "purchases": [
      {
        "purchaseDate": "2024-01-10",
        "totalAmount": 3000.00,
        "installments": [
          {
            "description": "Compra parcelada - Eletrônicos",
            "amount": 250.00,
            "installmentNumber": 1,
            "totalInstallments": 12,
            "dueDate": "2024-02-10",
            "category": "Eletrônicos",
            "status": "POSTED"
          },
          {
            "description": "Compra parcelada - Eletrônicos",
            "amount": 250.00,
            "installmentNumber": 2,
            "totalInstallments": 12,
            "dueDate": "2024-03-10",
            "category": "Eletrônicos",
            "status": "PENDING"
          }
        ]
      },
      {
        "purchaseDate": "2024-01-15",
        "totalAmount": 1200.00,
        "installments": [
          {
            "description": "Compra parcelada - Roupas",
            "amount": 200.00,
            "installmentNumber": 1,
            "totalInstallments": 6,
            "dueDate": "2024-02-15",
            "category": "Roupas",
            "status": "POSTED"
          }
        ]
      }
    ]
  },
  "summary": {
    "totalAmount": 5000.00,
    "totalInstallments": 12,
    "totalPurchases": 3,
    "installmentDistribution": [
      {
        "totalInstallments": 12,
        "count": 1,
        "totalAmount": 3000.00
      },
      {
        "totalInstallments": 6,
        "count": 2,
        "totalAmount": 2000.00
      }
    ]
  },
  "dateRange": {
    "startDate": "2024-01-01T00:00:00Z",
    "endDate": "2024-12-31T23:59:59Z"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

GET

tools

api

get-installments

cURL

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

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

fetch('https://www.pierre.finance/tools/api/get-installments', 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-installments",
  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-installments"

	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-installments")

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": {
    "summary": {
      "totalAmount": 5000.00,
      "totalInstallments": 12,
      "totalPurchases": 3,
      "installmentDistribution": [
        {
          "totalInstallments": 12,
          "count": 1,
          "totalAmount": 3000.00
        },
        {
          "totalInstallments": 6,
          "count": 2,
          "totalAmount": 2000.00
        }
      ]
    },
    "purchases": [
      {
        "purchaseDate": "2024-01-10",
        "totalAmount": 3000.00,
        "installments": [
          {
            "description": "Compra parcelada - Eletrônicos",
            "amount": 250.00,
            "installmentNumber": 1,
            "totalInstallments": 12,
            "dueDate": "2024-02-10",
            "category": "Eletrônicos",
            "status": "POSTED"
          },
          {
            "description": "Compra parcelada - Eletrônicos",
            "amount": 250.00,
            "installmentNumber": 2,
            "totalInstallments": 12,
            "dueDate": "2024-03-10",
            "category": "Eletrônicos",
            "status": "PENDING"
          }
        ]
      },
      {
        "purchaseDate": "2024-01-15",
        "totalAmount": 1200.00,
        "installments": [
          {
            "description": "Compra parcelada - Roupas",
            "amount": 200.00,
            "installmentNumber": 1,
            "totalInstallments": 6,
            "dueDate": "2024-02-15",
            "category": "Roupas",
            "status": "POSTED"
          }
        ]
      }
    ]
  },
  "summary": {
    "totalAmount": 5000.00,
    "totalInstallments": 12,
    "totalPurchases": 3,
    "installmentDistribution": [
      {
        "totalInstallments": 12,
        "count": 1,
        "totalAmount": 3000.00
      },
      {
        "totalInstallments": 6,
        "count": 2,
        "totalAmount": 2000.00
      }
    ]
  },
  "dateRange": {
    "startDate": "2024-01-01T00:00:00Z",
    "endDate": "2024-12-31T23:59:59Z"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

Este endpoint retorna informações sobre compras parceladas do usuário autenticado.

Descrição

O endpoint GET /tools/api/get-installments retorna informações detalhadas sobre compras parceladas do usuário autenticado. Busca TODAS as parcelas (passadas, atuais e futuras) para compras realizadas dentro do período especificado, incluindo cronograma de pagamentos, valores das parcelas e datas de vencimento.

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

string

required

Data inicial para filtrar compras parceladas (formato YYYY-MM-DD). Se não fornecido, usa o primeiro dia de 3 meses atrás como padrão.

string

required

Data final para filtrar compras parceladas (formato YYYY-MM-DD). Se não fornecido, usa o último dia do mês atual como padrão.

Resposta

Sucesso (200)

{
  "success": true,
  "data": {
    "summary": {
      "totalAmount": 5000.00,
      "totalInstallments": 12,
      "totalPurchases": 3,
      "installmentDistribution": [
        {
          "totalInstallments": 12,
          "count": 1,
          "totalAmount": 3000.00
        },
        {
          "totalInstallments": 6,
          "count": 2,
          "totalAmount": 2000.00
        }
      ]
    },
    "purchases": [
      {
        "purchaseDate": "2024-01-10",
        "totalAmount": 3000.00,
        "installments": [
          {
            "description": "Compra parcelada - Eletrônicos",
            "amount": 250.00,
            "installmentNumber": 1,
            "totalInstallments": 12,
            "dueDate": "2024-02-10",
            "category": "Eletrônicos",
            "status": "POSTED"
          },
          {
            "description": "Compra parcelada - Eletrônicos",
            "amount": 250.00,
            "installmentNumber": 2,
            "totalInstallments": 12,
            "dueDate": "2024-03-10",
            "category": "Eletrônicos",
            "status": "PENDING"
          }
        ]
      },
      {
        "purchaseDate": "2024-01-15",
        "totalAmount": 1200.00,
        "installments": [
          {
            "description": "Compra parcelada - Roupas",
            "amount": 200.00,
            "installmentNumber": 1,
            "totalInstallments": 6,
            "dueDate": "2024-02-15",
            "category": "Roupas",
            "status": "POSTED"
          }
        ]
      }
    ]
  },
  "summary": {
    "totalAmount": 5000.00,
    "totalInstallments": 12,
    "totalPurchases": 3,
    "installmentDistribution": [
      {
        "totalInstallments": 12,
        "count": 1,
        "totalAmount": 3000.00
      },
      {
        "totalInstallments": 6,
        "count": 2,
        "totalAmount": 2000.00
      }
    ]
  },
  "dateRange": {
    "startDate": "2024-01-01T00:00:00Z",
    "endDate": "2024-12-31T23:59:59Z"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

Erro de Autenticação (401)

{
  "error": "Invalid or inactive API key",
  "message": "Please check your API key and try again",
  "type": "invalid_api_key"
}

Campos da Resposta

boolean

required

Indica se a requisição foi bem-sucedida

object

required

Objeto com os dados das compras parceladas

Show InstallmentStats Object

object

required

Resumo das compras parceladas

Show InstallmentSummary Object

number

required

Valor total de todas as compras parceladas

number

required

Número total de parcelas

number

required

Número total de compras parceladas

array

required

Distribuição das parcelas por número de parcelas

Show Distribution Object

number

required

Número total de parcelas neste grupo

number

required

Quantidade de compras neste grupo

number

required

Valor total deste grupo

array

required

Array com as compras parceladas

Show InstallmentPurchase Object

string

required

Data da compra no formato YYYY-MM-DD

number

required

Valor total da compra

array

required

Array com as parcelas da compra

Show Installment Object

string

required

Descrição da parcela

number

required

Valor da parcela

number

required

Número da parcela atual

number

required

Número total de parcelas

string

required

Data de vencimento da parcela no formato YYYY-MM-DD

string

Categoria da compra (pode ser null)

string

required

Status da parcela (POSTED, PENDING)

object

required

Resumo geral das compras parceladas (mesmo objeto do data.summary)

object

required

Período dos dados retornados

Show DateRange Object

string

required

Data inicial do período em formato ISO 8601

string

required

Data final do período em formato ISO 8601

string

required

Timestamp da requisição em formato ISO 8601

Exemplos de Uso

cURL

# Obter todas as compras parceladas
curl -X GET 'https://www.pierre.finance/tools/api/get-installments' \
  -H 'Authorization: Bearer sk-your-api-key-here'

# Obter compras parceladas de um período específico
curl -X GET 'https://www.pierre.finance/tools/api/get-installments?startDate=2024-01-01&endDate=2024-12-31' \
  -H 'Authorization: Bearer sk-your-api-key-here'

JavaScript

const API_KEY = 'sk-your-api-key-here';
const BASE_URL = 'https://www.pierre.finance/tools/api';

async function getInstallments(filters = {}) {
  const params = new URLSearchParams(filters);
  const response = await fetch(`${BASE_URL}/get-installments?${params}`, {
    headers: {
      'Authorization': `Bearer ${API_KEY}`,
      'Content-Type': 'application/json'
    }
  });
  
  return await response.json();
}

// Exemplos de uso
getInstallments();
getInstallments({ startDate: '2024-01-01', endDate: '2024-12-31' });

Python

import requests

API_KEY = 'sk-your-api-key-here'
BASE_URL = 'https://www.pierre.finance/tools/api'

headers = {
    'Authorization': f'Bearer {API_KEY}',
    'Content-Type': 'application/json'
}

def get_installments(filters=None):
    if filters is None:
        filters = {}
    
    response = requests.get(f'{BASE_URL}/get-installments', 
                          headers=headers, params=filters)
    return response.json()

# Exemplos de uso
installments = get_installments()
installments = get_installments({
    'startDate': '2024-01-01',
    'endDate': '2024-12-31'
})

Códigos de Status

200: Sucesso - Dados das compras parceladas retornados
401: Erro de autenticação ou assinatura
500: Erro interno do servidor

Este endpoint retorna TODAS as parcelas (passadas, atuais e futuras) para compras realizadas no período especificado. Para dados mais recentes, use o endpoint de sincronização manual.

Authorizations

Authorization

string

header

required

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

Query Parameters

startDate

string<date>

Start date for filtering. Defaults to first day 3 months ago if not provided. Start date for filtering (YYYY-MM-DD format)

endDate

string<date>

End date for filtering. Defaults to last day of current month if not provided. End date for filtering (YYYY-MM-DD format)

Response

Installments data and statistics

success

boolean

Example:

true

data

any

summary

any

purchases

any[]

dateRange

object

Show child attributes

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

Resposta

Sucesso (200)

Erro de Autenticação (401)

Campos da Resposta

Exemplos de Uso

cURL

JavaScript

Python

Códigos de Status

Authorizations

Query Parameters

Response

​Descrição

​Autenticação

​Parâmetros de Query

​Resposta

​Sucesso (200)

​Erro de Autenticação (401)

​Campos da Resposta

​Exemplos de Uso

​cURL

​JavaScript

​Python

​Códigos de Status

Authorizations

Query Parameters

Response

Descrição

Autenticação

Parâmetros de Query

Resposta

Sucesso (200)

Erro de Autenticação (401)

Campos da Resposta

Exemplos de Uso

cURL

JavaScript

Python

Códigos de Status