Skip to content
aerandil.com
GitHub

A receipt as Epson ePOS-Print XML

GET
/v1/fnb/receipts/{receipt_id}/epos
curl --request GET \
  --url 'https://api.aerandil.com/v1/fnb/receipts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/epos?drawer=0' \
  --header 'Authorization: Bearer <token>'

The receipt’s lines as an Epson ePOS-Print <epos-print> document (<text>, <feed>, <cut type="feed"/>) for a client printing on its own LAN. drawer=1 adds the cash-drawer kick (<pulse drawer="drawer_1"/>) — only when the receipt took cash. Deterministic: the same receipt is the same bytes. 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

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
receipt_id
required
string format: uuid

The hospitality.check_receipt a settled check was issued.

Query Parameters

Section titled “Query Parameters”
drawer
string
Allowed values: 0 1

1 adds the drawer kick, when the receipt took cash.

Responses

Section titled “Responses”

200

Section titled “200”

The <epos-print> document.

Media typetext/xml
string

Headers

Section titled “Headers”
Cache-Control
string

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

403

Section titled “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}).

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

404

Section titled “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}).

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