Skip to the page

Praecise Platform

Rivier/ Reference/ bookings

Record money taken at the desk or returned against the folio

post/lodging/reservations/{id}/payments

Record money taken at the desk or returned against the folio. A person with approval rights.

Before you call

Credential: Authorization: Bearer $KEY
Scope: bookings:write
Sdk: bookings.folio.recordPayment
Cli: bookings folio record payment

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

kindstring
One of: payment, refund. Default: payment.
amountMinorintegerrequired
At least 1. At most 9007199254740991.
refstringrequired
At most 120 characters.
methodstring
Default: . At most 40 characters.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/lodging/reservations/{id}/payments' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "amountMinor": 0,
  "ref": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown