Skip to content
aerandil.com
GitHub

What-if Authorise charge with review (rollup delta)

POST
/v1/actions/hospitality.action.authorise_charge_with_review/whatif
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.authorise_charge_with_review/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "amount": { "amount": "example", "currency": "example" }, "auth_correlation_id": "example", "authentication_outcome": "frictionless", "authorisation_expires_at": "2026-04-15T12:00:00Z", "capture_strategy": "auto_capture_if_clear", "decision_provider": "example", "decision_provider_case_id": "example", "fraud_risk_assessment_ref": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "hold_purpose": "booking", "liability_shift_basis": "three_ds2_authenticated", "method": "cash", "payment_method_token": "example", "reference": "example", "sca_exemption_claimed": "none" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.folio" } }'

What-if projection of apply_hospitality_action_authorise_charge_with_review — 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.authorise_charge_with_review:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
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
required
Amount
object
amount
required
string format: decimal
currency
required
string format: iso-4217
auth_correlation_id
Host's PSP authorisation reference
string
authentication_outcome
EMV 3DS 2.2 authentication outcome (required when liability_shift_basis = three_ds2_authenticated)
string
Allowed values: frictionless challenge_passed challenge_failed attempted pending_decoupled not_applicable
authorisation_expires_at
Scheme's authorisation-validity window
string format: date-time
capture_strategy
required
Capture strategy
string
Allowed values: auto_capture_if_clear manual_capture_after_review authorise_only
decision_provider
required
Fraud-decision vendor (denormalised from assessment.vendor_id)
string
decision_provider_case_id
required
Vendor's case / decision identifier
string
fraud_risk_assessment_ref
required
Gating assessment
string format: uuid
hold_purpose
Why the hold is placed (booking, check_in, top_up, re_placement, incidentals, no_show, post_stay, other)
string
Allowed values: booking check_in top_up re_placement incidentals no_show post_stay other
liability_shift_basis
required
Liability-shift basis (per-decision, not per-vendor)
string
Allowed values: three_ds2_authenticated provider_guarantee none
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_method_token
PSP-issued opaque token (must NOT be a PAN)
string
reference
Reference
string
sca_exemption_claimed
PSD2 SCA exemption claimed (defaults to none)
string
Allowed values: none low_value tra mit trusted_beneficiary secure_corporate
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

Responses

Section titled “Responses”

200

Section titled “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
Examplegenerated
{
  "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

Section titled “Headers”
Cache-Control
string
Allowed value: no-store

Always no-store — derived, uncommitted data.

422

Section titled “422”

Validation error — the apply would be rejected.