@@ -33,13 +33,19 @@ public PayoutsAsyncClient(ApiClient apiClient) {
3333 /**
3434 * List payouts
3535 *
36- * <p>Lists ordered payouts for the merchant account.
36+ * <p>Lists payout and payout-deduction records for the specified merchant account within the
37+ * requested date range. The response can include: - regular payouts (`type = PAYOUT`) - deduction
38+ * records for refunds, chargebacks, direct debit returns, or balance adjustments Results are
39+ * sorted by payout date in the requested `order`.
3740 *
3841 * <p>Operation ID: ListPayoutsV1
3942 *
4043 * @param merchantCode Merchant code of the account whose payouts should be listed.
41- * @param endDate End date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
42- * @param startDate Start date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
44+ * @param endDate End date of the payout period filter, inclusive, in
45+ * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date` format (`YYYY-MM-DD`). Must be
46+ * greater than or equal to `start_date`.
47+ * @param startDate Start date of the payout period filter, inclusive, in
48+ * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date` format (`YYYY-MM-DD`).
4349 * <p>Call the overload that accepts optional parameter objects or RequestOptions to customize
4450 * headers, authorization, query values, or timeouts.
4551 * @return CompletableFuture resolved with com.sumup.sdk.models.FinancialPayouts parsed response.
@@ -54,13 +60,19 @@ public CompletableFuture<com.sumup.sdk.models.FinancialPayouts> list(
5460 /**
5561 * List payouts
5662 *
57- * <p>Lists ordered payouts for the merchant account.
63+ * <p>Lists payout and payout-deduction records for the specified merchant account within the
64+ * requested date range. The response can include: - regular payouts (`type = PAYOUT`) - deduction
65+ * records for refunds, chargebacks, direct debit returns, or balance adjustments Results are
66+ * sorted by payout date in the requested `order`.
5867 *
5968 * <p>Operation ID: ListPayoutsV1
6069 *
6170 * @param merchantCode Merchant code of the account whose payouts should be listed.
62- * @param endDate End date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
63- * @param startDate Start date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
71+ * @param endDate End date of the payout period filter, inclusive, in
72+ * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date` format (`YYYY-MM-DD`). Must be
73+ * greater than or equal to `start_date`.
74+ * @param startDate Start date of the payout period filter, inclusive, in
75+ * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date` format (`YYYY-MM-DD`).
6476 * @param listPayoutsV1 Optional query parameters for this request.
6577 * <p>Call the overload that accepts RequestOptions to customize headers, authorization, or
6678 * request timeout.
@@ -79,13 +91,19 @@ public CompletableFuture<com.sumup.sdk.models.FinancialPayouts> list(
7991 /**
8092 * List payouts
8193 *
82- * <p>Lists ordered payouts for the merchant account.
94+ * <p>Lists payout and payout-deduction records for the specified merchant account within the
95+ * requested date range. The response can include: - regular payouts (`type = PAYOUT`) - deduction
96+ * records for refunds, chargebacks, direct debit returns, or balance adjustments Results are
97+ * sorted by payout date in the requested `order`.
8398 *
8499 * <p>Operation ID: ListPayoutsV1
85100 *
86101 * @param merchantCode Merchant code of the account whose payouts should be listed.
87- * @param endDate End date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
88- * @param startDate Start date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
102+ * @param endDate End date of the payout period filter, inclusive, in
103+ * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date` format (`YYYY-MM-DD`). Must be
104+ * greater than or equal to `start_date`.
105+ * @param startDate Start date of the payout period filter, inclusive, in
106+ * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date` format (`YYYY-MM-DD`).
89107 * @param listPayoutsV1 Optional query parameters for this request.
90108 * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass
91109 * {@code null} to use client defaults.
@@ -123,89 +141,6 @@ public CompletableFuture<com.sumup.sdk.models.FinancialPayouts> list(
123141 requestOptions );
124142 }
125143
126- /**
127- * List payouts
128- *
129- * <p>Lists ordered payouts for the merchant account.
130- *
131- * <p>Operation ID: ListPayouts
132- *
133- * @param endDate End date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
134- * @param startDate Start date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
135- * <p>Call the overload that accepts optional parameter objects or RequestOptions to customize
136- * headers, authorization, query values, or timeouts.
137- * @return CompletableFuture resolved with com.sumup.sdk.models.FinancialPayouts parsed response.
138- * @throws ApiException if the SumUp API returns an error.
139- */
140- public CompletableFuture <com .sumup .sdk .models .FinancialPayouts > listDeprecated (
141- java .time .LocalDate endDate , java .time .LocalDate startDate ) throws ApiException {
142- return listDeprecated (endDate , startDate , null );
143- }
144-
145- /**
146- * List payouts
147- *
148- * <p>Lists ordered payouts for the merchant account.
149- *
150- * <p>Operation ID: ListPayouts
151- *
152- * @param endDate End date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
153- * @param startDate Start date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
154- * @param listPayouts Optional query parameters for this request.
155- * <p>Call the overload that accepts RequestOptions to customize headers, authorization, or
156- * request timeout.
157- * @return CompletableFuture resolved with com.sumup.sdk.models.FinancialPayouts parsed response.
158- * @throws ApiException if the SumUp API returns an error.
159- */
160- public CompletableFuture <com .sumup .sdk .models .FinancialPayouts > listDeprecated (
161- java .time .LocalDate endDate ,
162- java .time .LocalDate startDate ,
163- ListPayoutsQueryParams listPayouts )
164- throws ApiException {
165- return listDeprecated (endDate , startDate , listPayouts , null );
166- }
167-
168- /**
169- * List payouts
170- *
171- * <p>Lists ordered payouts for the merchant account.
172- *
173- * <p>Operation ID: ListPayouts
174- *
175- * @param endDate End date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
176- * @param startDate Start date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
177- * @param listPayouts Optional query parameters for this request.
178- * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass
179- * {@code null} to use client defaults.
180- * @return CompletableFuture resolved with com.sumup.sdk.models.FinancialPayouts parsed response.
181- * @throws ApiException if the SumUp API returns an error.
182- */
183- public CompletableFuture <com .sumup .sdk .models .FinancialPayouts > listDeprecated (
184- java .time .LocalDate endDate ,
185- java .time .LocalDate startDate ,
186- ListPayoutsQueryParams listPayouts ,
187- RequestOptions requestOptions )
188- throws ApiException {
189- Objects .requireNonNull (endDate , "endDate" );
190- Objects .requireNonNull (startDate , "startDate" );
191- String path = "/v0.1/me/financials/payouts" ;
192- Map <String , Object > queryParams = new LinkedHashMap <>();
193- queryParams .put ("end_date" , endDate );
194- queryParams .put ("start_date" , startDate );
195- if (listPayouts != null ) {
196- queryParams .putAll (listPayouts .toMap ());
197- }
198-
199- return this .apiClient .sendAsync (
200- HttpMethod .GET ,
201- path ,
202- queryParams ,
203- null ,
204- null ,
205- new TypeReference <com .sumup .sdk .models .FinancialPayouts >() {},
206- requestOptions );
207- }
208-
209144 /** Optional query parameters for this request. */
210145 public static final class ListPayoutsV1QueryParams {
211146 private final Map <String , Object > values = new LinkedHashMap <>();
@@ -252,51 +187,4 @@ Map<String, Object> toMap() {
252187 return values ;
253188 }
254189 }
255-
256- /** Optional query parameters for this request. */
257- public static final class ListPayoutsQueryParams {
258- private final Map <String , Object > values = new LinkedHashMap <>();
259-
260- /**
261- * Sets the format query parameter.
262- *
263- * @param value Response format for the payout list.
264- * @return This ListPayoutsQueryParams instance.
265- */
266- public ListPayoutsQueryParams format (com .sumup .sdk .models .ListPayoutsFormat value ) {
267- this .values .put ("format" , Objects .requireNonNull (value , "format" ));
268- return this ;
269- }
270-
271- /**
272- * Sets the limit query parameter.
273- *
274- * @param value Maximum number of payout records to return.
275- * @return This ListPayoutsQueryParams instance.
276- */
277- public ListPayoutsQueryParams limit (Long value ) {
278- this .values .put ("limit" , Objects .requireNonNull (value , "limit" ));
279- return this ;
280- }
281-
282- /**
283- * Sets the order query parameter.
284- *
285- * @param value Sort direction for the returned payouts.
286- * @return This ListPayoutsQueryParams instance.
287- */
288- public ListPayoutsQueryParams order (com .sumup .sdk .models .ListPayoutsOrder value ) {
289- this .values .put ("order" , Objects .requireNonNull (value , "order" ));
290- return this ;
291- }
292-
293- /**
294- * Converts query parameters to a map understood by ApiClient.
295- *
296- * @return Collected query parameters keyed by API name.
297- */
298- Map <String , Object > toMap () {
299- return values ;
300- }
301- }
302190}
0 commit comments