com.squareup.square.api

Interface TransactionsApi

All Known Implementing Classes:

DefaultTransactionsApi

public interface TransactionsApi

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

Method Detail

listTransactions

@Deprecated
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.

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

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
RetrieveTransactionResponse retrieveTransaction(String locationId,
                                                            String transactionId)
                                                     throws ApiException,
                                                            IOException

Deprecated.

Retrieves details for a single transaction.

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
CompletableFuture<RetrieveTransactionResponse> retrieveTransactionAsync(String locationId,
                                                                                    String transactionId)

Deprecated.

Retrieves details for a single transaction.

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

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

Parameters:

locationId - Required parameter: Example:

transactionId - Required parameter: Example:

Returns:

Returns the CaptureTransactionResponse response from the API call

voidTransaction

@Deprecated
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.

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

Parameters:

locationId - Required parameter: Example:

transactionId - Required parameter: Example:

Returns:

Returns the VoidTransactionResponse response from the API call