com.squareup.square.api

Interface V1TransactionsApi

All Known Implementing Classes:

DefaultV1TransactionsApi

public interface V1TransactionsApi

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
V1Refund	createRefund(String locationId, V1CreateRefundRequest body) Deprecated.
CompletableFuture<V1Refund>	createRefundAsync(String locationId, V1CreateRefundRequest body) Deprecated.
List<V1Order>	listOrders(String locationId, String order, Integer limit, String batchToken) Deprecated.
CompletableFuture<List<V1Order>>	listOrdersAsync(String locationId, String order, Integer limit, String batchToken) Deprecated.
List<V1Payment>	listPayments(String locationId, String order, String beginTime, String endTime, Integer limit, String batchToken, Boolean includePartial) Deprecated.
CompletableFuture<List<V1Payment>>	listPaymentsAsync(String locationId, String order, String beginTime, String endTime, Integer limit, String batchToken, Boolean includePartial) Deprecated.
List<V1Refund>	listRefunds(String locationId, String order, String beginTime, String endTime, Integer limit, String batchToken) Deprecated.
CompletableFuture<List<V1Refund>>	listRefundsAsync(String locationId, String order, String beginTime, String endTime, Integer limit, String batchToken) Deprecated.
List<V1Settlement>	listSettlements(String locationId, String order, String beginTime, String endTime, Integer limit, String status, String batchToken) Deprecated.
CompletableFuture<List<V1Settlement>>	listSettlementsAsync(String locationId, String order, String beginTime, String endTime, Integer limit, String status, String batchToken) Deprecated.
V1Order	retrieveOrder(String locationId, String orderId) Deprecated.
CompletableFuture<V1Order>	retrieveOrderAsync(String locationId, String orderId) Deprecated.
V1Payment	retrievePayment(String locationId, String paymentId) Deprecated.
CompletableFuture<V1Payment>	retrievePaymentAsync(String locationId, String paymentId) Deprecated.
V1Settlement	retrieveSettlement(String locationId, String settlementId) Deprecated.
CompletableFuture<V1Settlement>	retrieveSettlementAsync(String locationId, String settlementId) Deprecated.
V1Order	updateOrder(String locationId, String orderId, V1UpdateOrderRequest body) Deprecated.
CompletableFuture<V1Order>	updateOrderAsync(String locationId, String orderId, V1UpdateOrderRequest body) Deprecated.

Method Detail

listOrders

@Deprecated
List<V1Order> listOrders(String locationId,
                                     String order,
                                     Integer limit,
                                     String batchToken)
                              throws ApiException,
                                     IOException

Deprecated.

Provides summary information for a merchant's online store orders.

Parameters:

locationId - Required parameter: The ID of the location to list online store orders for.

order - Optional parameter: The order in which payments are listed in the response.

limit - Optional parameter: The maximum number of payments to return in a single response. This value cannot exceed 200.

batchToken - Optional parameter: A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Returns:

Returns the List of V1Order 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.

listOrdersAsync

@Deprecated
CompletableFuture<List<V1Order>> listOrdersAsync(String locationId,
                                                             String order,
                                                             Integer limit,
                                                             String batchToken)

Deprecated.

Provides summary information for a merchant's online store orders.

Parameters:

locationId - Required parameter: The ID of the location to list online store orders for.

order - Optional parameter: The order in which payments are listed in the response.

limit - Optional parameter: The maximum number of payments to return in a single response. This value cannot exceed 200.

batchToken - Optional parameter: A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Returns:

Returns the List of V1Order response from the API call

retrieveOrder

@Deprecated
V1Order retrieveOrder(String locationId,
                                  String orderId)
                           throws ApiException,
                                  IOException

Deprecated.

Provides comprehensive information for a single online store order, including the order's history.

Parameters:

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

orderId - Required parameter: The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint

Returns:

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

retrieveOrderAsync

@Deprecated
CompletableFuture<V1Order> retrieveOrderAsync(String locationId,
                                                          String orderId)

Deprecated.

Provides comprehensive information for a single online store order, including the order's history.

Parameters:

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

orderId - Required parameter: The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint

Returns:

Returns the V1Order response from the API call

updateOrder

@Deprecated
V1Order updateOrder(String locationId,
                                String orderId,
                                V1UpdateOrderRequest body)
                         throws ApiException,
                                IOException

Deprecated.

Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:.

Parameters:

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

orderId - Required parameter: The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint

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

Returns:

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

updateOrderAsync

@Deprecated
CompletableFuture<V1Order> updateOrderAsync(String locationId,
                                                        String orderId,
                                                        V1UpdateOrderRequest body)

Deprecated.

Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:.

Parameters:

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

