POST v1/checks/{storeIdentifier}/{checkId}/pay

POST Pay with Tender by Check ID

Pay a check with a (non-cash non-credit) tender by check ID.

URI template

v1/checks/{storeIdentifier}/{checkId}/pay

Request Information

URI Parameters

Name	Type	Additional information	Description
storeIdentifier	integer	Required	Store at which the check is being paid.
checkId	integer	Required	ID of the check being paid.

Body Parameters

Amount, tip, and tender to with which to pay.

TenderPaymentRequest

Name	Type	Additional information
tenderName	string	None.
amount	decimal number	None.
tipAmount	decimal number	None.
referenceId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "tenderName": "sample string 1",
  "amount": 2.0,
  "tipAmount": 3.0,
  "referenceId": "sample string 4"
}

application/xml, text/xml

Sample:

<TenderPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Requests">
  <amount>2</amount>
  <referenceId>sample string 4</referenceId>
  <tenderName>sample string 1</tenderName>
  <tipAmount>3</tipAmount>
</TenderPaymentRequest>

Response Information

Resource Description

PaymentResponse

Name	Type	Additional information	Description
paymentId	string	None.
ApiResult	StoreApiResponse	None.	The result returned by the Api

Response Formats

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

Sample:

Sample not available.