Get terminal checkout
GET
/v2/terminals/checkouts/{checkout_id}
Retrieves a Terminal checkout request by checkout_id
.
Terminal checkout requests are available for 30 days.
Permissions
PAYMENTS_READ
Try in API Explorer
Name | Description |
---|---|
checkout_
Required
|
The unique ID for the desired |
Response Fields
Name | Description |
---|---|
errors
|
Information about errors encountered during the request. |
checkout
|
The requested |
Examples
GET
/v2/terminals/checkouts/{checkout_id}
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
- Node.js
curl https://connect.squareup.com/v2/terminals/checkouts/08YceKh7B3ZqO \
-H 'Square-Version: 2022-07-20' \
-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"
}
}