com.squareup.square.api

Interface TerminalApi

All Known Implementing Classes:

DefaultTerminalApi

public interface TerminalApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
CancelTerminalActionResponse	cancelTerminalAction(String actionId) Cancels a Terminal action request if the status of the request permits it.
CompletableFuture<CancelTerminalActionResponse>	cancelTerminalActionAsync(String actionId) Cancels a Terminal action request if the status of the request permits it.
CancelTerminalCheckoutResponse	cancelTerminalCheckout(String checkoutId) Cancels a Terminal checkout request if the status of the request permits it.
CompletableFuture<CancelTerminalCheckoutResponse>	cancelTerminalCheckoutAsync(String checkoutId) Cancels a Terminal checkout request if the status of the request permits it.
CancelTerminalRefundResponse	cancelTerminalRefund(String terminalRefundId) Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it.
CompletableFuture<CancelTerminalRefundResponse>	cancelTerminalRefundAsync(String terminalRefundId) Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it.
CreateTerminalActionResponse	createTerminalAction(CreateTerminalActionRequest body) Creates a Terminal action request and sends it to the specified device to take a payment for the requested amount.
CompletableFuture<CreateTerminalActionResponse>	createTerminalActionAsync(CreateTerminalActionRequest body) Creates a Terminal action request and sends it to the specified device to take a payment for the requested amount.
CreateTerminalCheckoutResponse	createTerminalCheckout(CreateTerminalCheckoutRequest body) Creates a Terminal checkout request and sends it to the specified device to take a payment for the requested amount.
CompletableFuture<CreateTerminalCheckoutResponse>	createTerminalCheckoutAsync(CreateTerminalCheckoutRequest body) Creates a Terminal checkout request and sends it to the specified device to take a payment for the requested amount.
CreateTerminalRefundResponse	createTerminalRefund(CreateTerminalRefundRequest body) Creates a request to refund an Interac payment completed on a Square Terminal.
CompletableFuture<CreateTerminalRefundResponse>	createTerminalRefundAsync(CreateTerminalRefundRequest body) Creates a request to refund an Interac payment completed on a Square Terminal.
GetTerminalActionResponse	getTerminalAction(String actionId) Retrieves a Terminal action request by `action_id`.
CompletableFuture<GetTerminalActionResponse>	getTerminalActionAsync(String actionId) Retrieves a Terminal action request by `action_id`.
GetTerminalCheckoutResponse	getTerminalCheckout(String checkoutId) Retrieves a Terminal checkout request by `checkout_id`.
CompletableFuture<GetTerminalCheckoutResponse>	getTerminalCheckoutAsync(String checkoutId) Retrieves a Terminal checkout request by `checkout_id`.
GetTerminalRefundResponse	getTerminalRefund(String terminalRefundId) Retrieves an Interac Terminal refund object by ID.
CompletableFuture<GetTerminalRefundResponse>	getTerminalRefundAsync(String terminalRefundId) Retrieves an Interac Terminal refund object by ID.
SearchTerminalActionsResponse	searchTerminalActions(SearchTerminalActionsRequest body) Retrieves a filtered list of Terminal action requests created by the account making the request.
CompletableFuture<SearchTerminalActionsResponse>	searchTerminalActionsAsync(SearchTerminalActionsRequest body) Retrieves a filtered list of Terminal action requests created by the account making the request.
SearchTerminalCheckoutsResponse	searchTerminalCheckouts(SearchTerminalCheckoutsRequest body) Returns a filtered list of Terminal checkout requests created by the application making the request.
CompletableFuture<SearchTerminalCheckoutsResponse>	searchTerminalCheckoutsAsync(SearchTerminalCheckoutsRequest body) Returns a filtered list of Terminal checkout requests created by the application making the request.
SearchTerminalRefundsResponse	searchTerminalRefunds(SearchTerminalRefundsRequest body) Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request.
CompletableFuture<SearchTerminalRefundsResponse>	searchTerminalRefundsAsync(SearchTerminalRefundsRequest body) Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request.

Method Detail

createTerminalAction

CreateTerminalActionResponse createTerminalAction(CreateTerminalActionRequest body)
                                           throws ApiException,
                                                  IOException

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

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateTerminalActionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createTerminalActionAsync

CompletableFuture<CreateTerminalActionResponse> createTerminalActionAsync(CreateTerminalActionRequest body)

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

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateTerminalActionResponse response from the API call

searchTerminalActions

SearchTerminalActionsResponse searchTerminalActions(SearchTerminalActionsRequest body)
                                             throws ApiException,
                                                    IOException

Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchTerminalActionsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

searchTerminalActionsAsync

CompletableFuture<SearchTerminalActionsResponse> searchTerminalActionsAsync(SearchTerminalActionsRequest body)

Retrieves a filtered list of Terminal action requests created by the account making the request. Terminal action requests are available for 30 days.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchTerminalActionsResponse response from the API call

getTerminalAction

GetTerminalActionResponse getTerminalAction(String actionId)
                                     throws ApiException,
                                            IOException

Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30 days.

Parameters:

actionId - Required parameter: Unique ID for the desired `TerminalAction`

Returns:

Returns the GetTerminalActionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

getTerminalActionAsync

CompletableFuture<GetTerminalActionResponse> getTerminalActionAsync(String actionId)

Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30 days.

Parameters:

