com.squareup.square.api

Interface PayoutsApi

All Known Implementing Classes:

DefaultPayoutsApi

public interface PayoutsApi

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
GetPayoutResponse	getPayout(String payoutId) Retrieves details of a specific payout identified by a payout ID.
CompletableFuture<GetPayoutResponse>	getPayoutAsync(String payoutId) Retrieves details of a specific payout identified by a payout ID.
ListPayoutEntriesResponse	listPayoutEntries(String payoutId, String sortOrder, String cursor, Integer limit) Retrieves a list of all payout entries for a specific payout.
CompletableFuture<ListPayoutEntriesResponse>	listPayoutEntriesAsync(String payoutId, String sortOrder, String cursor, Integer limit) Retrieves a list of all payout entries for a specific payout.
ListPayoutsResponse	listPayouts(String locationId, String status, String beginTime, String endTime, String sortOrder, String cursor, Integer limit) Retrieves a list of all payouts for the default location.
CompletableFuture<ListPayoutsResponse>	listPayoutsAsync(String locationId, String status, String beginTime, String endTime, String sortOrder, String cursor, Integer limit) Retrieves a list of all payouts for the default location.

Method Detail

listPayouts

ListPayoutsResponse listPayouts(String locationId,
                                String status,
                                String beginTime,
                                String endTime,
                                String sortOrder,
                                String cursor,
                                Integer limit)
                         throws ApiException,
                                IOException

Retrieves a list of all payouts for the default location. You can filter payouts by location ID, status, time range, and order them in ascending or descending order. To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.

Parameters:

locationId - Optional parameter: The ID of the location for which to list the payouts. By default, payouts are returned for the default (main) location associated with the seller.

status - Optional parameter: If provided, only payouts with the given status are returned.

beginTime - Optional parameter: The timestamp for the beginning of the payout creation time, in RFC 3339 format. Inclusive. Default: The current time minus one year.

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

sortOrder - Optional parameter: The order in which payouts are listed.

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). If request parameters change between requests, subsequent results may contain duplicates or missing records.

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. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`

Returns:

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

listPayoutsAsync

CompletableFuture<ListPayoutsResponse> listPayoutsAsync(String locationId,
                                                        String status,
                                                        String beginTime,
                                                        String endTime,
                                                        String sortOrder,
                                                        String cursor,
                                                        Integer limit)

Retrieves a list of all payouts for the default location. You can filter payouts by location ID, status, time range, and order them in ascending or descending order. To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.

Parameters:

locationId - Optional parameter: The ID of the location for which to list the payouts. By default, payouts are returned for the default (main) location associated with the seller.

status - Optional parameter: If provided, only payouts with the given status are returned.

beginTime - Optional parameter: The timestamp for the beginning of the payout creation time, in RFC 3339 format. Inclusive. Default: The current time minus one year.

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

sortOrder - Optional parameter: The order in which payouts are listed.

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). If request parameters change between requests, subsequent results may contain duplicates or missing records.

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. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`

Returns:

Returns the ListPayoutsResponse response from the API call

getPayout

GetPayoutResponse getPayout(String payoutId)
                     throws ApiException,
                            IOException

Retrieves details of a specific payout identified by a payout ID. To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.

Parameters:

payoutId - Required parameter: The ID of the payout to retrieve the information for.

Returns:

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

getPayoutAsync

CompletableFuture<GetPayoutResponse> getPayoutAsync(String payoutId)

Retrieves details of a specific payout identified by a payout ID. To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.

Parameters:

payoutId - Required parameter: The ID of the payout to retrieve the information for.

Returns:

Returns the GetPayoutResponse response from the API call

listPayoutEntries

ListPayoutEntriesResponse listPayoutEntries(String payoutId,
                                            String sortOrder,
                                            String cursor,
                                            Integer limit)
                                     throws ApiException,
                                            IOException

Retrieves a list of all payout entries for a specific payout. To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.

Parameters:

payoutId - Required parameter: The ID of the payout to retrieve the information for.

sortOrder - Optional parameter: The order in which payout entries are listed.

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). If request parameters change between requests, subsequent results may contain duplicates or missing records.

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. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`

Returns:

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

listPayoutEntriesAsync

CompletableFuture<ListPayoutEntriesResponse> listPayoutEntriesAsync(String payoutId,
                                                                    String sortOrder,
                                                                    String cursor,
                                                                    Integer limit)

Retrieves a list of all payout entries for a specific payout. To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.

Parameters:

payoutId - Required parameter: The ID of the payout to retrieve the information for.

sortOrder - Optional parameter: The order in which payout entries are listed.

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). If request parameters change between requests, subsequent results may contain duplicates or missing records.

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. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`

Returns:

Returns the ListPayoutEntriesResponse response from the API call