com.squareup.square.api

Class DefaultPayoutsApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultPayoutsApi

All Implemented Interfaces:

PayoutsApi

public final class DefaultPayoutsApi
extends BaseApi
implements PayoutsApi

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

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.

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

DefaultPayoutsApi

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

DefaultPayoutsApi

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

listPayouts

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

Specified by:

listPayouts in interface PayoutsApi

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

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

Specified by:

listPayoutsAsync in interface PayoutsApi

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

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

Specified by:

getPayout in interface PayoutsApi

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

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

Specified by:

getPayoutAsync in interface PayoutsApi

Parameters:

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

Returns:

Returns the GetPayoutResponse response from the API call

listPayoutEntries

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

Specified by:

listPayoutEntries in interface PayoutsApi

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

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

Specified by:

listPayoutEntriesAsync in interface PayoutsApi

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