com.squareup.square.api

Class DefaultTransactionsApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultTransactionsApi

All Implemented Interfaces:

TransactionsApi

public final class DefaultTransactionsApi
extends BaseApi
implements TransactionsApi

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
DefaultTransactionsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultTransactionsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

Method Summary

Modifier and Type	Method and Description
CaptureTransactionResponse	captureTransaction(String locationId, String transactionId) Deprecated.
CompletableFuture<CaptureTransactionResponse>	captureTransactionAsync(String locationId, String transactionId) Deprecated.
ListTransactionsResponse	listTransactions(String locationId, String beginTime, String endTime, String sortOrder, String cursor) Deprecated.
CompletableFuture<ListTransactionsResponse>	listTransactionsAsync(String locationId, String beginTime, String endTime, String sortOrder, String cursor) Deprecated.
RetrieveTransactionResponse	retrieveTransaction(String locationId, String transactionId) Deprecated.
CompletableFuture<RetrieveTransactionResponse>	retrieveTransactionAsync(String locationId, String transactionId) Deprecated.
VoidTransactionResponse	voidTransaction(String locationId, String transactionId) Deprecated.
CompletableFuture<VoidTransactionResponse>	voidTransactionAsync(String locationId, String transactionId) Deprecated.

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

DefaultTransactionsApi

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

DefaultTransactionsApi

public DefaultTransactionsApi(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

listTransactions

@Deprecated
public ListTransactionsResponse listTransactions(String locationId,
                                                             String beginTime,
                                                             String endTime,
                                                             String sortOrder,
                                                             String cursor)
                                                      throws ApiException,
                                                             IOException

Deprecated.

Lists transactions for a particular location. Transactions include payment information from sales and exchanges and refund information from returns and exchanges. Max results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50.

Specified by:

listTransactions in interface TransactionsApi

Parameters:

locationId - Required parameter: The ID of the location to list transactions for.

beginTime - Optional parameter: The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. Default value: The current time minus one year.

endTime - Optional parameter: The end of the requested reporting period, in RFC 3339 format. See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. Default value: The current time.

sortOrder - Optional parameter: The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.

Returns:

Returns the ListTransactionsResponse 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.

listTransactionsAsync

@Deprecated
public CompletableFuture<ListTransactionsResponse> listTransactionsAsync(String locationId,
                                                                                     String beginTime,
                                                                                     String endTime,
                                                                                     String sortOrder,
                                                                                     String cursor)

Deprecated.

Lists transactions for a particular location. Transactions include payment information from sales and exchanges and refund information from returns and exchanges. Max results per [page](https://developer.squareup.com/docs/working-with-apis/pagination): 50.

Specified by:

listTransactionsAsync in interface TransactionsApi

Parameters:

locationId - Required parameter: The ID of the location to list transactions for.

beginTime - Optional parameter: The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. Default value: The current time minus one year.

endTime - Optional parameter: The end of the requested reporting period, in RFC 3339 format. See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity. Default value: The current time.

sortOrder - Optional parameter: The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.

Returns:

Returns the ListTransactionsResponse response from the API call

retrieveTransaction

@Deprecated
public RetrieveTransactionResponse retrieveTransaction(String locationId,
                                                                   String transactionId)
                                                            throws ApiException,
                                                                   IOException

Deprecated.

Retrieves details for a single transaction.

Specified by:

retrieveTransaction in interface TransactionsApi

Parameters:

locationId - Required parameter: The ID of the transaction's associated location.

transactionId - Required parameter: The ID of the transaction to retrieve.

Returns:

Returns the RetrieveTransactionResponse 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.

retrieveTransactionAsync

@Deprecated
public CompletableFuture<RetrieveTransactionResponse> retrieveTransactionAsync(String locationId,
                                                                                           String transactionId)

Deprecated.

Retrieves details for a single transaction.

Specified by:

retrieveTransactionAsync in interface TransactionsApi

Parameters:

locationId - Required parameter: The ID of the transaction's associated location.

transactionId - Required parameter: The ID of the transaction to retrieve.

Returns:

Returns the RetrieveTransactionResponse response from the API call

captureTransaction

@Deprecated
public CaptureTransactionResponse captureTransaction(String locationId,
                                                                 String transactionId)
                                                          throws ApiException,
                                                                 IOException

Deprecated.

Captures a transaction that was created with the [Charge]($e/Transactions/Charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) for more information.

Specified by:

captureTransaction in interface TransactionsApi

Parameters:

locationId - Required parameter: Example:

transactionId - Required parameter: Example:

Returns:

Returns the CaptureTransactionResponse 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.

captureTransactionAsync

@Deprecated
public CompletableFuture<CaptureTransactionResponse> captureTransactionAsync(String locationId,
                                                                                         String transactionId)

Deprecated.

Captures a transaction that was created with the [Charge]($e/Transactions/Charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) for more information.

Specified by:

captureTransactionAsync in interface TransactionsApi

Parameters:

locationId - Required parameter: Example:

transactionId - Required parameter: Example:

Returns:

Returns the CaptureTransactionResponse response from the API call

voidTransaction

@Deprecated
public VoidTransactionResponse voidTransaction(String locationId,
                                                           String transactionId)
                                                    throws ApiException,
                                                           IOException

Deprecated.

Cancels a transaction that was created with the [Charge]($e/Transactions/Charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) for more information.

Specified by:

voidTransaction in interface TransactionsApi

Parameters:

locationId - Required parameter: Example:

transactionId - Required parameter: Example:

Returns:

Returns the VoidTransactionResponse 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.

voidTransactionAsync

@Deprecated
public CompletableFuture<VoidTransactionResponse> voidTransactionAsync(String locationId,
                                                                                   String transactionId)

Deprecated.

Cancels a transaction that was created with the [Charge]($e/Transactions/Charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](https://developer.squareup.com/docs/payments/transactions/overview#delayed-capture) for more information.

Specified by:

voidTransactionAsync in interface TransactionsApi

Parameters:

locationId - Required parameter: Example:

transactionId - Required parameter: Example:

Returns:

Returns the VoidTransactionResponse response from the API call