Capture a payment

Records one payment against an order — use it to split a bill across several tenders or guests. When the captured amounts, tips included, reach the order total, the order becomes paid; a capture on a fully paid order is refused.

When the order becomes paid it is posted to Cloudbeds the same way as POST /pos/orders/{order_id}/pay, except an order settled with folio or group_folio, which names a folio chosen in Cloudbeds and is not posted by the POS (folio_status: skipped). Requires a staff token.

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

Payload for capturing a payment against an order.

required
≥ 0
string
enum
required

Voucher number, auth code, link ID, etc.

≥ 0
Headers
Responses

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