Saltar para o conteúdo
RemindCash

Acompanhamento de pagamentos

Registe os pagamentos que o seu cliente comunicou e pause, retome ou cancele os lembretes de 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.

O RemindCash não processa pagamentos. Quando o seu cliente lhe paga, registe o pagamento para que os lembretes usem o montante em falta — ou parem quando estiver totalmente pago.

Registar um pagamento

POST /v1/receivables/{id}/payments regista um pagamento comunicado. Precisa da permissão receivables:write e de um Idempotency-Key.

Campo Obrigatório Regras
amount Sim String decimal positiva, até duas casas decimais.
BASH
curl https://api.remindcash.com/v1/receivables/1/payments \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: payment-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{ "amount": "250.00" }'
JSON
{
    "data": {
        "id": 1,
        "receivable_id": 1,
        "amount_minor": 25000,
        "remaining_after_minor": 100000,
        "status_after": "draft",
        "recorded_at": "2026-10-11T12:58:05.000000Z"
    }
}

status_after mostra o estado da cobrança depois do pagamento: uma cobrança ativa passa a partially_paid, e a paid quando já nada falta. Uma cobrança paga não recebe mais lembretes.

Pausar, retomar e cancelar

Método Caminho Permitido a partir de
POST /v1/receivables/{id}/pause active, partially_paid
POST /v1/receivables/{id}/resume paused (quando foi pausada a partir de ativa ou parcialmente paga)
POST /v1/receivables/{id}/cancel draft, active, paused, partially_paid, disputed

Cada pedido precisa de um reason com 10 a 500 caracteres e de um Idempotency-Key. O motivo fica guardado no histórico de auditoria da cobrança.

BASH
curl https://api.remindcash.com/v1/receivables/1/pause \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: pause-inv-1042-000001" \
  --header "Content-Type: application/json" \
  --data '{ "reason": "O cliente pediu mais uma semana." }'
JSON
{
    "data": {
        "id": 1,
        "status": "paused",
        "paid_minor": 0,
        "version": "049a6c669d9211215001be5a324c3f5c9e057797ef4d89e21c8aa632578a87ae"
    }
}

Retomar também exige um contacto do cliente verificado e elegível e um saldo em falta. Uma mudança que não seja permitida a partir do estado atual devolve 422 validation_failed com um erro no campo action. Retomar nunca repete os passos de lembrete que foram ignorados durante a pausa.