POST API/V40/Interactive/Payment/Outlet/{outletCode}/CapturePreAuthorizedCheck

Capture a pre-authorized payment on an open tab, optionally adding a tip amount.

Request Information

URI Parameters

Name	Description	Type	Additional information
outletCode	The outlet code	string	Required

Body Parameters

The request model

CapturePreAuthorizedCheckRequest

Name	Description	Type	Additional information
GxpCheckNumber		string
TipAmount	Optional tip amount to add to the pre-authorized payment before it's captured	decimal number
OrderFormDetailsDictionary	Dictionary to contain Order Form Details for the outlet, setup in GXP Manager. This is validated against the order form details already stored on the existing order, to ensure the guest capturing payment is the guest (or has details matching the guest) who placed the order.	Dictionary of string [key] and Object [value]
SessionToken	The token associated with this session of API interactions. This token should always be included in API calls, because it contains important session state information.	string	Required

Request Formats

application/json, text/json

Sample:

{
  "gxpCheckNumber": "sample string 1",
  "tipAmount": 1.0,
  "orderFormDetailsDictionary": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "sessionToken": "sample string 2"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseContainerModel

Name	Description	Type
SessionToken	The token associated with this session of API interactions. Generally this is the same token passed with the API request parameters, but under certain circumstances this can be changed before being sent back to the caller.	string
ResponsesIncluded	A list of response messages names contained in this composite message, for easy pre-parsing.	string
Responses	A list of response messages contained in this composite message.	Collection of Object
Status	The success status the composite message.	CompositeStatus

Response Formats

application/json, text/json

Sample:

{
  "sessionToken": "qnXEujwu34gKAAAAAAAAAAAAAAA.fFjKozNNd76nNnySfEhfNj-Nc5AnQr9vr3Am_Ci1wdQ",
  "responsesIncluded": "capturePreAuthorizedCheckResponse",
  "responses": [
    {
      "capturePreAuthorizedCheckResponse": {
        "content": {
          "orderId": 1,
          "posOrderReference": "sample string 1",
          "gxpOrderReference": "sample string 2",
          "gxpCheckNumber": "sample string 3",
          "paymentStatus": "sample string 4",
          "total": 1.0,
          "tipAmount": 1.0
        },
        "succeeded": true
      }
    }
  ],
  "status": "Success"
}