POST /v2/terminals/checkouts/{checkout_id}/dismiss

Dismiss terminal checkoutBeta

POST

/v2/terminals/checkouts/{checkout_id}/dismiss

Dismisses a Terminal checkout request if the status and type of the request permits it.

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

checkout_id

string

Required

Unique ID for the TerminalCheckout associated with the checkout to be dismissed.

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Link to section

checkout

Current state of the checkout to be dismissed.

curl https://connect.squareup.com/v2/terminals/checkouts/LmZEKbo3SBfqO/dismiss \ -X POST \ -H 'Square-Version: 2024-12-18' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json'

{ "checkout": { "id": "LmZEKbo3SBfqO", "amount_money": { "amount": 2610, "currency": "USD" }, "device_options": { "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003", "collect_signature": true, "tip_settings": { "separate_tip_screen": true, "custom_tip_field": false, "allow_tipping": true }, "skip_receipt_screen": false, "loyalty_settings": { "show_loyalty_screen": false, "show_non_qualifying_loyalty_screen": false, "loyalty_screen_max_display_duration": "PT60S", "show_card_linked_reward_redemption_screen": false } }, "status": "COMPLETED", "payment_ids": [ "D7vLJqMkvSoAlX4yyFzUitOy4EPZY" ], "created_at": "2023-11-29T14:59:50.682Z", "updated_at": "2023-11-29T15:00:18.936Z", "app_id": "APP_ID", "deadline_duration": "PT5M", "location_id": "LOCATION_ID", "payment_type": "CARD_PRESENT", "payment_options": { "autocomplete": true } } }