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 and Interac refund requests sent to a paired Square Terminal. You can create a checkout or Interac refund request, check its status, cancel the request, search for in-process requests, and get the results of the request after it is completed.
-
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 - 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.
-
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.