POST Delete Payment

Delete Payment by Check Id

URI template

v1/checks/{storeIdentifier}/{checkId}/deletePayment

Request Information

URI Parameters

NameTypeAdditional informationDescription
storeIdentifier integer

Required

Hasp key number of the site which order will be modified

checkId string

Required

ID used to identify the check.

Body Parameters

Information that identifies the order and promo to apply.

DeletePaymentRequest
NameTypeAdditional informationDescription
ManagerId string

None.

Identifier for the manager that will be applied to the order.

EmployeeId string

None.

Identifier for the employee that will be applied to the order.

QueueId string

None.

Identifier of the queue which will be modified

TableId string

None.

Identifier of the table which will be modified

TenderId string

None.

Identifier for the tender that will be applied to the order.

PaymentId string

Required

Identifier for the payment that will be applied to the order.

SiteId string

None.

Identifier for the site that will be applied to the order.

Request Formats

application/json, text/json

Sample:
{
  "ManagerId": "sample string 1",
  "EmployeeId": "sample string 2",
  "QueueId": "sample string 3",
  "TableId": "sample string 4",
  "TenderId": "sample string 5",
  "PaymentId": "sample string 6",
  "SiteId": "sample string 7"
}

application/xml, text/xml

Sample:
<DeletePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.MpApi.Requests">
  <EmployeeId>sample string 2</EmployeeId>
  <ManagerId>sample string 1</ManagerId>
  <PaymentId>sample string 6</PaymentId>
  <QueueId>sample string 3</QueueId>
  <SiteId>sample string 7</SiteId>
  <TableId>sample string 4</TableId>
  <TenderId>sample string 5</TenderId>
</DeletePaymentRequest>

Response Information

Resource Description

DeletePaymentResponse
NameTypeAdditional informationDescription
ApiResult StoreApiResponse

None.

The result returned by the Api

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.