Set hold top-up

POST

/v1/actions/hospitality.action.set_hold_top_up/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_hold_top_up/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "enabled": true, "interval_minutes": 1, "max_per_stay": 1, "threshold": { "amount": "example", "currency": "example" } }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

• Production API

Set whether the night audit tops up an in-house stay’s card hold as its bill grows. On, after each audit the card rail works out, for every in-house stay with a pending hold, OPERA’s top-up — the bill’s balance, less what the stay’s pending holds hold, plus the allowance of the incidental-hold rule the stay’s booking matches (for the nights still to come) — and when that excess is more than threshold places it as a second hold (hold_purpose = top_up) on the card the stay’s hold was taken on, off-session (the card must carry the guest’s consent to merchant-initiated charges), or raises the hold itself where the card and the account allow incremental authorisation. At most max_per_stay top-ups a stay (1 to 10, default 3): each is a hold on the guest’s card until check-out. A refusal is recorded on the stay for the desk. Off (enabled: false, the default) the audit tops up nothing; set_credit_limit_overage still acts once a bill reaches what is held. With interval_minutes (60 to 1440) the card rail also plans the house’s in-house stays that often between audits — OPERA’s scheduler, “every 60 minutes or more” — skipping a stay whose last top-up or refusal is inside the interval, and one whose refusal still stands (the card is not asked again before the audit or the desk); 0 or unset (the default), only the audit and the desk’s Top up now.

Effects: modify hospitality.property.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.set_hold_top_up:apply

Request Body^required

Media typeapplication/json

object

branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid

params

required

object

enabled

required

Whether the night audit tops holds up

boolean

interval_minutes

How often between audits the card rail plans the top-ups, in minutes (60 to 1440; 0 or unset: at the audit and on the desk's press only)

integer

max_per_stay

The most top-ups for one stay (default 3)

integer

threshold

The smallest excess worth a top-up (required when enabled; 0 tops up any excess)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.property

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json

ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked unlinked properties_updated end_dated

link_type

required

string

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: modified

object_type

required

Allowed values: hospitality.property

warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked"
    }
  ],
  "modified_objects": [
    {
      "kind": "modified",
      "object_type": "hospitality.property"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.