Record external refund

POST

/v1/actions/hospitality.action.record_external_refund/apply

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

• Production API

Mirror a vendor-sourced refund as a pending negative-amount Payment leg against the original settled payment it returns money from — the refund twin of record_external_payment. Replay-safe via external_ref (the payment business key): a second call with the same key is a no-op. Validators reject: target not settled, target already a refund leg, target on no folio or a void folio, zero amount, currency mismatch, and a leg that would take the refunded total past the original. A closed folio is accepted (the vendor’s bill may already be sealed). The amount is taken as a magnitude, since vendors disagree on the sign of a refund. The dispute block and the one-pending-leg rule stay with refund_payment: they guard a refund being sent, and this one already was. The outcome lands via resolve_payment_refund.

Effects: create hospitality.payment; link hospitality.link.folio_has_payment; link hospitality.link.payment_refunds_payment.

Authorizations

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

external_ref

required

Source-system key (makes the record replay-safe)

string

psp_refund_reference

The vendor's processor reference for the refund, when it has one

string

refund_amount

required

Refund amount (magnitude; either sign accepted)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

refund_note

The vendor's free-text reason, max 1024 chars

string

refund_reason

Closed REFUND_REASONS taxonomy (defaults to `other` — vendors send free text, which lands in refund_note)

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

Refund instant in the source system (defaults to now)

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

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

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

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.folio_has_payment"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.payment"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.