actionId - Required parameter: Unique ID for the desired `TerminalAction`

Returns:

Returns the GetTerminalActionResponse response from the API call

cancelTerminalAction

CancelTerminalActionResponse cancelTerminalAction(String actionId)
                                           throws ApiException,
                                                  IOException

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

Parameters:

actionId - Required parameter: Unique ID for the desired `TerminalAction`

Returns:

Returns the CancelTerminalActionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

cancelTerminalActionAsync

CompletableFuture<CancelTerminalActionResponse> cancelTerminalActionAsync(String actionId)

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

Parameters:

actionId - Required parameter: Unique ID for the desired `TerminalAction`

Returns:

Returns the CancelTerminalActionResponse response from the API call

createTerminalCheckout

CreateTerminalCheckoutResponse createTerminalCheckout(CreateTerminalCheckoutRequest body)
                                               throws ApiException,
                                                      IOException

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

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateTerminalCheckoutResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createTerminalCheckoutAsync

CompletableFuture<CreateTerminalCheckoutResponse> createTerminalCheckoutAsync(CreateTerminalCheckoutRequest body)

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

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateTerminalCheckoutResponse response from the API call

searchTerminalCheckouts

SearchTerminalCheckoutsResponse searchTerminalCheckouts(SearchTerminalCheckoutsRequest body)
                                                 throws ApiException,
                                                        IOException

Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchTerminalCheckoutsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

searchTerminalCheckoutsAsync

CompletableFuture<SearchTerminalCheckoutsResponse> searchTerminalCheckoutsAsync(SearchTerminalCheckoutsRequest body)

Returns a filtered list of Terminal checkout requests created by the application making the request. Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchTerminalCheckoutsResponse response from the API call

getTerminalCheckout

GetTerminalCheckoutResponse getTerminalCheckout(String checkoutId)
                                         throws ApiException,
                                                IOException

Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days.

Parameters:

checkoutId - Required parameter: The unique ID for the desired `TerminalCheckout`.

Returns:

Returns the GetTerminalCheckoutResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

getTerminalCheckoutAsync

CompletableFuture<GetTerminalCheckoutResponse> getTerminalCheckoutAsync(String checkoutId)

Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for 30 days.

Parameters:

checkoutId - Required parameter: The unique ID for the desired `TerminalCheckout`.

Returns:

Returns the GetTerminalCheckoutResponse response from the API call

cancelTerminalCheckout

CancelTerminalCheckoutResponse cancelTerminalCheckout(String checkoutId)
                                               throws ApiException,
                                                      IOException

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

Parameters:

checkoutId - Required parameter: The unique ID for the desired `TerminalCheckout`.

Returns:

Returns the CancelTerminalCheckoutResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

cancelTerminalCheckoutAsync

CompletableFuture<CancelTerminalCheckoutResponse> cancelTerminalCheckoutAsync(String checkoutId)

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

Parameters:

checkoutId - Required parameter: The unique ID for the desired `TerminalCheckout`.

Returns:

Returns the CancelTerminalCheckoutResponse response from the API call

createTerminalRefund

CreateTerminalRefundResponse createTerminalRefund(CreateTerminalRefundRequest body)
                                           throws ApiException,
                                                  IOException

Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API]($e/Refunds).

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateTerminalRefundResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createTerminalRefundAsync

CompletableFuture<CreateTerminalRefundResponse> createTerminalRefundAsync(CreateTerminalRefundRequest body)

Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds for Terminal payments should use the Refunds API. For more information, see [Refunds API]($e/Refunds).

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateTerminalRefundResponse response from the API call

searchTerminalRefunds

SearchTerminalRefundsResponse searchTerminalRefunds(SearchTerminalRefundsRequest body)
                                             throws ApiException,
                                                    IOException

Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchTerminalRefundsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

searchTerminalRefundsAsync

CompletableFuture<SearchTerminalRefundsResponse> searchTerminalRefundsAsync(SearchTerminalRefundsRequest body)

Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request. Terminal refund requests are available for 30 days.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the SearchTerminalRefundsResponse response from the API call

getTerminalRefund

GetTerminalRefundResponse getTerminalRefund(String terminalRefundId)
                                     throws ApiException,
                                            IOException

Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days.

Parameters:

terminalRefundId - Required parameter: The unique ID for the desired `TerminalRefund`.

Returns:

Returns the GetTerminalRefundResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

getTerminalRefundAsync

CompletableFuture<GetTerminalRefundResponse> getTerminalRefundAsync(String terminalRefundId)

Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days.

Parameters:

terminalRefundId - Required parameter: The unique ID for the desired `TerminalRefund`.

Returns:

Returns the GetTerminalRefundResponse response from the API call

cancelTerminalRefund

CancelTerminalRefundResponse cancelTerminalRefund(String terminalRefundId)
                                           throws ApiException,
                                                  IOException

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

Parameters:

terminalRefundId - Required parameter: The unique ID for the desired `TerminalRefund`.

Returns:

Returns the CancelTerminalRefundResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

cancelTerminalRefundAsync

CompletableFuture<CancelTerminalRefundResponse> cancelTerminalRefundAsync(String terminalRefundId)

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

Parameters:

terminalRefundId - Required parameter: The unique ID for the desired `TerminalRefund`.

Returns:

Returns the CancelTerminalRefundResponse response from the API call