Search terminal checkouts BETA
Retrieves a filtered list of Terminal checkout requests created by the account making the request.
Required permissions:
PAYMENTS_READ
Request Body
| Name | Description |
|---|---|
query
|
Query the terminal checkouts based on given conditions and sort order. Calling SearchTerminalCheckouts without an explicitly query parameter will return all available checkouts with the default sort order. |
cursor
|
A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. |
limit
|
Limit the number of results returned for a single request. |
Response Fields
| Name | Description |
|---|---|
errors
|
Information on errors encountered during the request. |
checkouts
|
The requested search result of |
cursor
|
The pagination cursor to be used in a subsequent request. If empty, this is the final response. See Pagination for more information. |
Examples
You are viewing an old version of the API
POST
/v2/terminals/checkouts/search
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
curl https://connect.squareup.com/v2/terminals/checkouts/search \
-X POST \
-H 'Square-Version: 2020-06-25' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"limit": 2,
"query": {
"filter": {
"status": "COMPLETED"
}
}
}'
Response JSON
{
"checkouts": [
{
"id": "tsQPvzwBpMqqO",
"amount_money": {
"amount": 2610,
"currency": "USD"
},
"reference_id": "id14467",
"note": "A brief note",
"device_options": {
"device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003",
"print_receipt": false,
"tip_settings": {
"allow_tipping": false
},
"skip_receipt_screen": false
},
"status": "COMPLETED",
"payment_ids": [
"rXnhZzywrEk4vR6pw76fPZfgvaB"
],
"created_at": "2020-03-31T18:13:15.921Z",
"updated_at": "2020-03-31T18:13:52.725Z",
"app_id": "APP_ID",
"deadline_duration": "PT10M"
},
{
"id": "XlOPTgcEhrbqO",
"amount_money": {
"amount": 2610,
"currency": "USD"
},
"reference_id": "id41623",
"note": "A brief note",
"device_options": {
"device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003",
"print_receipt": false,
"tip_settings": {
"allow_tipping": false
},
"skip_receipt_screen": true
},
"status": "COMPLETED",
"payment_ids": [
"VYBF861PaoKPP7Pih0TlbZiNvaB"
],
"created_at": "2020-03-31T18:08:31.882Z",
"updated_at": "2020-03-31T18:08:41.635Z",
"app_id": "APP_ID",
"deadline_duration": "PT10M"
}
],
"cursor": "RiTJqBoTuXlbLmmrPvEkX9iG7XnQ4W4RjGnH"
}