com.squareup.square.api

Interface RefundsApi

All Known Implementing Classes:

DefaultRefundsApi

public interface RefundsApi

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
GetPaymentRefundResponse	getPaymentRefund(String refundId) Retrieves a specific refund using the `refund_id`.
CompletableFuture<GetPaymentRefundResponse>	getPaymentRefundAsync(String refundId) Retrieves a specific refund using the `refund_id`.
ListPaymentRefundsResponse	listPaymentRefunds(String beginTime, String endTime, String sortOrder, String cursor, String locationId, String status, String sourceType, Integer limit) Retrieves a list of refunds for the account making the request.
CompletableFuture<ListPaymentRefundsResponse>	listPaymentRefundsAsync(String beginTime, String endTime, String sortOrder, String cursor, String locationId, String status, String sourceType, Integer limit) Retrieves a list of refunds for the account making the request.
RefundPaymentResponse	refundPayment(RefundPaymentRequest body) Refunds a payment.
CompletableFuture<RefundPaymentResponse>	refundPaymentAsync(RefundPaymentRequest body) Refunds a payment.

Method Detail

listPaymentRefunds

ListPaymentRefundsResponse listPaymentRefunds(String beginTime,
                                              String endTime,
                                              String sortOrder,
                                              String cursor,
                                              String locationId,
                                              String status,
                                              String sourceType,
                                              Integer limit)
                                       throws ApiException,
                                              IOException

Retrieves a list of refunds for the account making the request. Results are eventually consistent, and new refunds or changes to refunds might take several seconds to appear. The maximum results per page is 100.

Parameters:

beginTime - Optional parameter: The timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year.

endTime - Optional parameter: The timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time.

sortOrder - Optional parameter: The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).

locationId - Optional parameter: Limit results to the location supplied. By default, results are returned for all locations associated with the seller.

status - Optional parameter: If provided, only refunds with the given status are returned. For a list of refund status values, see [PaymentRefund]($m/PaymentRefund). Default: If omitted, refunds are returned regardless of their status.

sourceType - Optional parameter: If provided, only returns refunds whose payments have the indicated source type. Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`. For information about these payment source types, see [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). Default: If omitted, refunds are returned regardless of the source type.

limit - Optional parameter: The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, no more than 100 results are returned. Default: 100

Returns:

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

listPaymentRefundsAsync

CompletableFuture<ListPaymentRefundsResponse> listPaymentRefundsAsync(String beginTime,
                                                                      String endTime,
                                                                      String sortOrder,
                                                                      String cursor,
                                                                      String locationId,
                                                                      String status,
                                                                      String sourceType,
                                                                      Integer limit)

Retrieves a list of refunds for the account making the request. Results are eventually consistent, and new refunds or changes to refunds might take several seconds to appear. The maximum results per page is 100.

Parameters:

beginTime - Optional parameter: The timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year.

endTime - Optional parameter: The timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time.

sortOrder - Optional parameter: The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).

locationId - Optional parameter: Limit results to the location supplied. By default, results are returned for all locations associated with the seller.

status - Optional parameter: If provided, only refunds with the given status are returned. For a list of refund status values, see [PaymentRefund]($m/PaymentRefund). Default: If omitted, refunds are returned regardless of their status.

sourceType - Optional parameter: If provided, only returns refunds whose payments have the indicated source type. Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`. For information about these payment source types, see [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). Default: If omitted, refunds are returned regardless of the source type.

limit - Optional parameter: The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, no more than 100 results are returned. Default: 100

Returns:

Returns the ListPaymentRefundsResponse response from the API call

refundPayment

RefundPaymentResponse refundPayment(RefundPaymentRequest body)
                             throws ApiException,
                                    IOException

Refunds a payment. You can refund the entire payment amount or a portion of it. You can use this endpoint to refund a card payment or record a refund of a cash or external payment. For more information, see [Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments).

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

refundPaymentAsync

CompletableFuture<RefundPaymentResponse> refundPaymentAsync(RefundPaymentRequest body)

Refunds a payment. You can refund the entire payment amount or a portion of it. You can use this endpoint to refund a card payment or record a refund of a cash or external payment. For more information, see [Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments).

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 RefundPaymentResponse response from the API call

getPaymentRefund

GetPaymentRefundResponse getPaymentRefund(String refundId)
                                   throws ApiException,
                                          IOException

Retrieves a specific refund using the `refund_id`.

Parameters:

refundId - Required parameter: The unique ID for the desired `PaymentRefund`.

Returns:

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

getPaymentRefundAsync

CompletableFuture<GetPaymentRefundResponse> getPaymentRefundAsync(String refundId)

Retrieves a specific refund using the `refund_id`.

Parameters:

refundId - Required parameter: The unique ID for the desired `PaymentRefund`.

Returns:

Returns the GetPaymentRefundResponse response from the API call