Concepten

Bedrijven en sleutels, te ontvangen statussen, bedragen in kleine eenheden, lokale vervaldagen en versies.

Ondernemingen

Elke API-sleutel behoort tot precies één bedrijf. Een sleutel kan alleen de administratie van dat bedrijf zien en wijzigen. Vragen om een ID die behoort tot een ander bedrijf geeft 404 not_found terug, zodat de gegevens van andere bedrijven niet kunnen worden ontdekt.

Ontvangen statussen

Status	Betekenis
`draft`	Aangemaakt maar niet actief. Er zijn geen herinneringen gepland of verzonden.
`active`	Herinneringen volgen het schema van het bedrijf.
`partially_paid`	Een deel van het bedrag werd als betaald geregistreerd; herinneringen gebruiken het resterende bedrag.
`paid`	- De herinneringen stoppen.
`paused`	Herinneringen staan in de wacht totdat ze hervat worden.
`disputed`	De klant betwist het bedrag; er worden geen herinneringen verstuurd.
`cancelled`	Gesloten zonder betaling. Er worden geen herinneringen verstuurd.

Bedragen

Verzend bedragen als strings met maximaal twee decimalen, bijvoorbeeld "1250.00". Een komma wordt geaccepteerd als decimale scheidingsteken ("1250,50"). De bedragen moeten positief zijn.

Reacties terug integer minor units: amount_minor: 125000 is 1.250,00. Ondersteunde valuta's zijn EUR, GBP, TRY en USD. RemindCash zet nooit om tussen valuta's.

Data en tijden

due_date is een local kalenderdatum in YYYY-MM-DD formaat, geen tijdstempel.
Instanten zoals recorded_at of submitted_at zijn ISO 8601 tijdstempels in UTC.
Herinnering verzendtijden worden berekend in de tijdzone van het bedrijf (of de klant) IANA, inclusief daglicht-sparende veranderingen.

Versies

Elke te ontvangen respons bevat een version . . een 64-teken vingerafdruk van de huidige staat. Pass het als expected_version wanneer u update een ontwerp. Als de tegoed gewijzigd in de tussentijd, de update is afgewezen met 409 conflict in plaats van nieuwere gegevens te overschrijven.

Herinnering en veiligheid

API-oproepen versturen nooit herinneringen. Verzenden wordt besloten door de herinnerings-engine na activering in de app. Voordat elke verzend het opnieuw controleert de te ontvangen status, betaald bedrag, klant opt-out, plan en kanaal gereedheid, dus een de vordering die betaald of gepauzeerd is, wordt niet herinnerd.