Naar de inhoud gaan

Herinnering

Hoe herinneringsschema's werken en hoe de herinnering probeert te lezen voor een te ontvangen.

Openbare API-status

De v1 API maakt gebruik van company-scoped toonder keys en vereist een actieve planning periode. Ontwerp en betaling rapportage eindpunten niet verzenden klantenberichten. Voorbeelden gebruiken plaatshouders .Plakken nooit een echte sleutel in gedeelde code.

Hoe herinneringen worden gepland

Elke actieve schuldvordering volgt het herinneringsschema van het bedrijf. De standaard stuurt 3 dagen voor, on en 3 dagen na de vervaldatum; bedrijven kunnen toevoegen, verwijderen of stapjes verplaatsen in de app. Herinneringen worden verzonden binnen de toegestane uren van het bedrijf (standaard 09:00

Herinneringen stoppen wanneer een tegoed wordt betaald, gepauzeerd, betwist of geannuleerd, en wanneer de klant zich afmeldt.

Lijstherinneringspogingen

GET /v1/reminder-attempts geeft eerst de leveringspogingen voor één ontvangen, nieuwste terug. Het vereist de receivables:read scope.

Zoekparameter Vereist Omschrijving
receivable_id Ja. De te ontvangen om te inspecteren.
per_page Nee 10.000, standaard 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"
}

Het pogingsobject

Veld Omschrijving
id Poging tot identificatie.
attempt_no Pogingsnummer voor die herinneringsstap.
stage_key Tot welke stap van het schema behoort deze poging.
channel Berichtkanaal, bijvoorbeeld email.
provider_state Internal dispatch state: prepared, claimed, sending, accepted, rejected, unknown of cancelled.
delivery_status Genormaliseerde e-mailstatus: queued, sending, accepted, delivered, bounced, failed, unknown of cancelled. null indien niet beschikbaar.
submitted_at Wanneer het bericht werd doorgegeven aan de provider (UTC), of null.
resolved_at Toen de uitkomst werd definitief (UTC), of null.

Het lezen van de levering statussen eerlijk

  • accepted betekent dat de provider het bericht heeft geaccepteerd .not dat het is geleverd of gelezen.
  • delivered wordt alleen weergegeven als de provider de levering meldt.
  • unknown betekent dat de provider niet duidelijk antwoordde (bijvoorbeeld een timeout). RemindCash doet not opnieuw automatisch proberen in dat geval, om te voorkomen dat het verzenden tweemaal; de poging blijft unknown totdat het is verzoend.
  • Een geleverde herinnering markeert nooit een tegoed als betaald.