Ask for an invitation
Menu

API reference

Receipts and POS

A receipt is created when an order becomes paid or overpaid, at https://pay.orrerie.com/r/<rcpt_id>. Point-of-sale devices are paired in the dashboard by a signed-in member; the API lists them so that orders with source: "pos" can be attributed.

The receipt object

JSON

{
  "id": "rcpt_ppaxx20nbqv0kqgkwcxcc5xh",
  "object": "receipt",
  "livemode": true,
  "created": "2026-10-11T14:09:55.764Z",
  "number": "R-000913",
  "order": "ord_0zymngngvf12b8b2cra7tb8e",
  "url": "https://pay.orrerie.com/r/rcpt_ppaxx20nbqv0kqgkwcxcc5xh",
  "pdf": "file_bged6qxyg8ntsnnaajz3gjsw",
  "sent_to": "jane@example.com",
  "sent_at": "2026-10-11T14:09:57.100Z"
}

The pos_device object

JSON

{
  "id": "pos_zhxsff7zdsj8k6tshhkns7df",
  "object": "pos_device",
  "livemode": true,
  "created": "2026-09-20T12:00:00.000Z",
  "label": "Front counter tablet",
  "status": "paired",
  "paired_by": "mem_re2bmvrnbzsbefcwx64ftp5w",
  "display_url": "https://pay.orrerie.com/pos/pos_zhxsff7zdsj8k6tshhkns7df",
  "last_seen_at": "2026-10-11T13:58:00.000Z"
}
Table: The pos_device object
FieldMeaning
statusOne of paired, revoked.

Every field

Fields of the receipt object

Fields of the receipt object
FieldTypeMeaning
idstringUnique identifier: the object prefix, an underscore, 24 lower-case Crockford base32 characters.
objectstringThe type of this object.
livemodebooleantrue for live mode (real money); false for test mode (simulated payments).
createdstring (date-time)When the object was created. RFC 3339, UTC, milliseconds.
numberstringThe receipt number.
orderstringThe ord_ id the receipt is for.
urlstringThe receipt's page on the payer site.
pdfstring or nullThe file_ id of the receipt's PDF; null until it is made.
sent_tostring or nullThe email the receipt was sent to; null when it was not sent.
sent_atstring (date-time) or nullWhen it was sent; null when it was not.

Fields of the pos_device object

Fields of the pos_device object
FieldTypeMeaning
idstringUnique identifier: the object prefix, an underscore, 24 lower-case Crockford base32 characters.
objectstringThe type of this object.
livemodebooleantrue for live mode (real money); false for test mode (simulated payments).
createdstring (date-time)When the object was created. RFC 3339, UTC, milliseconds.
labelstringThe till's name, as the merchant set it.
statusstringOne of paired, revoked.
paired_bystringThe mem_ id of the member who paired it.
display_urlstringThe page the till shows to payers.
last_seen_atstring (date-time) or nullWhen the device last reached Orrerie; null until it has.

Endpoints

Events

Webhook events whose data.object is an object of this page.