Refund payment
const url = 'https://api.aerandil.com/v1/actions/hospitality.action.refund_payment/apply';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","params":{"psp_refund_reference":"example","refund_amount":{"amount":"example","currency":"example"},"refund_correlation_id":"example","refund_initial_status":"pending","refund_note":"example","refund_reason":"duplicate","refund_requested_at":"2026-04-15T12:00:00Z","refund_trace_reference":"example","refund_trace_reference_type":"arn"},"return_modified":false,"target":{"id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","object_type":"hospitality.payment"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.aerandil.com/v1/actions/hospitality.action.refund_payment/apply \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "psp_refund_reference": "example", "refund_amount": { "amount": "example", "currency": "example" }, "refund_correlation_id": "example", "refund_initial_status": "pending", "refund_note": "example", "refund_reason": "duplicate", "refund_requested_at": "2026-04-15T12:00:00Z", "refund_trace_reference": "example", "refund_trace_reference_type": "arn" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.payment" } }'Record a refund request as a negative-amount Payment leg linked to the original settled payment via payment_refunds_payment. Validators reject: target not settled, target already a refund leg, target not linked to one folio, refund_amount non-positive, currency mismatch, concurrent pending refund leg, remaining refundable balance exceeded, missing reason, reason = other without note, missing correlation id. Atomically inserts a refund Payment (payment_kind = refund, amount = -refund_amount, method copied from the original, status = pending unless refund_initial_status = refunded for synchronous PSP-confirmed refunds), writes folio_has_payment and payment_refunds_payment links, and (for refunded initial status) sets refund_resolved_at = received_at. v1 admits partial and multiple-partial refunds against the same original payment; unreferenced refunds / stand-alone credits are deferred per proposal 0019 §1 and §10.5. Money leaves the house, so agent principals cannot apply it directly: an agent stages it via propose_action and a human confirms (agent_confirm_required).
Effects: create hospitality.payment; link hospitality.link.folio_has_payment; link hospitality.link.payment_refunds_payment; link hospitality.link.payment_for_reservation; modify hospitality.folio; modify hospitality.reservation.
Step-up: a person (a User principal) needs a fresh desk step-up proof — A refund sends money back out of the house — or the call is refused 403 step_up_required before anything runs. Re-enter the passcode at POST /v1/desk/sessions/{id}/passcode and retry. Machine principals are not gated.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
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).
object
object
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.
object
Responses
Section titled “Responses”Action applied. modified_objects and modified_links populated when return_modified: true was supplied.
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
Per-invocation correlation id; matches events.correlation_id for every event this action appended.
Links established or removed by this invocation. Empty when the caller did not request return_modified.
object
Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.
object
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.
object
Human-readable summary, suitable for logging or operator-UI surfacing.
Object type the warning was raised against.
Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.
Stable kebab-case rule identifier (e.g. comp-authority-over-limit).
Example
{ "modified_links": [ { "kind": "linked", "link_type": "hospitality.link.folio_has_payment" } ], "modified_objects": [ { "kind": "created", "object_type": "hospitality.payment" } ]}step_up_required — a person applied this without a fresh desk step-up proof; nothing ran.
Conflict — concurrent modification or unique constraint violation.
Validation error — parameter validation or business-rule violation.