Skip to content

Transfer booking hold

POST
/v1/actions/hospitality.action.transfer_booking_hold/apply
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.transfer_booking_hold/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": {}, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.folio" } }'

Use the card hold the guest placed at booking as the stay’s hold, instead of taking a second one at check-in. Targets the stay’s folio; every completed preauthorization request on the booking behind it whose hold is still uncaptured (pending) on the booking’s own account moves onto this folio, so the check-out capture takes it against what the stay owes. Ledger-neutral — a pending hold moves no balance. Refused when the folio is closed or void, hangs off no stay, is kept in another currency than the hold, or the booking has no such hold; a hold already on this folio changes nothing, so a repeated call is safe. Emits payment.booking_hold_transferred.recorded per hold moved.

Effects: unlink hospitality.link.folio_has_payment; link hospitality.link.folio_has_payment.

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
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.folio

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: unlinked end_dated linked
link_type
required
Allowed values: hospitality.link.folio_has_payment
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: created modified deleted
object_type
required
string
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": "unlinked",
"link_type": "hospitality.link.folio_has_payment"
}
],
"modified_objects": [
{
"kind": "created"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.