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

Create a payment for an existing GXP delivery location POS order.

Request Information

URI Parameters

Name	Description	Type	Additional information
outletCode	The outlet code	string	Required

Body Parameters

The request model

AddPaymentToCheckRequest

Name	Description	Type	Additional information
GxpCheckNumber		string
PaymentAmount		decimal number
PaymentToken		string
PaymentState		string
PaymentType		string
TipAmount		decimal number
NameOnCard		string
PaymentIssuerId		integer
OrderFormDetailsDictionary	Dictionary to contain Order Form Details for the outlet, setup in GXP Manager.	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",
  "paymentAmount": 2.0,
  "paymentToken": "sample string 3",
  "paymentState": "sample string 4",
  "paymentType": "sample string 5",
  "tipAmount": 1.0,
  "nameOnCard": "sample string 6",
  "paymentIssuerId": 1,
  "orderFormDetailsDictionary": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "sessionToken": "sample string 7"
}

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": "hgnl4UD-3IgKAAAAAAAAAAAAAAA.A-HFPqrBZNPJFuJ7QAlMdQJs6CSDxTdpZXPvUQ6Mk8E",
  "responsesIncluded": "addPaymentToCheckResponse",
  "responses": [
    {
      "addPaymentToCheckResponse": {
        "content": {
          "orderId": 1,
          "posOrderReference": "sample string 1",
          "gxpOrderReference": "sample string 2",
          "gxpCheckNumber": "sample string 3",
          "paymentStatus": "sample string 4",
          "total": 1.0,
          "posTotalDue": 1.0
        },
        "succeeded": true
      }
    }
  ],
  "status": "Success"
}