• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Search terminal checkouts

POST /v2/terminals/checkouts/search

Returns a filtered list of Terminal checkout requests created by the application making the request.

Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days.

Permissions
PAYMENTS_READ
Guide
Search for Terminal checkout requests Try in API Explorer

Request Body

Example code
Name Description
query
TerminalCheckoutQuery

Queries Terminal checkouts based on given conditions and the sort order. Leaving these unset returns all checkouts with the default sort order.
cursor
string

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. See Pagination for more information.
limit
integer (32-bit)

Limits the number of results returned for a single request.

Min 1 Max 100

Response Fields
Name Description
errors
Error [ ]

Information about errors encountered during the request.
checkouts
TerminalCheckout [ ]

The requested search result of TerminalCheckout objects.
cursor
string

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
  • Node.js 
curl https://connect.squareup.com/v2/terminals/checkouts/search \
  -X POST \
  -H 'Square-Version: 2022-11-16' \
  -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",
        "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",
        "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"
}