POST pos/square/terminal/checkout

Authorized only.

Request Information

URI Parameters

None.

Body Parameters

ApiSquareTerminalCheckoutRequest
NameDescriptionTypeAdditional information
ManualEntry

boolean

None.

RequestTips

boolean

None.

AllowCustomTipsAmount

boolean

None.

TipsPercentages

Collection of decimal number

None.

SkipReceiptScreen

boolean

None.

Notes

string

None.

DeviceId

string

None.

Amount

decimal number

None.

ReferenceNumber

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ManualEntry": true,
  "RequestTips": true,
  "AllowCustomTipsAmount": true,
  "TipsPercentages": [
    1.0,
    2.0
  ],
  "SkipReceiptScreen": true,
  "Notes": "sample string 5",
  "DeviceId": "sample string 6",
  "Amount": 7.0,
  "ReferenceNumber": "sample string 8"
}

application/xml, text/xml

Sample:
<ApiSquareTerminalCheckoutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Api.Requests.Square">
  <Amount>7</Amount>
  <DeviceId>sample string 6</DeviceId>
  <ReferenceNumber>sample string 8</ReferenceNumber>
  <AllowCustomTipsAmount>true</AllowCustomTipsAmount>
  <ManualEntry>true</ManualEntry>
  <Notes>sample string 5</Notes>
  <RequestTips>true</RequestTips>
  <SkipReceiptScreen>true</SkipReceiptScreen>
  <TipsPercentages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>2</d2p1:decimal>
  </TipsPercentages>
</ApiSquareTerminalCheckoutRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.