Square API
You are viewing an old version of the API
Terminal
Square API
Requests a checkout from a paired Square Terminal
The Terminal API allows you to manage terminal checkout requests sent to a paired Square Terminal. You can create a request, check the request status, cancel the checkout, search for in-process checkout requests, and get the results of the checkout after it is completed by the Square Terminal.
-
Create terminal checkout
POST /v2/terminals/checkouts - Creates a new 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 - Retrieves a filtered list of Terminal checkout requests created by the account 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.