orderId - Required parameter: The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint

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

Returns:

Returns the V1Order response from the API call

listPayments

@Deprecated
List<V1Payment> listPayments(String locationId,
                                         String order,
                                         String beginTime,
                                         String endTime,
                                         Integer limit,
                                         String batchToken,
                                         Boolean includePartial)
                                  throws ApiException,
                                         IOException

Deprecated.

Provides summary information for all payments taken for a given Square account during a date range. Date ranges cannot exceed 1 year in length. See Date ranges for details of inclusive and exclusive dates. *Note**: Details for payments processed with Square Point of Sale while in offline mode may not be transmitted to Square for up to 72 hours. Offline payments have a `created_at` value that reflects the time the payment was originally processed, not the time it was subsequently transmitted to Square. Consequently, the ListPayments endpoint might list an offline payment chronologically between online payments that were seen in a previous request.

Parameters:

locationId - Required parameter: The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations.

order - Optional parameter: The order in which payments are listed in the response.

beginTime - Optional parameter: The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.

endTime - Optional parameter: The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.

limit - Optional parameter: The maximum number of payments to return in a single response. This value cannot exceed 200.

batchToken - Optional parameter: A pagination cursor to retrieve the next set of results for your original query to the endpoint.

includePartial - Optional parameter: Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed.

Returns:

Returns the List of V1Payment 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.

listPaymentsAsync

@Deprecated
CompletableFuture<List<V1Payment>> listPaymentsAsync(String locationId,
                                                                 String order,
                                                                 String beginTime,
                                                                 String endTime,
                                                                 Integer limit,
                                                                 String batchToken,
                                                                 Boolean includePartial)

Deprecated.

Provides summary information for all payments taken for a given Square account during a date range. Date ranges cannot exceed 1 year in length. See Date ranges for details of inclusive and exclusive dates. *Note**: Details for payments processed with Square Point of Sale while in offline mode may not be transmitted to Square for up to 72 hours. Offline payments have a `created_at` value that reflects the time the payment was originally processed, not the time it was subsequently transmitted to Square. Consequently, the ListPayments endpoint might list an offline payment chronologically between online payments that were seen in a previous request.

Parameters:

locationId - Required parameter: The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations.

order - Optional parameter: The order in which payments are listed in the response.

beginTime - Optional parameter: The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.

endTime - Optional parameter: The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.

limit - Optional parameter: The maximum number of payments to return in a single response. This value cannot exceed 200.

batchToken - Optional parameter: A pagination cursor to retrieve the next set of results for your original query to the endpoint.

includePartial - Optional parameter: Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed.

Returns:

Returns the List of V1Payment response from the API call

retrievePayment

@Deprecated
V1Payment retrievePayment(String locationId,
                                      String paymentId)
                               throws ApiException,
                                      IOException

Deprecated.

Provides comprehensive information for a single payment.

Parameters:

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

paymentId - Required parameter: The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint.

Returns:

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

retrievePaymentAsync

@Deprecated
CompletableFuture<V1Payment> retrievePaymentAsync(String locationId,
                                                              String paymentId)

Deprecated.

Provides comprehensive information for a single payment.

Parameters:

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

paymentId - Required parameter: The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint.

Returns:

Returns the V1Payment response from the API call

listRefunds

@Deprecated
List<V1Refund> listRefunds(String locationId,
                                       String order,
                                       String beginTime,
                                       String endTime,
                                       Integer limit,
                                       String batchToken)
                                throws ApiException,
                                       IOException

Deprecated.

Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.

Parameters:

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

order - Optional parameter: The order in which payments are listed in the response.

beginTime - Optional parameter: The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.

endTime - Optional parameter: The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.

limit - Optional parameter: The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods.

batchToken - Optional parameter: A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Returns:

Returns the List of V1Refund 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.

listRefundsAsync

@Deprecated
CompletableFuture<List<V1Refund>> listRefundsAsync(String locationId,
                                                               String order,
                                                               String beginTime,
                                                               String endTime,
                                                               Integer limit,
                                                               String batchToken)

Deprecated.

Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.

Parameters:

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

order - Optional parameter: The order in which payments are listed in the response.

beginTime - Optional parameter: The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.

endTime - Optional parameter: The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.

limit - Optional parameter: The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods.

batchToken - Optional parameter: A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Returns:

Returns the List of V1Refund response from the API call

createRefund

@Deprecated
V1Refund createRefund(String locationId,
                                  V1CreateRefundRequest body)
                           throws ApiException,
                                  IOException

