Development
  • Guides
  • API Reference
  • API Explorer
  • SDKs
  • Sample apps
  • System status
Support
  • Developer forums
  • Developer blog
  • YouTube
  • X
More
  • Square Home
  • Square Developer
  • App Marketplace
  • Partner with Square
  • Solutions Partner Program
  • Pricing
  • Sales

© 2026 Square, Inc.

  • Developer terms of service
  • Developer Integration and Marketing Agreement
  • Privacy policy
  • Partnerships
  • Sign In
  • Sign In
  • Home

  • Dev Essentials

  • Payments

    • Payments

    • Refunds

    • Checkout

    • Terminal

    • Disputes

    • Invoices

    • Cards

    • Subscriptions

    • Bank Accounts

    • Payouts

    • Devices

    • Apple Pay

  • Commerce

  • Customers

  • Staff

  • Merchants

  • Objects & Enums

  • Webhook Events

  • Deprecated

  • SDKs

<- Square API

Square API

All versions ->

Terminal

Requests a checkout from a paired Square Terminal.

The Terminal API allows you to manage sending and receiving requests and responses from a paired Square Terminal. For a Terminal checkout, refund, or action, you can create a request, check its status, cancel the request, search for in-process requests, and get the results of the request after it is completed. In the current implementation, refunds are only supported for Interac debit cards in Canada.

For more information, see the following guides:

  • Terminal
  • Square Webhooks Overview
  • Endpoints

  • Webhooks

All versions ->

Create terminal action

POST/v2/terminals/actions

Creates a Terminal action request and sends it to the specified device.

Beta

Search terminal actions

POST/v2/terminals/actions/search

Retrieves a filtered list of Terminal action requests created by the account making the request.

Beta

Get terminal action

GET/v2/terminals/actions/{action_id}

Retrieves a Terminal action request by action_id.

Beta

Cancel terminal action

POST/v2/terminals/actions/{action_id}/cancel

Cancels a Terminal action request if the status of the request permits it.

Beta

Dismiss terminal action

POST/v2/terminals/actions/{action_id}/dismiss

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

Beta

Create terminal checkout

POST/v2/terminals/checkouts

Creates a Terminal checkout request and sends it to the specified device to take a payment for the requested amount.

Search terminal checkouts

POST/v2/terminals/checkouts/search

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

Get terminal checkout

GET/v2/terminals/checkouts/{checkout_id}

Retrieves a Terminal checkout request by checkout_id.

Cancel terminal checkout

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

Cancels a Terminal checkout request if the status of the request permits it.

Dismiss terminal checkout

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

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

Beta

Create terminal refund

POST/v2/terminals/refunds

Creates a request to refund an Interac payment completed on a Square Terminal.

Search terminal refunds

POST/v2/terminals/refunds/search

Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request.

Get terminal refund

GET/v2/terminals/refunds/{terminal_refund_id}

Retrieves an Interac Terminal refund object by ID.

Cancel terminal refund

POST/v2/terminals/refunds/{terminal_refund_id}/cancel

Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it.

Dismiss terminal refund

POST/v2/terminals/refunds/{terminal_refund_id}/dismiss

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

Beta