Authorise charge with review

POST

/v1/actions/hospitality.action.authorise_charge_with_review/apply

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

• Production API

Record a payment authorisation event with the fraud-risk assessment gate enforced as a structural precondition. Validators reject: assessment not fresh / suggested, band = block, assessment already linked to another payment, payment token shaped like a PAN, liability-shift basis incoherent with authentication outcome, TRA / low-value amount ceiling exceeded, capture_strategy incoherent with band, folio closed or void. Atomically inserts a Payment row (status = pending for manual_capture_after_review / authorise_only, settled for auto_capture_if_clear) with the decision-provenance trio, and transitions the assessment to applied with applied_action_kind = approve_proceed.

Effects: create hospitality.payment; modify hospitality.fraud_risk_assessment; modify hospitality.folio; link hospitality.link.folio_has_payment; link hospitality.link.payment_for_fraud_assessment.

Authorizations

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

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

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_for_fraud_assessment

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 modified

object_type

required

Allowed values: hospitality.payment hospitality.fraud_risk_assessment 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.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.