Request payment

POST

/v1/actions/hospitality.action.request_payment/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.request_payment/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "amount": { "amount": "example", "currency": "example" }, "expires_at": "2026-04-15T12:00:00Z", "kind": "payment", "note": "example", "reason": "deposit" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.reservation" } }'

• Production API

Ask the guest for money against this booking (Mews’s payment request): mints a pending payment request the card rail turns into a hosted pay link. reason defaults to deposit and kind to payment; preauthorization asks for a hold captured later through the authorise path. amount defaults, for a deposit or prepayment, to what the booking still owes (deposit_required_amount less deposit_paid_amount), and expires_at to the booking’s deposit_due_at; one of each must resolve. Asking for a deposit when nothing is owed, or when a pending request for the same reason and kind already exists, changes nothing — so the booking automation can fire it on every new booking, and a re-delivered event asks once. A pending request is withdrawn by the booking it asks for: cancelling or no-showing the booking cancels it (reservation_cancelled / no_show), and a modification that re-derives the unpaid deposit cancels a deposit request (deposit_changed) without re-asking — the automation or the desk asks again for the new figure. Emits payment_request.requested.recorded.

Effects: create hospitality.payment_request; link hospitality.link.payment_request_for_reservation; create hospitality.folio; link hospitality.link.reservation_has_folio.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.request_payment: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

amount

What to ask for; defaults to the unpaid deposit

object

amount

required

string format: decimal

currency

required

string format: iso-4217

expires_at

When the request lapses; defaults to the deposit due date

string format: date-time

kind

payment (default) or preauthorization

string

Allowed values: payment preauthorization

note

What the guest reads beside the amount

string

reason

Why the house is asking (default deposit)

string

Allowed values: deposit prepayment fee payment_card_missing payment_card_declined authentication_required

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

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

link_type

required

Allowed values: hospitality.link.payment_request_for_reservation hospitality.link.reservation_has_folio

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

object_type

required

Allowed values: hospitality.payment_request hospitality.folio

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",
      "link_type": "hospitality.link.payment_request_for_reservation"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.payment_request"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.