Record deposit payment

POST

/v1/actions/hospitality.action.record_deposit_payment/apply

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

• Production API

Record a deposit taken before arrival. The money lands on the booking’s own account — opened here if this is the first — as an ordinary settled payment, and deposit_paid_amount / prepayment_status advance on the reservation. At check-in apply_deposit_to_folio moves it onto the stay’s folio; until then the account is where it is, which is what makes it visible, billable and refundable. Pass psp_reference for a deposit taken on a card: without the processor’s own reference the payment can be found but not returned, and a refund becomes a ledger gesture instead of money moving.

Effects: modify hospitality.reservation; create hospitality.payment; create hospitality.folio; link hospitality.link.reservation_has_folio; link hospitality.link.folio_has_payment; link hospitality.link.payment_for_reservation; modify hospitality.folio.

Authorizations

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

method

required

Payment method

string

Allowed values: cash credit_card debit_card bank_transfer voucher loyalty_points direct_billing mobile_wallet ota_collected other

payment_amount

required

Payment amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

psp_reference

The processor's reference for the charge — the handle a refund acts on, and the only thing that survives into a dispute

string

received_at

required

Received at

string format: date-time

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.reservation_has_folio hospitality.link.folio_has_payment hospitality.link.payment_for_reservation

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 created

object_type

required

Allowed values: hospitality.reservation hospitality.payment 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.reservation_has_folio"
    }
  ],
  "modified_objects": [
    {
      "kind": "modified",
      "object_type": "hospitality.reservation"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.