com.squareup.square.api

Class DefaultTerminalApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultTerminalApi

All Implemented Interfaces:

TerminalApi

public final class DefaultTerminalApi
extends BaseApi
implements TerminalApi

This class lists all the endpoints of the groups.

Nested Class Summary

Nested classes/interfaces inherited from class com.squareup.square.api.BaseApi

BaseApi.RequestExecutor, BaseApi.RequestSupplier, BaseApi.ResponseHandler<T>

Field Summary

Fields inherited from class com.squareup.square.api.BaseApi

authManagers, config, httpCallback, internalUserAgent

Constructor Summary

Constructors

Constructor and Description
DefaultTerminalApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultTerminalApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

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.

Methods inherited from class com.squareup.square.api.BaseApi

getClientInstance, getHttpCallback, makeHttpCallAsync, validateResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultTerminalApi

public DefaultTerminalApi(Configuration config,
                          HttpClient httpClient,
                          Map<String,AuthManager> authManagers)

Initializes the controller.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

DefaultTerminalApi

public DefaultTerminalApi(Configuration config,
                          HttpClient httpClient,
                          Map<String,AuthManager> authManagers,
                          HttpCallback httpCallback)

Initializes the controller with HTTPCallback.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

httpCallback - Callback to be called before and after the HTTP call.

Method Detail

createTerminalAction

public 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.

Specified by:

createTerminalAction in interface TerminalApi

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

public 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.

Specified by:

createTerminalActionAsync in interface TerminalApi

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

public 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.

Specified by:

searchTerminalActions in interface TerminalApi

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

public 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.

Specified by:

searchTerminalActionsAsync in interface TerminalApi

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

public GetTerminalActionResponse getTerminalAction(String actionId)
                                            throws ApiException,
                                                   IOException

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

Specified by:

getTerminalAction in interface TerminalApi

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

public CompletableFuture<GetTerminalActionResponse> getTerminalActionAsync(String actionId)

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

Specified by:

getTerminalActionAsync in interface TerminalApi

Parameters:

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

Returns:

Returns the GetTerminalActionResponse response from the API call

cancelTerminalAction

public CancelTerminalActionResponse cancelTerminalAction(String actionId)
                                                  throws ApiException,
                                                         IOException

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

Specified by:

cancelTerminalAction in interface TerminalApi

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

public CompletableFuture<CancelTerminalActionResponse> cancelTerminalActionAsync(String actionId)

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

Specified by:

cancelTerminalActionAsync in interface TerminalApi

Parameters:

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

Returns:

Returns the CancelTerminalActionResponse response from the API call

createTerminalCheckout

public 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.

Specified by:

createTerminalCheckout in interface TerminalApi

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

public 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.

Specified by:

createTerminalCheckoutAsync in interface TerminalApi

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

public 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.

Specified by:

searchTerminalCheckouts in interface TerminalApi

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

public 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.

Specified by:

searchTerminalCheckoutsAsync in interface TerminalApi

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

public GetTerminalCheckoutResponse getTerminalCheckout(String checkoutId)
                                                throws ApiException,
                                                       IOException

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

Specified by:

getTerminalCheckout in interface TerminalApi

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

public CompletableFuture<GetTerminalCheckoutResponse> getTerminalCheckoutAsync(String checkoutId)

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

Specified by:

getTerminalCheckoutAsync in interface TerminalApi

Parameters:

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

Returns:

Returns the GetTerminalCheckoutResponse response from the API call

cancelTerminalCheckout

public CancelTerminalCheckoutResponse cancelTerminalCheckout(String checkoutId)
                                                      throws ApiException,
                                                             IOException

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

Specified by:

cancelTerminalCheckout in interface TerminalApi

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

public CompletableFuture<CancelTerminalCheckoutResponse> cancelTerminalCheckoutAsync(String checkoutId)

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

Specified by:

cancelTerminalCheckoutAsync in interface TerminalApi

Parameters:

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

Returns:

Returns the CancelTerminalCheckoutResponse response from the API call

createTerminalRefund

public 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).

Specified by:

createTerminalRefund in interface TerminalApi

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

public 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).

Specified by:

createTerminalRefundAsync in interface TerminalApi

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

public 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.

Specified by:

searchTerminalRefunds in interface TerminalApi

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

public 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.

Specified by:

searchTerminalRefundsAsync in interface TerminalApi

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

public GetTerminalRefundResponse getTerminalRefund(String terminalRefundId)
                                            throws ApiException,
                                                   IOException

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

Specified by:

getTerminalRefund in interface TerminalApi

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

public CompletableFuture<GetTerminalRefundResponse> getTerminalRefundAsync(String terminalRefundId)

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

Specified by:

getTerminalRefundAsync in interface TerminalApi

Parameters:

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

Returns:

Returns the GetTerminalRefundResponse response from the API call

cancelTerminalRefund

public 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.

Specified by:

cancelTerminalRefund in interface TerminalApi

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

public CompletableFuture<CancelTerminalRefundResponse> cancelTerminalRefundAsync(String terminalRefundId)

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

Specified by:

cancelTerminalRefundAsync in interface TerminalApi

Parameters:

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

Returns:

Returns the CancelTerminalRefundResponse response from the API call