What-if Capture authorised charge (rollup delta)

POST

/v1/actions/hospitality.action.capture_authorised_charge/whatif

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.capture_authorised_charge/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "acquirer_reference_number": "example", "captured_amount": { "amount": "example", "currency": "example" }, "captured_at": "2026-04-15T12:00:00Z", "card_present": true, "fee_class": "domestic_standard", "platform_fee": { "amount": "example", "currency": "example" }, "processor_fee_estimate": { "amount": "example", "currency": "example" }, "psp_capture_reference": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.payment" } }'

• Production API

What-if projection of apply_hospitality_action_capture_authorised_charge — previews the action (execute-and-roll-back) and folds its would-be events into rollup deltas, returning the contribution an apply would make to the daily_rooms fact (ADR / RevPAR / TRevPAR / Occupancy inputs) without persisting anything. Requires the same actions:hospitality.action.capture_authorised_charge:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

Authorizations

• aerandil_oauth

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

acquirer_reference_number

23-digit ARN if available (often null at capture time; lands hours later via PSP reconciliation)

string

captured_amount

Captured amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

captured_at

PSP-side capture confirmation timestamp (defaults to now)

string format: date-time

card_present

Whether the fee was priced as card-present

boolean

fee_class

The card's class the fee was priced by

string

Allowed values: domestic_standard domestic_premium regional international

platform_fee

Platform fee

object

amount

required

string format: decimal

currency

required

string format: iso-4217

processor_fee_estimate

Fee estimate

object

amount

required

string format: decimal

currency

required

string format: iso-4217

psp_capture_reference

PSP-issued capture reference (Stripe charge.id / Adyen capture pspReference / Checkout.com action_id / Cybersource capture id)

string

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

Responses

200

Rollup deltas the action would contribute, computed and rolled back.

Media typeapplication/json

object

daily_rooms

required

Per (property, business_date) additive contribution to the rooms rollup.

Array<object>

object

business_date

required

string format: date

currency

ISO 4217, when the fold observed one.

string

property_id

required

string format: uuid

rooms_revenue_net_delta

required

Decimal, net rooms revenue delta.

string

rooms_sold_delta

required

integer format: int64

total_revenue_net_delta

required

Decimal, net total revenue delta.

string

Example^generated

{
  "daily_rooms": [
    {
      "business_date": "2026-04-15",
      "currency": "example",
      "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "rooms_revenue_net_delta": "example",
      "rooms_sold_delta": 1,
      "total_revenue_net_delta": "example"
    }
  ]
}

Headers

Cache-Control

string

Allowed value: no-store

Always no-store — derived, uncommitted data.

422

Validation error — the apply would be rejected.