cURL
curl --request POST \
--url https://www.pierre.finance/tools/api/create-payment-reminder \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"dueDate": "2023-12-25",
"amount": 123,
"reminderTime": "2023-11-07T05:31:56Z",
"isRecurring": false
}
'import requests
url = "https://www.pierre.finance/tools/api/create-payment-reminder"
payload = {
"title": "<string>",
"dueDate": "2023-12-25",
"amount": 123,
"reminderTime": "2023-11-07T05:31:56Z",
"isRecurring": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
dueDate: '2023-12-25',
amount: 123,
reminderTime: '2023-11-07T05:31:56Z',
isRecurring: false
})
};
fetch('https://www.pierre.finance/tools/api/create-payment-reminder', 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/create-payment-reminder",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'dueDate' => '2023-12-25',
'amount' => 123,
'reminderTime' => '2023-11-07T05:31:56Z',
'isRecurring' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.pierre.finance/tools/api/create-payment-reminder"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"amount\": 123,\n \"reminderTime\": \"2023-11-07T05:31:56Z\",\n \"isRecurring\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.pierre.finance/tools/api/create-payment-reminder")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"amount\": 123,\n \"reminderTime\": \"2023-11-07T05:31:56Z\",\n \"isRecurring\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.pierre.finance/tools/api/create-payment-reminder")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"amount\": 123,\n \"reminderTime\": \"2023-11-07T05:31:56Z\",\n \"isRecurring\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "pr_123456789",
"title": "Conta de luz",
"amount": 150.00,
"dueDate": "2024-12-15",
"reminderTime": "2024-12-14T09:00:00Z",
"status": "active",
"isRecurring": false,
"recurrencePattern": null,
"createdAt": "2024-11-27T15:30:00Z",
"updatedAt": "2024-11-27T15:30:00Z"
},
"message": "Payment reminder created successfully: Conta de luz",
"timestamp": "2024-11-27T15:30:00Z"
}
Payment Reminders
Create Payment Reminder
Cria um novo lembrete de pagamento. Permite criar lembretes únicos ou recorrentes com notificações via WhatsApp e Email. Requer API key para autenticação e assinatura ativa. O usuário deve ter cota disponível baseada no seu plano.
POST
/
tools
/
api
/
create-payment-reminder
cURL
curl --request POST \
--url https://www.pierre.finance/tools/api/create-payment-reminder \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"dueDate": "2023-12-25",
"amount": 123,
"reminderTime": "2023-11-07T05:31:56Z",
"isRecurring": false
}
'import requests
url = "https://www.pierre.finance/tools/api/create-payment-reminder"
payload = {
"title": "<string>",
"dueDate": "2023-12-25",
"amount": 123,
"reminderTime": "2023-11-07T05:31:56Z",
"isRecurring": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
dueDate: '2023-12-25',
amount: 123,
reminderTime: '2023-11-07T05:31:56Z',
isRecurring: false
})
};
fetch('https://www.pierre.finance/tools/api/create-payment-reminder', 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/create-payment-reminder",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'dueDate' => '2023-12-25',
'amount' => 123,
'reminderTime' => '2023-11-07T05:31:56Z',
'isRecurring' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.pierre.finance/tools/api/create-payment-reminder"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"amount\": 123,\n \"reminderTime\": \"2023-11-07T05:31:56Z\",\n \"isRecurring\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.pierre.finance/tools/api/create-payment-reminder")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"amount\": 123,\n \"reminderTime\": \"2023-11-07T05:31:56Z\",\n \"isRecurring\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.pierre.finance/tools/api/create-payment-reminder")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"amount\": 123,\n \"reminderTime\": \"2023-11-07T05:31:56Z\",\n \"isRecurring\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "pr_123456789",
"title": "Conta de luz",
"amount": 150.00,
"dueDate": "2024-12-15",
"reminderTime": "2024-12-14T09:00:00Z",
"status": "active",
"isRecurring": false,
"recurrencePattern": null,
"createdAt": "2024-11-27T15:30:00Z",
"updatedAt": "2024-11-27T15:30:00Z"
},
"message": "Payment reminder created successfully: Conta de luz",
"timestamp": "2024-11-27T15:30:00Z"
}
Este endpoint cria um novo lembrete de pagamento com notificações via WhatsApp e Email.
Descrição
O endpointPOST /tools/api/create-payment-reminder permite criar lembretes de pagamento únicos ou recorrentes. Você receberá notificações automáticas via WhatsApp e Email nos horários configurados.
Autenticação
Este endpoint requer autenticação via Bearer token.string
required
Bearer token com a API key do usuário. Formato:
Bearer sk-your-api-key-hereParâmetros de Query
string
required
Parâmetro interno para indicar requisições via MCP. Use
s=s para requisições MCP.Body Parameters
string
required
Título do lembrete (ex: “Conta de luz”, “Aluguel”)
number
Valor do pagamento em BRL (opcional)
string
required
Data de vencimento no formato YYYY-MM-DD
string
Data/hora do lembrete em formato ISO 8601. Se não fornecido, será 1 dia antes do vencimento às 9h.
boolean
Se o lembrete é recorrente (padrão: false)
string
Padrão de recorrência:
daily, weekly, monthly, ou yearly. Obrigatório se isRecurring=true.Resposta
Sucesso (200)
{
"success": true,
"data": {
"id": "pr_123456789",
"title": "Conta de luz",
"amount": 150.00,
"dueDate": "2024-12-15",
"reminderTime": "2024-12-14T09:00:00Z",
"status": "active",
"isRecurring": false,
"recurrencePattern": null,
"createdAt": "2024-11-27T15:30:00Z",
"updatedAt": "2024-11-27T15:30:00Z"
},
"message": "Payment reminder created successfully: Conta de luz",
"timestamp": "2024-11-27T15:30:00Z"
}
Erro de Validação (400)
{
"error": "Invalid or missing title",
"message": "Title must be a non-empty string"
}
{
"error": "Invalid or missing dueDate",
"message": "dueDate must be provided in YYYY-MM-DD format"
}
{
"error": "Invalid recurrence configuration",
"message": "recurrencePattern is required when isRecurring is true"
}
Erro de Autenticação (401)
{
"error": "Invalid or inactive API key",
"message": "Please check your API key and try again",
"type": "invalid_api_key"
}
Erro de Quota Excedida (403)
{
"success": false,
"error": "Quota exceeded",
"message": "Limite de lembretes atingido. Você já tem 10 lembretes ativos e seu plano PRO permite até 10 lembretes."
}
Campos da Resposta
boolean
required
Indica se a requisição foi bem-sucedida
object
required
Objeto com os dados do lembrete criado
Show Payment Reminder Object
Show Payment Reminder Object
string
required
Identificador único do lembrete
string
required
Título do lembrete
number
Valor do pagamento em BRL (pode ser null)
string
Data de vencimento (YYYY-MM-DD)
string
Data/hora do lembrete (ISO 8601)
string
required
Status:
active, completed, ou inactiveboolean
required
Se o lembrete é recorrente
string
Padrão de recorrência:
daily, weekly, monthly, ou yearlystring
required
Data de criação (ISO 8601)
string
required
Data da última atualização (ISO 8601)
string
required
Mensagem de confirmação da criação
string
required
Timestamp da requisição em formato ISO 8601
Exemplos de Uso
cURL
# Criar lembrete único
curl -X POST 'https://www.pierre.finance/tools/api/create-payment-reminder' \
-H 'Authorization: Bearer sk-your-api-key-here' \
-H 'Content-Type: application/json' \
-d '{
"title": "Conta de luz",
"amount": 150.00,
"dueDate": "2024-12-15"
}'
# Criar lembrete recorrente mensal
curl -X POST 'https://www.pierre.finance/tools/api/create-payment-reminder' \
-H 'Authorization: Bearer sk-your-api-key-here' \
-H 'Content-Type: application/json' \
-d '{
"title": "Aluguel",
"amount": 1500.00,
"dueDate": "2024-12-05",
"isRecurring": true,
"recurrencePattern": "monthly"
}'
JavaScript
const API_KEY = 'sk-your-api-key-here';
const BASE_URL = 'https://www.pierre.finance/tools/api';
async function createPaymentReminder(title, dueDate, amount = null, isRecurring = false, recurrencePattern = null) {
const body = {
title,
dueDate,
...(amount && { amount }),
...(isRecurring && { isRecurring, recurrencePattern })
};
const response = await fetch(`${BASE_URL}/create-payment-reminder`, {
method: 'POST',
headers: {
'Authorization': `Bearer ${API_KEY}`,
'Content-Type': 'application/json'
},
body: JSON.stringify(body)
});
return await response.json();
}
// Exemplos de uso
createPaymentReminder('Conta de luz', '2024-12-15', 150);
createPaymentReminder('Aluguel', '2024-12-05', 1500, true, 'monthly');
Python
import requests
from datetime import datetime, timedelta
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 create_payment_reminder(title, due_date, amount=None, is_recurring=False, recurrence_pattern=None):
data = {
'title': title,
'dueDate': due_date
}
if amount:
data['amount'] = amount
if is_recurring:
data['isRecurring'] = is_recurring
data['recurrencePattern'] = recurrence_pattern
response = requests.post(f'{BASE_URL}/create-payment-reminder',
headers=headers, json=data)
return response.json()
# Exemplos de uso
reminder = create_payment_reminder('Conta de luz', '2024-12-15', 150)
recurring = create_payment_reminder('Aluguel', '2024-12-05', 1500, True, 'monthly')
Códigos de Status
200: Sucesso - Lembrete criado400: Parâmetros inválidos401: Erro de autenticação ou assinatura403: Quota excedida - limite de lembretes atingido500: Erro interno do servidor
Limites por Plano
- BASIC: 5 lembretes ativos
- PRO: 10 lembretes ativos
- PREMIUM: 30 lembretes ativos
Recorrência
Os lembretes recorrentes são renovados automaticamente após a data de vencimento:- daily: Todos os dias no mesmo horário
- weekly: Toda semana no mesmo dia da semana
- monthly: Todo mês no mesmo dia do mês
- yearly: Todo ano na mesma data
As notificações são enviadas via WhatsApp e Email no horário configurado. Se não especificado, o lembrete será enviado 1 dia antes do vencimento às 9h (horário de Brasília).
Para contas mensais fixas como aluguel, internet e outros serviços, use lembretes recorrentes para receber notificações automáticas todo mês.
Authorizations
API key in Bearer token format. Example: Bearer sk-your-api-key-here
Body
application/json

