What-if Refund payment (rollup delta)

POST

/v1/actions/hospitality.action.refund_payment/whatif

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.refund_payment/whatif \
  --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" } }'

• Production API

What-if projection of apply_hospitality_action_refund_payment — 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.refund_payment: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

psp_refund_reference

PSP-issued refund reference (Stripe refund.id / Adyen refund pspReference / Checkout.com action_id / Worldpay refund event ref / Braintree refund transaction id / Cybersource credit id / Mews RefundId)

string

refund_amount

Refund amount (positive; defaults to remaining refundable balance if unset)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

refund_correlation_id

required

Host-side idempotency / reconciliation key (required because two legitimate same-amount partial refunds with the same reason can occur against one payment)

string

refund_initial_status

Initial refund leg status: `pending` (PSP accepted but not yet confirmed; defaults to pending) or `refunded` (PSP confirmed synchronously / importing historical confirmed refund)

string

Allowed values: pending refunded

refund_note

Free-form colour, max 1024 chars (required when refund_reason = other)

string

refund_reason

required

Closed REFUND_REASONS taxonomy

string

Allowed values: duplicate fraudulent requested_by_customer reservation_cancelled deposit_return service_recovery overcharge_correction no_show_policy_exception package_component_refund membership_cancellation chargeback_prevention other

refund_requested_at

Timestamp when the refund was requested / PSP accepted the request (defaults to now)

string format: date-time

refund_trace_reference

Network trace reference for cardholder-side traceability (often unavailable at request time, populated by resolve_payment_refund)

string

refund_trace_reference_type

Type tag on refund_trace_reference

string

Allowed values: arn stan rrn psp_generated unavailable

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.