Post charge by credential

POST

/v1/actions/hospitality.action.post_charge_by_credential/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.post_charge_by_credential/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "amount": { "amount": "example", "currency": "example" }, "description": "example", "device_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "token": "example" }, "return_modified": false }'

• Production API

The tap: post a charge to a folio identified by an access-credential token instead of a folio id — the terminal reads the card UID, the kernel resolves token → active credential → in-house stay → open folio and posts through the same primitives as post_charge (bucket = the outlet’s USALI department, charge_at_outlet + charge_via_credential linked, folio balance adjusted atomically). Requires an active registered device; enforces the credential’s per_charge_cap and property-local-business-day daily_cap; holds the stay to its posting rules (set_posting_rules) as the till’s tenders are held — a no-post stay refuses the tap (no_post: …), and so does one whose credit it would pass (no_credit: …), with no override on this path; fails closed with one generic error for unknown, revoked, expired, or checked-out credentials. The staff name-echo happens first via the resolve_access_credential function. Emits charge.posted.recorded with credential and device attribution.

Effects: create hospitality.charge; link hospitality.link.folio_has_charge; link hospitality.link.charge_at_outlet; link hospitality.link.charge_via_credential; modify hospitality.folio.

Authorizations

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

Charge amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

description

Charge description (defaults to the outlet name)

string

device_id

required

Registered terminal the tap happened on

string format: uuid

outlet_id

required

Revenue center posting the charge

string format: uuid

token

required

Opaque vendor token read at tap time

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

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_charge hospitality.link.charge_at_outlet hospitality.link.charge_via_credential

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

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.