Queue a receipt for the house's printer

POST

/v1/fnb/receipts/{receipt_id}/print

curl --request POST \
  --url https://api.aerandil.com/v1/fnb/receipts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/print \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "device_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "drawer": false }'

• Production API

Queues the receipt for a registered printer (hospitality.device, kind = printer, active, at the receipt’s house, with a poll credential). The printer fetches it on its next Server Direct Print poll (POST /v1/print/epson/sdp); the job is queued, then printing once handed over, then printed or failed as the printer reports. drawer: true kicks the cash drawer — only for a receipt that took cash, within ten minutes of its issue (a reprint never opens the drawer). Idempotency-Key makes a retried press one job. Read through hospitality.function.fnb_receipt under the caller’s own context: its grant, the house gate, and — for a till — the till’s own outlet (another outlet’s receipt is 403 outlet_out_of_scope).

Authorizations

• aerandil_oauth
  functions:invoke
• aerandil_oauth
  functions:hospitality.function.fnb_receipt:invoke

Parameters

Path Parameters

receipt_id

required

string format: uuid

The hospitality.check_receipt a settled check was issued.

Header Parameters

Idempotency-Key

string

>= 1 characters

Opaque idempotency token (Stripe-shape). Repeated POSTs with the same key replay the original response within the cache TTL rather than creating a duplicate object.

Request Body^required

Media typeapplication/json

object

device_id

required

The printer (hospitality.device, kind = printer).

string format: uuid

drawer

Kick the cash drawer — a receipt that took cash, within ten minutes of its issue.

boolean

Responses

201

The print job, queued.

Media typeapplication/json

object

created_at

required

string format: date-time

device_id

required

string format: uuid

drawer

required

boolean

idempotent_replay

boolean

job_id

required

integer format: int64

receipt_id

required

string format: uuid

status

required

string

Allowed values: queued printing printed failed

Example

{
  "status": "queued"
}

Headers

Cache-Control

string

Always no-store. Object and link state is live data and is never cacheable.

403

The bearer authenticated but does not hold the scope this operation requires.

Media typeapplication/json

Structured error wrapper. Every non-2xx response from any Aerandil endpoint serialises to this shape; the HTTP status carries the failure class (4xx/5xx), the body adds a stable code for programmatic dispatch plus a human-readable message.

object

error

required

object

code

required

Stable, programmatic error code (e.g. unauthorized, forbidden, not_found, invalid_body, invalid_url, precondition_failed, no_secondary_key). Clients dispatch on code, not on the message (which may be localised or contextualised in future versions).

string

instance_id

Request-id correlation handle echoed on the request-id response header — support teams correlate without scraping logs.

string

message

required

Human-readable explanation of the failure.

string

parameters

Per-error structured detail. The shape varies by code (e.g. forbidden_action carries {"action": "..."}; precondition_failed carries {"current_version": N}).

Example^generated

{
  "error": {
    "code": "example",
    "instance_id": "example",
    "message": "example",
    "parameters": "example"
  }
}

404

No such object in the caller’s tenant — which is also the answer when it exists in another tenant, by design.

Media typeapplication/json

Structured error wrapper. Every non-2xx response from any Aerandil endpoint serialises to this shape; the HTTP status carries the failure class (4xx/5xx), the body adds a stable code for programmatic dispatch plus a human-readable message.

object

error

required

object

code

required

Stable, programmatic error code (e.g. unauthorized, forbidden, not_found, invalid_body, invalid_url, precondition_failed, no_secondary_key). Clients dispatch on code, not on the message (which may be localised or contextualised in future versions).

string

instance_id

Request-id correlation handle echoed on the request-id response header — support teams correlate without scraping logs.

string

message

required

Human-readable explanation of the failure.

string

parameters

Per-error structured detail. The shape varies by code (e.g. forbidden_action carries {"action": "..."}; precondition_failed carries {"current_version": N}).

Example^generated

{
  "error": {
    "code": "example",
    "instance_id": "example",
    "message": "example",
    "parameters": "example"
  }
}

409

idempotency_in_flight.

Media typeapplication/json

Structured error wrapper. Every non-2xx response from any Aerandil endpoint serialises to this shape; the HTTP status carries the failure class (4xx/5xx), the body adds a stable code for programmatic dispatch plus a human-readable message.

object

error

required

object

code

required

Stable, programmatic error code (e.g. unauthorized, forbidden, not_found, invalid_body, invalid_url, precondition_failed, no_secondary_key). Clients dispatch on code, not on the message (which may be localised or contextualised in future versions).

string

instance_id

Request-id correlation handle echoed on the request-id response header — support teams correlate without scraping logs.

string

message

required

Human-readable explanation of the failure.

string

parameters

Per-error structured detail. The shape varies by code (e.g. forbidden_action carries {"action": "..."}; precondition_failed carries {"current_version": N}).

Example^generated

{
  "error": {
    "code": "example",
    "instance_id": "example",
    "message": "example",
    "parameters": "example"
  }
}

422

invalid_body, device_not_printer, device_not_active, printer_not_configured (no poll credential), drawer_not_allowed, idempotency_key_mismatch.

Media typeapplication/json

Structured error wrapper. Every non-2xx response from any Aerandil endpoint serialises to this shape; the HTTP status carries the failure class (4xx/5xx), the body adds a stable code for programmatic dispatch plus a human-readable message.

object

error

required

object

code

required

Stable, programmatic error code (e.g. unauthorized, forbidden, not_found, invalid_body, invalid_url, precondition_failed, no_secondary_key). Clients dispatch on code, not on the message (which may be localised or contextualised in future versions).

string

instance_id

Request-id correlation handle echoed on the request-id response header — support teams correlate without scraping logs.

string

message

required

Human-readable explanation of the failure.

string

parameters

Per-error structured detail. The shape varies by code (e.g. forbidden_action carries {"action": "..."}; precondition_failed carries {"current_version": N}).

Example^generated

{
  "error": {
    "code": "example",
    "instance_id": "example",
    "message": "example",
    "parameters": "example"
  }
}