v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Terminal

DismissTerminalCheckout

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

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

Path parameters

checkout_idstring required

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

Response

Success

Example response

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