cURL
curl --request DELETE \
--url https://www.pierre.finance/tools/api/delete-payment-reminder \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.pierre.finance/tools/api/delete-payment-reminder"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.pierre.finance/tools/api/delete-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/delete-payment-reminder",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
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/delete-payment-reminder"
req, _ := http.NewRequest("DELETE", 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))
}HttpResponse<String> response = Unirest.delete("https://www.pierre.finance/tools/api/delete-payment-reminder")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.pierre.finance/tools/api/delete-payment-reminder")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "pr_123456789",
"title": "Conta de luz",
"action": "cancelled",
"hardDelete": false
},
"message": "Payment reminder \"Conta de luz\" cancelled successfully",
"timestamp": "2024-11-27T16:30:00Z"
}
{
"success": true,
"data": {
"id": "pr_123456789",
"title": "Conta de luz",
"action": "deleted permanently",
"hardDelete": true
},
"message": "Payment reminder \"Conta de luz\" deleted permanently successfully",
"timestamp": "2024-11-27T16:30:00Z"
}
Payment Reminders
Delete Payment Reminder
Exclui ou cancela um lembrete de pagamento. Por padrão realiza exclusão lógica (marca como inactive), mas pode fazer exclusão permanente com hardDelete=true. O usuário só pode excluir seus próprios lembretes. Requer API key para autenticação e assinatura ativa.
DELETE
/
tools
/
api
/
delete-payment-reminder
cURL
curl --request DELETE \
--url https://www.pierre.finance/tools/api/delete-payment-reminder \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.pierre.finance/tools/api/delete-payment-reminder"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.pierre.finance/tools/api/delete-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/delete-payment-reminder",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
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/delete-payment-reminder"
req, _ := http.NewRequest("DELETE", 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))
}HttpResponse<String> response = Unirest.delete("https://www.pierre.finance/tools/api/delete-payment-reminder")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.pierre.finance/tools/api/delete-payment-reminder")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "pr_123456789",
"title": "Conta de luz",
"action": "cancelled",
"hardDelete": false
},
"message": "Payment reminder \"Conta de luz\" cancelled successfully",
"timestamp": "2024-11-27T16:30:00Z"
}
{
"success": true,
"data": {
"id": "pr_123456789",
"title": "Conta de luz",
"action": "deleted permanently",
"hardDelete": true
},
"message": "Payment reminder \"Conta de luz\" deleted permanently successfully",
"timestamp": "2024-11-27T16:30:00Z"
}
Este endpoint exclui ou cancela um lembrete de pagamento.
Descrição
O endpointDELETE /tools/api/delete-payment-reminder permite excluir lembretes de pagamento. Por padrão, realiza exclusão lógica (marca como inactive), mas pode fazer exclusão permanente com o parâmetro hardDelete=true. O usuário só pode excluir seus próprios lembretes.
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
ID do lembrete a ser excluído
boolean
required
Se deve fazer exclusão permanente (true) ou apenas cancelar (false, padrão)
string
required
Parâmetro interno para indicar requisições via MCP. Use
s=s para requisições MCP.Resposta
Sucesso (200)
{
"success": true,
"data": {
"id": "pr_123456789",
"title": "Conta de luz",
"action": "cancelled",
"hardDelete": false
},
"message": "Payment reminder \"Conta de luz\" cancelled successfully",
"timestamp": "2024-11-27T16:30:00Z"
}
{
"success": true,
"data": {
"id": "pr_123456789",
"title": "Conta de luz",
"action": "deleted permanently",
"hardDelete": true
},
"message": "Payment reminder \"Conta de luz\" deleted permanently successfully",
"timestamp": "2024-11-27T16:30:00Z"
}
Erro de Validação (400)
{
"error": "Invalid or missing reminderId",
"message": "reminderId must be provided as a query parameter"
}
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 Acesso (403)
{
"error": "Permission denied",
"message": "You do not have permission to delete this reminder"
}
Lembrete Não Encontrado (404)
{
"error": "Reminder not found",
"message": "No reminder found with ID: pr_123456789"
}
Campos da Resposta
boolean
required
Indica se a requisição foi bem-sucedida
object
required
Objeto com informações do lembrete excluído
string
required
Mensagem de confirmação da exclusão/cancelamento
string
required
Timestamp da requisição em formato ISO 8601
Exemplos de Uso
cURL
# Cancelar lembrete (soft delete)
curl -X DELETE 'https://www.pierre.finance/tools/api/delete-payment-reminder?reminderId=pr_123456789' \
-H 'Authorization: Bearer sk-your-api-key-here'
# Excluir permanentemente (hard delete)
curl -X DELETE 'https://www.pierre.finance/tools/api/delete-payment-reminder?reminderId=pr_123456789&hardDelete=true' \
-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 deletePaymentReminder(reminderId, hardDelete = false) {
const params = new URLSearchParams({ reminderId });
if (hardDelete) {
params.append('hardDelete', 'true');
}
const response = await fetch(`${BASE_URL}/delete-payment-reminder?${params}`, {
method: 'DELETE',
headers: {
'Authorization': `Bearer ${API_KEY}`,
'Content-Type': 'application/json'
}
});
return await response.json();
}
// Exemplos de uso
deletePaymentReminder('pr_123456789'); // Cancelar (soft delete)
deletePaymentReminder('pr_123456789', true); // Excluir permanentemente
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 delete_payment_reminder(reminder_id, hard_delete=False):
params = {'reminderId': reminder_id}
if hard_delete:
params['hardDelete'] = 'true'
response = requests.delete(f'{BASE_URL}/delete-payment-reminder',
headers=headers, params=params)
return response.json()
# Exemplos de uso
delete_payment_reminder('pr_123456789') # Cancelar
delete_payment_reminder('pr_123456789', hard_delete=True) # Excluir permanentemente
Códigos de Status
200: Sucesso - Lembrete excluído/cancelado400: Parâmetros inválidos401: Erro de autenticação ou assinatura403: Acesso negado - lembrete pertence a outro usuário404: Lembrete não encontrado500: Erro interno do servidor
Diferença entre Soft Delete e Hard Delete
Soft Delete (Padrão)
- Marca o lembrete como
inactive - Dados são preservados no banco de dados
- Pode ser reativado posteriormente
- Não envia mais notificações
- Libera cota do plano
Hard Delete
- Exclui permanentemente o lembrete
- Dados são removidos do banco de dados
- Não pode ser desfeito
- Libera cota do plano
A exclusão permanente (hardDelete=true) não pode ser desfeita. Use com cautela! Para a maioria dos casos, recomendamos usar o soft delete (padrão) ou atualizar o status para
inactive.Se você quiser apenas pausar um lembrete temporariamente sem excluí-lo, use o endpoint
update-payment-reminder com newStatus: 'inactive' ao invés de excluir.Lembretes cancelados (soft delete) não contam para o limite de quota do plano, assim como lembretes com hard delete.
Authorizations
API key in Bearer token format. Example: Bearer sk-your-api-key-here
Query Parameters
ID do lembrete de pagamento a ser excluído
Se deve fazer exclusão permanente (true) ou apenas cancelar (false, padrão)

