Charge an order to a folio

Posts an order completed on a connected POS provider's terminal, such as Clover, to a reservation's or group's folio, with its items, taxes, discounts and service charges. The terminal's merchant must be connected to the property; otherwise 403 (integration_disconnected).

Idempotency-Key is required: retrying with the same key returns the original result, and reusing a key with a different payload returns 409. A failed post writes nothing to the folio. To correct a charge, void it and charge again with a new key.

Errors return detail as {code, message, retryable}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
enum
required

Device-selectable folio targets only — no houseAccount (that's the FRS path).

Allowed:
order
object
required

The verbatim vendor order pos-service maps.

string
required

Vendor order id; reused as the Check API checkId.

Headers
required
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json