Rent Receipts

Confirm rent was received (landlord, one-click, no login)

The landlord opens this from the reminder email sent at the rent due date, and the whole month closes in one click: the payment is recorded as PAID, the rent receipt is generated, and it is sent to the tenant: subject to the usual entitlement and consent gates.

GET because it is opened by following a link in an email client, not by a form. It is nonetheless a write, and a single-use one: the token is consumed after the work succeeds, so a refresh answers 410 rather than emitting a second receipt. The consumption happens after the action, deliberately, if generation had failed, the link is still good for a retry.

No Authorization header: the token in the query string is the credential.

get/public/rent/confirm

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/public/rent/confirm
  • Auth: none required

Query parameters

tokenstring required

Single-use token from the reminder email.

Response

Payment recorded and the receipt issued.

confirmedboolean
summaryobject

What was produced: the receipt and its delivery outcome.

Example response

{
  "confirmed": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.