Deprecated.

Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. You cannot issue a partial refund for a split tender payment. You must instead issue a full or partial refund for a particular tender, by providing the applicable tender id to the V1CreateRefund endpoint. Issuing a full refund for a split tender payment refunds all tenders associated with the payment. Issuing a refund for a card payment is not reversible. For development purposes, you can create fake cash payments in Square Point of Sale and refund them.

Parameters:

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

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

Returns:

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

createRefundAsync

@Deprecated
CompletableFuture<V1Refund> createRefundAsync(String locationId,
                                                          V1CreateRefundRequest body)

Deprecated.

Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. You cannot issue a partial refund for a split tender payment. You must instead issue a full or partial refund for a particular tender, by providing the applicable tender id to the V1CreateRefund endpoint. Issuing a full refund for a split tender payment refunds all tenders associated with the payment. Issuing a refund for a card payment is not reversible. For development purposes, you can create fake cash payments in Square Point of Sale and refund them.

Parameters:

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

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

Returns:

Returns the V1Refund response from the API call

listSettlements

@Deprecated
List<V1Settlement> listSettlements(String locationId,
                                               String order,
                                               String beginTime,
                                               String endTime,
                                               Integer limit,
                                               String status,
                                               String batchToken)
                                        throws ApiException,
                                               IOException

Deprecated.

Provides summary information for all deposits and withdrawals initiated by Square to a linked bank account during a date range. Date ranges cannot exceed one year in length. *Note**: the ListSettlements endpoint does not provide entry information.

Parameters:

locationId - Required parameter: The ID of the location to list settlements for. If you specify me, this endpoint returns settlements aggregated from all of the business's locations.

order - Optional parameter: The order in which settlements are listed in the response.

beginTime - Optional parameter: The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.

endTime - Optional parameter: The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.

limit - Optional parameter: The maximum number of settlements to return in a single response. This value cannot exceed 200.

status - Optional parameter: Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).

batchToken - Optional parameter: A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Returns:

Returns the List of V1Settlement 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.

listSettlementsAsync

@Deprecated
CompletableFuture<List<V1Settlement>> listSettlementsAsync(String locationId,
                                                                       String order,
                                                                       String beginTime,
                                                                       String endTime,
                                                                       Integer limit,
                                                                       String status,
                                                                       String batchToken)

Deprecated.

Provides summary information for all deposits and withdrawals initiated by Square to a linked bank account during a date range. Date ranges cannot exceed one year in length. *Note**: the ListSettlements endpoint does not provide entry information.

Parameters:

locationId - Required parameter: The ID of the location to list settlements for. If you specify me, this endpoint returns settlements aggregated from all of the business's locations.

order - Optional parameter: The order in which settlements are listed in the response.

beginTime - Optional parameter: The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.

endTime - Optional parameter: The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.

limit - Optional parameter: The maximum number of settlements to return in a single response. This value cannot exceed 200.

status - Optional parameter: Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).

batchToken - Optional parameter: A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Returns:

Returns the List of V1Settlement response from the API call

retrieveSettlement

@Deprecated
V1Settlement retrieveSettlement(String locationId,
                                            String settlementId)
                                     throws ApiException,
                                            IOException

Deprecated.

Provides comprehensive information for a single settlement. The returned `Settlement` objects include an `entries` field that lists the transactions that contribute to the settlement total. Most settlement entries correspond to a payment payout, but settlement entries are also generated for less common events, like refunds, manual adjustments, or chargeback holds. Square initiates its regular deposits as indicated in the [Deposit Options with Square](https://squareup.com/help/us/en/article/3807) help article. Details for a regular deposit are usually not available from Connect API endpoints before 10 p.m. PST the same day. Square does not know when an initiated settlement **completes**, only whether it has failed. A completed settlement is typically reflected in a bank account within 3 business days, but in exceptional cases it may take longer.

Parameters:

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

settlementId - Required parameter: The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint.

Returns:

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

retrieveSettlementAsync

@Deprecated
CompletableFuture<V1Settlement> retrieveSettlementAsync(String locationId,
                                                                    String settlementId)

Deprecated.

Provides comprehensive information for a single settlement. The returned `Settlement` objects include an `entries` field that lists the transactions that contribute to the settlement total. Most settlement entries correspond to a payment payout, but settlement entries are also generated for less common events, like refunds, manual adjustments, or chargeback holds. Square initiates its regular deposits as indicated in the [Deposit Options with Square](https://squareup.com/help/us/en/article/3807) help article. Details for a regular deposit are usually not available from Connect API endpoints before 10 p.m. PST the same day. Square does not know when an initiated settlement **completes**, only whether it has failed. A completed settlement is typically reflected in a bank account within 3 business days, but in exceptional cases it may take longer.

Parameters:

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

settlementId - Required parameter: The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint.

Returns:

Returns the V1Settlement response from the API call