Saltar para o conteúdo
RemindCash

Lembretes

Como funcionam os calendários de lembretes e como ler as tentativas de lembrete feitas para uma cobrança.

Estado da API pública

A API v1 usa chaves bearer da empresa e exige um período de plano ativo. Os endpoints de rascunhos e de comunicação de pagamentos não enviam mensagens a clientes. Os exemplos usam marcadores — nunca cole uma chave real em código partilhado.

Como os lembretes são agendados

Cada cobrança ativa segue o calendário de lembretes da empresa. Por predefinição, os lembretes são enviados 3 dias antes, no dia e 3 dias depois da data de vencimento; as empresas podem acrescentar, remover ou mover passos na aplicação. Os lembretes são enviados dentro do horário permitido da empresa (por predefinição, das 09:00 às 18:00, hora local, sem fins de semana) e passam para o horário permitido seguinte em vez de serem enviados duas vezes.

Os lembretes param quando uma cobrança é paga, pausada, contestada ou cancelada, e quando o cliente cancela a receção.

Listar as tentativas de lembrete

GET /v1/reminder-attempts devolve as tentativas de entrega de uma cobrança, das mais recentes para as mais antigas. Exige a permissão receivables:read.

Parâmetro de consulta Obrigatório Descrição
receivable_id Sim A cobrança a consultar.
per_page Não De 1 a 100; predefinição: 25.
BASH
curl "https://api.remindcash.com/v1/reminder-attempts?receivable_id=1" \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"
JSON
{
    "data": [],
    "meta": { "current_page": 1, "per_page": 25, "total": 0 },
    "request_id": "8cfc4494-5a40-4bd9-aa9b-5d5716840140"
}

O objeto da tentativa

Campo Descrição
id ID da tentativa.
attempt_no Número da tentativa para esse passo do lembrete.
stage_key O passo do calendário a que esta tentativa pertence.
channel Canal da mensagem, por exemplo email.
provider_state Estado interno do envio: prepared, claimed, sending, accepted, rejected, unknown ou cancelled.
delivery_status Estado normalizado do e-mail: queued, sending, accepted, delivered, bounced, failed, unknown ou cancelled. null quando não disponível.
submitted_at Quando a mensagem foi entregue ao prestador (UTC), ou null.
resolved_at Quando o resultado se tornou definitivo (UTC), ou null.

Ler os estados de entrega com rigor

  • accepted significa que o prestador aceitou a mensagem — não que foi entregue ou lida.
  • delivered só é mostrado quando o prestador comunica a entrega.
  • unknown significa que o prestador não respondeu de forma clara (por exemplo, um tempo limite esgotado). Nesse caso, o RemindCash não volta a tentar automaticamente, para evitar um envio duplicado; a tentativa fica unknown até ser conciliada.
  • Um lembrete entregue nunca marca uma cobrança como paga.