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

You are viewing an old version of the API
Get terminal checkout BETA

GET /v2/terminals/checkouts/{checkout_id}

Retrieves a Terminal checkout request by checkout_id.


Permissions
PAYMENTS_READ
Try in API Explorer
Name Description
checkout_id
string

Required

Unique ID for the desired TerminalCheckout

Response Fields

Name Description
errors
Error [ ]

Information on errors encountered during the request.

checkout
TerminalCheckout

The requested Checkout

Examples

You are viewing an old version of the API
GET /v2/terminals/checkouts/{checkout_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
curl https://connect.squareup.com/v2/terminals/checkouts/08YceKh7B3ZqO \
  -H 'Square-Version: 2020-08-26' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "checkout": {
    "id": "08YceKh7B3ZqO",
    "amount_money": {
      "amount": 2610,
      "currency": "USD"
    },
    "reference_id": "id11572",
    "note": "A brief note",
    "device_options": {
      "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003",
      "tip_settings": {
        "allow_tipping": false
      },
      "skip_receipt_screen": false
    },
    "status": "IN_PROGRESS",
    "created_at": "2020-04-06T16:39:32.545Z",
    "updated_at": "2020-04-06T16:39:323.001Z",
    "app_id": "APP_ID",
    "deadline_duration": "PT10M"
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?