mollie-api-typescript 1.3.4 → 1.3.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (136) hide show
  1. package/bin/mcp-server.js +646 -42
  2. package/bin/mcp-server.js.map +21 -14
  3. package/dist/commonjs/funcs/settlementsListCaptures.js +0 -1
  4. package/dist/commonjs/funcs/settlementsListCaptures.js.map +1 -1
  5. package/dist/commonjs/funcs/settlementsListPayments.js +0 -1
  6. package/dist/commonjs/funcs/settlementsListPayments.js.map +1 -1
  7. package/dist/commonjs/funcs/settlementsListRefunds.js +0 -1
  8. package/dist/commonjs/funcs/settlementsListRefunds.js.map +1 -1
  9. package/dist/commonjs/hooks/mollie-auth-utils.d.ts.map +1 -1
  10. package/dist/commonjs/hooks/mollie-auth-utils.js +1 -0
  11. package/dist/commonjs/hooks/mollie-auth-utils.js.map +1 -1
  12. package/dist/commonjs/lib/config.d.ts +2 -2
  13. package/dist/commonjs/lib/config.js +2 -2
  14. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  15. package/dist/commonjs/mcp-server/server.js +1 -1
  16. package/dist/commonjs/models/index.d.ts +7 -0
  17. package/dist/commonjs/models/index.d.ts.map +1 -1
  18. package/dist/commonjs/models/index.js +7 -0
  19. package/dist/commonjs/models/index.js.map +1 -1
  20. package/dist/commonjs/models/listsettlementcaptureresponse.d.ts +170 -0
  21. package/dist/commonjs/models/listsettlementcaptureresponse.d.ts.map +1 -0
  22. package/dist/commonjs/models/listsettlementcaptureresponse.js +138 -0
  23. package/dist/commonjs/models/listsettlementcaptureresponse.js.map +1 -0
  24. package/dist/commonjs/models/listsettlementpaymentresponse.d.ts +1326 -0
  25. package/dist/commonjs/models/listsettlementpaymentresponse.d.ts.map +1 -0
  26. package/dist/commonjs/models/listsettlementpaymentresponse.js +599 -0
  27. package/dist/commonjs/models/listsettlementpaymentresponse.js.map +1 -0
  28. package/dist/commonjs/models/listsettlementrefundresponse.d.ts +246 -0
  29. package/dist/commonjs/models/listsettlementrefundresponse.d.ts.map +1 -0
  30. package/dist/commonjs/models/listsettlementrefundresponse.js +193 -0
  31. package/dist/commonjs/models/listsettlementrefundresponse.js.map +1 -0
  32. package/dist/commonjs/models/operations/listsettlementcaptures.d.ts +4 -37
  33. package/dist/commonjs/models/operations/listsettlementcaptures.d.ts.map +1 -1
  34. package/dist/commonjs/models/operations/listsettlementcaptures.js +3 -21
  35. package/dist/commonjs/models/operations/listsettlementcaptures.js.map +1 -1
  36. package/dist/commonjs/models/operations/listsettlementpayments.d.ts +2 -24
  37. package/dist/commonjs/models/operations/listsettlementpayments.d.ts.map +1 -1
  38. package/dist/commonjs/models/operations/listsettlementpayments.js +4 -6
  39. package/dist/commonjs/models/operations/listsettlementpayments.js.map +1 -1
  40. package/dist/commonjs/models/operations/listsettlementrefunds.d.ts +5 -41
  41. package/dist/commonjs/models/operations/listsettlementrefunds.d.ts.map +1 -1
  42. package/dist/commonjs/models/operations/listsettlementrefunds.js +3 -21
  43. package/dist/commonjs/models/operations/listsettlementrefunds.js.map +1 -1
  44. package/dist/commonjs/models/settlementcapturestatus.d.ts +17 -0
  45. package/dist/commonjs/models/settlementcapturestatus.d.ts.map +1 -0
  46. package/dist/commonjs/models/settlementcapturestatus.js +52 -0
  47. package/dist/commonjs/models/settlementcapturestatus.js.map +1 -0
  48. package/dist/commonjs/models/settlementmode.d.ts +17 -0
  49. package/dist/commonjs/models/settlementmode.d.ts.map +1 -0
  50. package/dist/commonjs/models/settlementmode.js +52 -0
  51. package/dist/commonjs/models/settlementmode.js.map +1 -0
  52. package/dist/commonjs/models/settlementpaymentstatus.d.ts +17 -0
  53. package/dist/commonjs/models/settlementpaymentstatus.d.ts.map +1 -0
  54. package/dist/commonjs/models/settlementpaymentstatus.js +52 -0
  55. package/dist/commonjs/models/settlementpaymentstatus.js.map +1 -0
  56. package/dist/commonjs/models/settlementrefundstatus.d.ts +17 -0
  57. package/dist/commonjs/models/settlementrefundstatus.d.ts.map +1 -0
  58. package/dist/commonjs/models/settlementrefundstatus.js +52 -0
  59. package/dist/commonjs/models/settlementrefundstatus.js.map +1 -0
  60. package/dist/esm/funcs/settlementsListCaptures.js +0 -1
  61. package/dist/esm/funcs/settlementsListCaptures.js.map +1 -1
  62. package/dist/esm/funcs/settlementsListPayments.js +0 -1
  63. package/dist/esm/funcs/settlementsListPayments.js.map +1 -1
  64. package/dist/esm/funcs/settlementsListRefunds.js +0 -1
  65. package/dist/esm/funcs/settlementsListRefunds.js.map +1 -1
  66. package/dist/esm/hooks/mollie-auth-utils.d.ts.map +1 -1
  67. package/dist/esm/hooks/mollie-auth-utils.js +1 -0
  68. package/dist/esm/hooks/mollie-auth-utils.js.map +1 -1
  69. package/dist/esm/lib/config.d.ts +2 -2
  70. package/dist/esm/lib/config.js +2 -2
  71. package/dist/esm/mcp-server/mcp-server.js +1 -1
  72. package/dist/esm/mcp-server/server.js +1 -1
  73. package/dist/esm/models/index.d.ts +7 -0
  74. package/dist/esm/models/index.d.ts.map +1 -1
  75. package/dist/esm/models/index.js +7 -0
  76. package/dist/esm/models/index.js.map +1 -1
  77. package/dist/esm/models/listsettlementcaptureresponse.d.ts +170 -0
  78. package/dist/esm/models/listsettlementcaptureresponse.d.ts.map +1 -0
  79. package/dist/esm/models/listsettlementcaptureresponse.js +96 -0
  80. package/dist/esm/models/listsettlementcaptureresponse.js.map +1 -0
  81. package/dist/esm/models/listsettlementpaymentresponse.d.ts +1326 -0
  82. package/dist/esm/models/listsettlementpaymentresponse.d.ts.map +1 -0
  83. package/dist/esm/models/listsettlementpaymentresponse.js +537 -0
  84. package/dist/esm/models/listsettlementpaymentresponse.js.map +1 -0
  85. package/dist/esm/models/listsettlementrefundresponse.d.ts +246 -0
  86. package/dist/esm/models/listsettlementrefundresponse.d.ts.map +1 -0
  87. package/dist/esm/models/listsettlementrefundresponse.js +145 -0
  88. package/dist/esm/models/listsettlementrefundresponse.js.map +1 -0
  89. package/dist/esm/models/operations/listsettlementcaptures.d.ts +4 -37
  90. package/dist/esm/models/operations/listsettlementcaptures.d.ts.map +1 -1
  91. package/dist/esm/models/operations/listsettlementcaptures.js +2 -18
  92. package/dist/esm/models/operations/listsettlementcaptures.js.map +1 -1
  93. package/dist/esm/models/operations/listsettlementpayments.d.ts +2 -24
  94. package/dist/esm/models/operations/listsettlementpayments.d.ts.map +1 -1
  95. package/dist/esm/models/operations/listsettlementpayments.js +4 -6
  96. package/dist/esm/models/operations/listsettlementpayments.js.map +1 -1
  97. package/dist/esm/models/operations/listsettlementrefunds.d.ts +5 -41
  98. package/dist/esm/models/operations/listsettlementrefunds.d.ts.map +1 -1
  99. package/dist/esm/models/operations/listsettlementrefunds.js +2 -18
  100. package/dist/esm/models/operations/listsettlementrefunds.js.map +1 -1
  101. package/dist/esm/models/settlementcapturestatus.d.ts +17 -0
  102. package/dist/esm/models/settlementcapturestatus.d.ts.map +1 -0
  103. package/dist/esm/models/settlementcapturestatus.js +16 -0
  104. package/dist/esm/models/settlementcapturestatus.js.map +1 -0
  105. package/dist/esm/models/settlementmode.d.ts +17 -0
  106. package/dist/esm/models/settlementmode.d.ts.map +1 -0
  107. package/dist/esm/models/settlementmode.js +16 -0
  108. package/dist/esm/models/settlementmode.js.map +1 -0
  109. package/dist/esm/models/settlementpaymentstatus.d.ts +17 -0
  110. package/dist/esm/models/settlementpaymentstatus.d.ts.map +1 -0
  111. package/dist/esm/models/settlementpaymentstatus.js +16 -0
  112. package/dist/esm/models/settlementpaymentstatus.js.map +1 -0
  113. package/dist/esm/models/settlementrefundstatus.d.ts +17 -0
  114. package/dist/esm/models/settlementrefundstatus.d.ts.map +1 -0
  115. package/dist/esm/models/settlementrefundstatus.js +16 -0
  116. package/dist/esm/models/settlementrefundstatus.js.map +1 -0
  117. package/jsr.json +1 -1
  118. package/package.json +1 -1
  119. package/src/funcs/settlementsListCaptures.ts +0 -1
  120. package/src/funcs/settlementsListPayments.ts +0 -1
  121. package/src/funcs/settlementsListRefunds.ts +0 -1
  122. package/src/hooks/mollie-auth-utils.ts +3 -2
  123. package/src/lib/config.ts +2 -2
  124. package/src/mcp-server/mcp-server.ts +1 -1
  125. package/src/mcp-server/server.ts +1 -1
  126. package/src/models/index.ts +7 -0
  127. package/src/models/listsettlementcaptureresponse.ts +360 -0
  128. package/src/models/listsettlementpaymentresponse.ts +2309 -0
  129. package/src/models/listsettlementrefundresponse.ts +580 -0
  130. package/src/models/operations/listsettlementcaptures.ts +6 -73
  131. package/src/models/operations/listsettlementpayments.ts +6 -30
  132. package/src/models/operations/listsettlementrefunds.ts +7 -77
  133. package/src/models/settlementcapturestatus.ts +32 -0
  134. package/src/models/settlementmode.ts +32 -0
  135. package/src/models/settlementpaymentstatus.ts +32 -0
  136. package/src/models/settlementrefundstatus.ts +32 -0
@@ -0,0 +1,2309 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ * @generated-id: 53abdd496217
4
+ */
5
+
6
+ import * as z from "zod/v3";
7
+ import { remap as remap$ } from "../lib/primitives.js";
8
+ import { safeParse } from "../lib/schemas.js";
9
+ import { Result as SafeParseResult } from "../types/fp.js";
10
+ import { RFCDate } from "../types/rfcdate.js";
11
+ import {
12
+ Amount,
13
+ Amount$inboundSchema,
14
+ Amount$Outbound,
15
+ Amount$outboundSchema,
16
+ } from "./amount.js";
17
+ import {
18
+ AmountNullable,
19
+ AmountNullable$inboundSchema,
20
+ AmountNullable$Outbound,
21
+ AmountNullable$outboundSchema,
22
+ } from "./amountnullable.js";
23
+ import {
24
+ CaptureModeResponse,
25
+ CaptureModeResponse$inboundSchema,
26
+ CaptureModeResponse$outboundSchema,
27
+ } from "./capturemoderesponse.js";
28
+ import {
29
+ EntityPaymentRouteResponse,
30
+ EntityPaymentRouteResponse$inboundSchema,
31
+ EntityPaymentRouteResponse$Outbound,
32
+ EntityPaymentRouteResponse$outboundSchema,
33
+ } from "./entitypaymentrouteresponse.js";
34
+ import { SDKValidationError } from "./errors/sdkvalidationerror.js";
35
+ import {
36
+ LineCategoriesResponse,
37
+ LineCategoriesResponse$inboundSchema,
38
+ LineCategoriesResponse$outboundSchema,
39
+ } from "./linecategoriesresponse.js";
40
+ import {
41
+ LocaleResponse,
42
+ LocaleResponse$inboundSchema,
43
+ LocaleResponse$outboundSchema,
44
+ } from "./localeresponse.js";
45
+ import {
46
+ Metadata,
47
+ Metadata$inboundSchema,
48
+ Metadata$Outbound,
49
+ Metadata$outboundSchema,
50
+ } from "./metadata.js";
51
+ import {
52
+ MethodResponse,
53
+ MethodResponse$inboundSchema,
54
+ MethodResponse$outboundSchema,
55
+ } from "./methodresponse.js";
56
+ import {
57
+ PaymentAddress,
58
+ PaymentAddress$inboundSchema,
59
+ PaymentAddress$Outbound,
60
+ PaymentAddress$outboundSchema,
61
+ } from "./paymentaddress.js";
62
+ import {
63
+ PaymentDetailsCardAuditionResponse,
64
+ PaymentDetailsCardAuditionResponse$inboundSchema,
65
+ PaymentDetailsCardAuditionResponse$outboundSchema,
66
+ } from "./paymentdetailscardauditionresponse.js";
67
+ import {
68
+ PaymentDetailsCardFundingResponse,
69
+ PaymentDetailsCardFundingResponse$inboundSchema,
70
+ PaymentDetailsCardFundingResponse$outboundSchema,
71
+ } from "./paymentdetailscardfundingresponse.js";
72
+ import {
73
+ PaymentDetailsCardLabelResponse,
74
+ PaymentDetailsCardLabelResponse$inboundSchema,
75
+ PaymentDetailsCardLabelResponse$outboundSchema,
76
+ } from "./paymentdetailscardlabelresponse.js";
77
+ import {
78
+ PaymentDetailsCardSecurityResponse,
79
+ PaymentDetailsCardSecurityResponse$inboundSchema,
80
+ PaymentDetailsCardSecurityResponse$outboundSchema,
81
+ } from "./paymentdetailscardsecurityresponse.js";
82
+ import {
83
+ PaymentDetailsFailureReasonResponse,
84
+ PaymentDetailsFailureReasonResponse$inboundSchema,
85
+ PaymentDetailsFailureReasonResponse$outboundSchema,
86
+ } from "./paymentdetailsfailurereasonresponse.js";
87
+ import {
88
+ PaymentDetailsFeeRegionResponse,
89
+ PaymentDetailsFeeRegionResponse$inboundSchema,
90
+ PaymentDetailsFeeRegionResponse$outboundSchema,
91
+ } from "./paymentdetailsfeeregionresponse.js";
92
+ import {
93
+ PaymentDetailsReceiptCardReadMethodResponse,
94
+ PaymentDetailsReceiptCardReadMethodResponse$inboundSchema,
95
+ PaymentDetailsReceiptCardReadMethodResponse$outboundSchema,
96
+ } from "./paymentdetailsreceiptcardreadmethodresponse.js";
97
+ import {
98
+ PaymentDetailsReceiptCardVerificationMethodResponse,
99
+ PaymentDetailsReceiptCardVerificationMethodResponse$inboundSchema,
100
+ PaymentDetailsReceiptCardVerificationMethodResponse$outboundSchema,
101
+ } from "./paymentdetailsreceiptcardverificationmethodresponse.js";
102
+ import {
103
+ PaymentDetailsSellerProtectionResponse,
104
+ PaymentDetailsSellerProtectionResponse$inboundSchema,
105
+ PaymentDetailsSellerProtectionResponse$outboundSchema,
106
+ } from "./paymentdetailssellerprotectionresponse.js";
107
+ import {
108
+ PaymentDetailsWalletResponse,
109
+ PaymentDetailsWalletResponse$inboundSchema,
110
+ PaymentDetailsWalletResponse$outboundSchema,
111
+ } from "./paymentdetailswalletresponse.js";
112
+ import {
113
+ PaymentLineTypeResponse,
114
+ PaymentLineTypeResponse$inboundSchema,
115
+ PaymentLineTypeResponse$outboundSchema,
116
+ } from "./paymentlinetyperesponse.js";
117
+ import {
118
+ RecurringLineItem,
119
+ RecurringLineItem$inboundSchema,
120
+ RecurringLineItem$Outbound,
121
+ RecurringLineItem$outboundSchema,
122
+ } from "./recurringlineitem.js";
123
+ import {
124
+ SequenceTypeResponse,
125
+ SequenceTypeResponse$inboundSchema,
126
+ SequenceTypeResponse$outboundSchema,
127
+ } from "./sequencetyperesponse.js";
128
+ import {
129
+ SettlementMode,
130
+ SettlementMode$inboundSchema,
131
+ SettlementMode$outboundSchema,
132
+ } from "./settlementmode.js";
133
+ import {
134
+ SettlementPaymentStatus,
135
+ SettlementPaymentStatus$inboundSchema,
136
+ SettlementPaymentStatus$outboundSchema,
137
+ } from "./settlementpaymentstatus.js";
138
+ import {
139
+ StatusReason,
140
+ StatusReason$inboundSchema,
141
+ StatusReason$Outbound,
142
+ StatusReason$outboundSchema,
143
+ } from "./statusreason.js";
144
+ import {
145
+ Url,
146
+ Url$inboundSchema,
147
+ Url$Outbound,
148
+ Url$outboundSchema,
149
+ } from "./url.js";
150
+ import {
151
+ UrlNullable,
152
+ UrlNullable$inboundSchema,
153
+ UrlNullable$Outbound,
154
+ UrlNullable$outboundSchema,
155
+ } from "./urlnullable.js";
156
+
157
+ /**
158
+ * The total amount that is already refunded. Only available when refunds are available for this payment. For some
159
+ *
160
+ * @remarks
161
+ * payment methods, this amount may be higher than the payment amount, for example to allow reimbursement of the
162
+ * costs for a return shipment to the customer.
163
+ */
164
+ export type ListSettlementPaymentResponseAmountRefunded = {
165
+ /**
166
+ * A three-character ISO 4217 currency code.
167
+ */
168
+ currency: string;
169
+ /**
170
+ * A string containing an exact monetary amount in the given currency.
171
+ */
172
+ value: string;
173
+ };
174
+
175
+ /**
176
+ * The remaining amount that can be refunded. Only available when refunds are available for this payment.
177
+ */
178
+ export type ListSettlementPaymentResponseAmountRemaining = {
179
+ /**
180
+ * A three-character ISO 4217 currency code.
181
+ */
182
+ currency: string;
183
+ /**
184
+ * A string containing an exact monetary amount in the given currency.
185
+ */
186
+ value: string;
187
+ };
188
+
189
+ /**
190
+ * The total amount that is already captured for this payment. Only available when this payment supports captures.
191
+ */
192
+ export type ListSettlementPaymentResponseAmountCaptured = {
193
+ /**
194
+ * A three-character ISO 4217 currency code.
195
+ */
196
+ currency: string;
197
+ /**
198
+ * A string containing an exact monetary amount in the given currency.
199
+ */
200
+ value: string;
201
+ };
202
+
203
+ /**
204
+ * The total amount that was charged back for this payment. Only available when the total charged back amount is not
205
+ *
206
+ * @remarks
207
+ * zero.
208
+ */
209
+ export type ListSettlementPaymentResponseAmountChargedBack = {
210
+ /**
211
+ * A three-character ISO 4217 currency code.
212
+ */
213
+ currency: string;
214
+ /**
215
+ * A string containing an exact monetary amount in the given currency.
216
+ */
217
+ value: string;
218
+ };
219
+
220
+ /**
221
+ * This optional field will contain the approximate amount that will be settled to your account, converted to the
222
+ *
223
+ * @remarks
224
+ * currency your account is settled in.
225
+ *
226
+ * Any amounts not settled by Mollie will not be reflected in this amount, e.g. PayPal or gift cards. If no amount is
227
+ * settled by Mollie the `settlementAmount` is omitted from the response.
228
+ *
229
+ * Please note that this amount might be recalculated and changed when the status of the payment changes. We suggest
230
+ * using the List balance transactions endpoint instead to get more accurate settlement amounts for your payments.
231
+ */
232
+ export type ListSettlementPaymentResponseSettlementAmount = {
233
+ /**
234
+ * A three-character ISO 4217 currency code.
235
+ */
236
+ currency: string;
237
+ /**
238
+ * A string containing an exact monetary amount in the given currency.
239
+ */
240
+ value: string;
241
+ };
242
+
243
+ export type ListSettlementPaymentResponseLine = {
244
+ /**
245
+ * The type of product purchased. For example, a physical or a digital product.
246
+ *
247
+ * @remarks
248
+ *
249
+ * The `tip` payment line type is not available when creating a payment.
250
+ */
251
+ type?: PaymentLineTypeResponse | undefined;
252
+ /**
253
+ * A description of the line item. For example *LEGO 4440 Forest Police Station*.
254
+ */
255
+ description: string;
256
+ /**
257
+ * The number of items.
258
+ */
259
+ quantity: number;
260
+ /**
261
+ * The unit for the quantity. For example *pcs*, *kg*, or *cm*.
262
+ */
263
+ quantityUnit?: string | undefined;
264
+ /**
265
+ * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
266
+ */
267
+ unitPrice: Amount;
268
+ /**
269
+ * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
270
+ */
271
+ discountAmount?: Amount | undefined;
272
+ /**
273
+ * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
274
+ */
275
+ totalAmount: Amount;
276
+ /**
277
+ * The VAT rate applied to the line, for example `21.00` for 21%. The vatRate should be passed as a string and
278
+ *
279
+ * @remarks
280
+ * not as a float, to ensure the correct number of decimals are passed.
281
+ */
282
+ vatRate?: string | undefined;
283
+ /**
284
+ * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
285
+ */
286
+ vatAmount?: Amount | undefined;
287
+ /**
288
+ * The SKU, EAN, ISBN or UPC of the product sold.
289
+ */
290
+ sku?: string | undefined;
291
+ /**
292
+ * An array with the voucher categories, in case of a line eligible for a voucher. See the
293
+ *
294
+ * @remarks
295
+ * [Integrating Vouchers](https://docs.mollie.com/docs/integrating-vouchers/) guide for more information.
296
+ */
297
+ categories?: Array<LineCategoriesResponse> | undefined;
298
+ /**
299
+ * A link pointing to an image of the product sold.
300
+ */
301
+ imageUrl?: string | undefined;
302
+ /**
303
+ * A link pointing to the product page in your web shop of the product sold.
304
+ */
305
+ productUrl?: string | undefined;
306
+ recurring?: RecurringLineItem | undefined;
307
+ };
308
+
309
+ /**
310
+ * The customer's billing address details. We advise to provide these details to improve fraud protection and
311
+ *
312
+ * @remarks
313
+ * conversion.
314
+ *
315
+ * Should include `email` or a valid postal address consisting of `streetAndNumber`, `postalCode`, `city` and
316
+ * `country`.
317
+ *
318
+ * Required for payment method `alma`, `in3`, `klarna`, `billie` and `riverty`.
319
+ */
320
+ export type ListSettlementPaymentResponseBillingAddress = {
321
+ /**
322
+ * The title of the person, for example *Mr.* or *Mrs.*.
323
+ */
324
+ title?: string | undefined;
325
+ /**
326
+ * The given name (first name) of the person should be at least two characters and cannot contain only
327
+ *
328
+ * @remarks
329
+ * numbers.
330
+ *
331
+ * Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
332
+ */
333
+ givenName?: string | undefined;
334
+ /**
335
+ * The given family name (surname) of the person should be at least two characters and cannot contain only
336
+ *
337
+ * @remarks
338
+ * numbers.
339
+ *
340
+ * Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
341
+ */
342
+ familyName?: string | undefined;
343
+ /**
344
+ * The name of the organization, in case the addressee is an organization.
345
+ *
346
+ * @remarks
347
+ *
348
+ * Required for payment method `billie`.
349
+ */
350
+ organizationName?: any | undefined;
351
+ /**
352
+ * A street and street number.
353
+ *
354
+ * @remarks
355
+ *
356
+ * Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
357
+ */
358
+ streetAndNumber?: string | undefined;
359
+ /**
360
+ * Any additional addressing details, for example an apartment number.
361
+ */
362
+ streetAdditional?: string | undefined;
363
+ /**
364
+ * A postal code. This field may be required if the provided country has a postal code system.
365
+ *
366
+ * @remarks
367
+ *
368
+ * Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
369
+ */
370
+ postalCode?: string | undefined;
371
+ /**
372
+ * A valid e-mail address.
373
+ *
374
+ * @remarks
375
+ *
376
+ * If you provide the email address for a `banktransfer` payment, we will automatically send the instructions
377
+ * email upon payment creation. The language of the email will follow the locale parameter of the payment.
378
+ *
379
+ * Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
380
+ */
381
+ email?: string | undefined;
382
+ /**
383
+ * If provided, it must be in the [E.164](https://en.wikipedia.org/wiki/E.164) format. For example: +31208202070.
384
+ */
385
+ phone?: string | undefined;
386
+ /**
387
+ * A city name.
388
+ *
389
+ * @remarks
390
+ *
391
+ * Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
392
+ */
393
+ city?: string | undefined;
394
+ /**
395
+ * The top-level administrative subdivision of the country. For example: Noord-Holland.
396
+ */
397
+ region?: string | undefined;
398
+ /**
399
+ * A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
400
+ *
401
+ * @remarks
402
+ *
403
+ * Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
404
+ */
405
+ country?: string | undefined;
406
+ };
407
+
408
+ /**
409
+ * With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
410
+ *
411
+ * @remarks
412
+ * merchants.
413
+ *
414
+ * If you use OAuth to create payments on a connected merchant's account, you can charge a fee using this
415
+ * `applicationFee` parameter. If the payment succeeds, the fee will be deducted from the merchant's balance and sent
416
+ * to your own account balance.
417
+ *
418
+ * If instead you want to split a payment on your own account between yourself and a connected merchant, refer to the
419
+ * `routing` parameter.
420
+ */
421
+ export type ListSettlementPaymentResponseApplicationFee = {
422
+ /**
423
+ * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
424
+ */
425
+ amount?: Amount | undefined;
426
+ /**
427
+ * The description of the application fee. This will appear on settlement reports towards both you and the
428
+ *
429
+ * @remarks
430
+ * connected merchant.
431
+ */
432
+ description?: string | undefined;
433
+ };
434
+
435
+ /**
436
+ * The Point of sale receipt object.
437
+ */
438
+ export type ListSettlementPaymentResponseReceipt = {
439
+ /**
440
+ * A unique code provided by the cardholder’s bank to confirm that the transaction was successfully approved.
441
+ */
442
+ authorizationCode?: string | null | undefined;
443
+ /**
444
+ * The unique number that identifies a specific payment application on a chip card.
445
+ */
446
+ applicationIdentifier?: string | null | undefined;
447
+ /**
448
+ * The method by which the card was read by the terminal.
449
+ */
450
+ cardReadMethod?:
451
+ | PaymentDetailsReceiptCardReadMethodResponse
452
+ | null
453
+ | undefined;
454
+ /**
455
+ * The method used to verify the cardholder's identity.
456
+ */
457
+ cardVerificationMethod?:
458
+ | PaymentDetailsReceiptCardVerificationMethodResponse
459
+ | null
460
+ | undefined;
461
+ };
462
+
463
+ /**
464
+ * Optional include. If a QR code was requested during payment creation for a QR-compatible payment method,
465
+ *
466
+ * @remarks
467
+ * the QR code details will be available in this object.
468
+ *
469
+ * The QR code can be scanned by the customer to complete the payment on their mobile device. For example,
470
+ * Bancontact QR payments can be completed by the customer using the Bancontact app.
471
+ */
472
+ export type ListSettlementPaymentResponseQrCode = {
473
+ /**
474
+ * The height of the QR code image in pixels.
475
+ */
476
+ height?: number | undefined;
477
+ /**
478
+ * The width of the QR code image in pixels.
479
+ */
480
+ width?: number | undefined;
481
+ /**
482
+ * The URL to the QR code image. The image is a PNG file, and can be displayed directly in the browser or
483
+ *
484
+ * @remarks
485
+ * downloaded.
486
+ */
487
+ src?: string | undefined;
488
+ };
489
+
490
+ /**
491
+ * An object containing payment details collected during the payment process. For example, details may include the
492
+ *
493
+ * @remarks
494
+ * customer's card or bank details and a payment reference. For the full list of details, please refer to the
495
+ * [method-specific parameters](extra-payment-parameters) guide.
496
+ */
497
+ export type ListSettlementPaymentResponseDetails = {
498
+ /**
499
+ * The customer's name, if made available by the payment method. For card payments, refer to details.cardHolder.
500
+ */
501
+ consumerName?: string | null | undefined;
502
+ /**
503
+ * The customer's account reference.
504
+ *
505
+ * @remarks
506
+ *
507
+ * For banking-based payment methods — such as iDEAL — this is normally either an IBAN or a domestic bank account
508
+ * number.
509
+ *
510
+ * For PayPal, the account reference is an email address.
511
+ *
512
+ * For card and Bancontact payments, refer to details.cardNumber.
513
+ */
514
+ consumerAccount?: string | null | undefined;
515
+ /**
516
+ * The BIC of the customer's bank account, if applicable.
517
+ */
518
+ consumerBic?: string | null | undefined;
519
+ /**
520
+ * For wallet payment methods — such as Apple Pay and PayPal — the shipping address is often already known by the
521
+ *
522
+ * @remarks
523
+ * wallet provider. In these cases the shipping address may be available as a payment detail.
524
+ */
525
+ shippingAddress?: { [k: string]: any } | null | undefined;
526
+ /**
527
+ * For bancontact, it will be the customer's masked card number. For cards, it will be the last 4-digit of the
528
+ *
529
+ * @remarks
530
+ * PAN. For Point-of-sale, it will be the the last 4 digits of the customer's masked card number.
531
+ */
532
+ cardNumber?: string | null | undefined;
533
+ /**
534
+ * The name of the bank that the customer will need to make the bank transfer payment towards.
535
+ */
536
+ bankName?: string | undefined;
537
+ /**
538
+ * The bank account number the customer will need to make the bank transfer payment towards.
539
+ */
540
+ bankAccount?: string | undefined;
541
+ /**
542
+ * The BIC of the bank the customer will need to make the bank transfer payment towards.
543
+ */
544
+ bankBic?: string | undefined;
545
+ /**
546
+ * The Mollie-generated reference the customer needs to use when transfering the amount. Do not apply any
547
+ *
548
+ * @remarks
549
+ * formatting here; show it to the customer as-is.
550
+ */
551
+ transferReference?: string | null | undefined;
552
+ /**
553
+ * A unique fingerprint for a specific card. Can be used to identify returning customers.
554
+ *
555
+ * @remarks
556
+ *
557
+ * In the case of Point-of-sale payments, it's a unique identifier assigned to a cardholder's payment account,
558
+ * linking multiple transactions from wallets and physical card to a single account, also across payment methods
559
+ * or when the card is reissued.
560
+ */
561
+ cardFingerprint?: string | null | undefined;
562
+ /**
563
+ * The customer's name as shown on their card.
564
+ */
565
+ cardHolder?: string | null | undefined;
566
+ /**
567
+ * The card's target audience, if known.
568
+ */
569
+ cardAudition?: PaymentDetailsCardAuditionResponse | null | undefined;
570
+ /**
571
+ * The card's label, if known.
572
+ */
573
+ cardLabel?: PaymentDetailsCardLabelResponse | null | undefined;
574
+ /**
575
+ * The ISO 3166-1 alpha-2 country code of the country the card was issued in.
576
+ */
577
+ cardCountryCode?: string | null | undefined;
578
+ /**
579
+ * The expiry date (MM/YY) of the card as displayed on the card.
580
+ */
581
+ cardExpiryDate?: string | null | undefined;
582
+ /**
583
+ * The card type.
584
+ */
585
+ cardFunding?: PaymentDetailsCardFundingResponse | null | undefined;
586
+ /**
587
+ * The level of security applied during card processing.
588
+ */
589
+ cardSecurity?: PaymentDetailsCardSecurityResponse | null | undefined;
590
+ /**
591
+ * The applicable card fee region.
592
+ */
593
+ feeRegion?: PaymentDetailsFeeRegionResponse | null | undefined;
594
+ /**
595
+ * The first 6 and last 4 digits of the card number.
596
+ */
597
+ cardMaskedNumber?: string | null | undefined;
598
+ /**
599
+ * The outcome of authentication attempted on transactions enforced by 3DS (ie valid only for oneoff and first).
600
+ */
601
+ card3dsEci?: string | null | undefined;
602
+ /**
603
+ * The first 6 digit of the card bank identification number.
604
+ */
605
+ cardBin?: string | null | undefined;
606
+ /**
607
+ * The issuer of the Card.
608
+ */
609
+ cardIssuer?: string | null | undefined;
610
+ /**
611
+ * A failure code to help understand why the payment failed.
612
+ */
613
+ failureReason?: PaymentDetailsFailureReasonResponse | null | undefined;
614
+ /**
615
+ * A human-friendly failure message that can be shown to the customer. The message is translated in accordance
616
+ *
617
+ * @remarks
618
+ * with the payment's locale setting.
619
+ */
620
+ failureMessage?: string | null | undefined;
621
+ /**
622
+ * The wallet used when creating the payment.
623
+ */
624
+ wallet?: PaymentDetailsWalletResponse | null | undefined;
625
+ /**
626
+ * PayPal's reference for the payment.
627
+ */
628
+ paypalReference?: string | null | undefined;
629
+ /**
630
+ * ID of the customer's PayPal account.
631
+ */
632
+ paypalPayerId?: string | null | undefined;
633
+ /**
634
+ * Indicates to what extent the payment is eligible for PayPal's Seller Protection. Only available for PayPal
635
+ *
636
+ * @remarks
637
+ * payments, and if the information is made available by PayPal.
638
+ */
639
+ sellerProtection?: PaymentDetailsSellerProtectionResponse | null | undefined;
640
+ /**
641
+ * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
642
+ */
643
+ paypalFee?: AmountNullable | null | undefined;
644
+ /**
645
+ * The paysafecard customer reference either provided via the API or otherwise auto-generated by Mollie.
646
+ */
647
+ customerReference?: string | undefined;
648
+ /**
649
+ * The ID of the terminal device where the payment took place on.
650
+ */
651
+ terminalId?: string | undefined;
652
+ /**
653
+ * The first 6 digits & last 4 digits of the customer's masked card number.
654
+ */
655
+ maskedNumber?: string | null | undefined;
656
+ /**
657
+ * The Point of sale receipt object.
658
+ */
659
+ receipt?: ListSettlementPaymentResponseReceipt | undefined;
660
+ /**
661
+ * The creditor identifier indicates who is authorized to execute the payment. In this case, it is a
662
+ *
663
+ * @remarks
664
+ * reference to Mollie.
665
+ */
666
+ creditorIdentifier?: string | null | undefined;
667
+ /**
668
+ * Estimated date the payment is debited from the customer's bank account, in YYYY-MM-DD format.
669
+ */
670
+ dueDate?: RFCDate | null | undefined;
671
+ /**
672
+ * Date the payment has been signed by the customer, in YYYY-MM-DD format. Only available if the payment
673
+ *
674
+ * @remarks
675
+ * has been signed.
676
+ */
677
+ signatureDate?: RFCDate | null | undefined;
678
+ /**
679
+ * The official reason why this payment has failed. A detailed description of each reason is available on the
680
+ *
681
+ * @remarks
682
+ * website of the European Payments Council.
683
+ */
684
+ bankReasonCode?: string | null | undefined;
685
+ /**
686
+ * A human-friendly description of the failure reason.
687
+ */
688
+ bankReason?: string | null | undefined;
689
+ /**
690
+ * The end-to-end identifier you provided in the batch file.
691
+ */
692
+ endToEndIdentifier?: string | null | undefined;
693
+ /**
694
+ * The mandate reference you provided in the batch file.
695
+ */
696
+ mandateReference?: string | null | undefined;
697
+ /**
698
+ * The batch reference you provided in the batch file.
699
+ */
700
+ batchReference?: string | null | undefined;
701
+ /**
702
+ * The file reference you provided in the batch file.
703
+ */
704
+ fileReference?: string | null | undefined;
705
+ /**
706
+ * Optional include. If a QR code was requested during payment creation for a QR-compatible payment method,
707
+ *
708
+ * @remarks
709
+ * the QR code details will be available in this object.
710
+ *
711
+ * The QR code can be scanned by the customer to complete the payment on their mobile device. For example,
712
+ * Bancontact QR payments can be completed by the customer using the Bancontact app.
713
+ */
714
+ qrCode?: ListSettlementPaymentResponseQrCode | undefined;
715
+ /**
716
+ * For payments with gift cards: the masked gift card number of the first gift card applied to the payment.
717
+ */
718
+ voucherNumber?: string | undefined;
719
+ /**
720
+ * An array of detail objects for each gift card that was used on this payment, if any.
721
+ */
722
+ giftcards?: Array<{ [k: string]: any }> | undefined;
723
+ /**
724
+ * For payments with vouchers: the brand name of the first voucher applied.
725
+ */
726
+ issuer?: string | undefined;
727
+ /**
728
+ * An array of detail objects for each voucher that was used on this payment, if any.
729
+ */
730
+ vouchers?: Array<{ [k: string]: any }> | undefined;
731
+ /**
732
+ * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
733
+ */
734
+ remainderAmount?: Amount | undefined;
735
+ /**
736
+ * The payment method used to pay the remainder amount, after all gift cards or vouchers were applied.
737
+ */
738
+ remainderMethod?: string | undefined;
739
+ /**
740
+ * Optional include. The full payment method details of the remainder payment.
741
+ */
742
+ remainderDetails?: { [k: string]: any } | undefined;
743
+ /**
744
+ * Multibanco payment reference of the transaction
745
+ */
746
+ multibancoReference?: string | null | undefined;
747
+ /**
748
+ * Multibanco entity reference of the transaction
749
+ */
750
+ multibancoEntity?: string | null | undefined;
751
+ };
752
+
753
+ /**
754
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
755
+ */
756
+ export type ListSettlementPaymentResponseLinks = {
757
+ /**
758
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
759
+ */
760
+ self: Url;
761
+ /**
762
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
763
+ */
764
+ checkout?: Url | undefined;
765
+ /**
766
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
767
+ */
768
+ mobileAppCheckout?: Url | undefined;
769
+ /**
770
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
771
+ */
772
+ changePaymentState?: UrlNullable | null | undefined;
773
+ /**
774
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
775
+ */
776
+ dashboard: Url;
777
+ /**
778
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
779
+ */
780
+ refunds?: Url | undefined;
781
+ /**
782
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
783
+ */
784
+ chargebacks?: Url | undefined;
785
+ /**
786
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
787
+ */
788
+ captures?: Url | undefined;
789
+ /**
790
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
791
+ */
792
+ settlement?: Url | undefined;
793
+ /**
794
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
795
+ */
796
+ customer?: Url | undefined;
797
+ /**
798
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
799
+ */
800
+ mandate?: Url | undefined;
801
+ /**
802
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
803
+ */
804
+ subscription?: Url | undefined;
805
+ /**
806
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
807
+ */
808
+ order?: Url | undefined;
809
+ /**
810
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
811
+ */
812
+ terminal?: Url | undefined;
813
+ /**
814
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
815
+ */
816
+ status?: Url | undefined;
817
+ /**
818
+ * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
819
+ */
820
+ payOnline?: Url | undefined;
821
+ };
822
+
823
+ export type ListSettlementPaymentResponse = {
824
+ /**
825
+ * Indicates the response contains a payment object. Will always contain the string `payment` for this endpoint.
826
+ */
827
+ resource: string;
828
+ /**
829
+ * The identifier uniquely referring to this payment. Mollie assigns this identifier at payment creation time. Mollie
830
+ *
831
+ * @remarks
832
+ * will always refer to the payment by this ID. Example: `tr_5B8cwPMGnU6qLbRvo7qEZo`.
833
+ */
834
+ id: string;
835
+ /**
836
+ * Whether this entity was created in live mode or in test mode. Settlements are always in live mode.
837
+ */
838
+ mode: SettlementMode;
839
+ /**
840
+ * The description of the payment. This will be shown to your customer on their card or bank statement when possible.
841
+ *
842
+ * @remarks
843
+ * We truncate the description automatically according to the limits of the used payment method. The description is
844
+ * also visible in any exports you generate.
845
+ *
846
+ * We recommend you use a unique identifier so that you can always link the payment to the order in your back office.
847
+ * This is particularly useful for bookkeeping.
848
+ *
849
+ * The maximum length of the description field differs per payment method, with the absolute maximum being 255
850
+ * characters. The API will not reject strings longer than the maximum length but it will truncate them to fit.
851
+ */
852
+ description: string;
853
+ /**
854
+ * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
855
+ */
856
+ amount: Amount;
857
+ /**
858
+ * The total amount that is already refunded. Only available when refunds are available for this payment. For some
859
+ *
860
+ * @remarks
861
+ * payment methods, this amount may be higher than the payment amount, for example to allow reimbursement of the
862
+ * costs for a return shipment to the customer.
863
+ */
864
+ amountRefunded?: ListSettlementPaymentResponseAmountRefunded | undefined;
865
+ /**
866
+ * The remaining amount that can be refunded. Only available when refunds are available for this payment.
867
+ */
868
+ amountRemaining?: ListSettlementPaymentResponseAmountRemaining | undefined;
869
+ /**
870
+ * The total amount that is already captured for this payment. Only available when this payment supports captures.
871
+ */
872
+ amountCaptured?: ListSettlementPaymentResponseAmountCaptured | undefined;
873
+ /**
874
+ * The total amount that was charged back for this payment. Only available when the total charged back amount is not
875
+ *
876
+ * @remarks
877
+ * zero.
878
+ */
879
+ amountChargedBack?:
880
+ | ListSettlementPaymentResponseAmountChargedBack
881
+ | undefined;
882
+ /**
883
+ * This optional field will contain the approximate amount that will be settled to your account, converted to the
884
+ *
885
+ * @remarks
886
+ * currency your account is settled in.
887
+ *
888
+ * Any amounts not settled by Mollie will not be reflected in this amount, e.g. PayPal or gift cards. If no amount is
889
+ * settled by Mollie the `settlementAmount` is omitted from the response.
890
+ *
891
+ * Please note that this amount might be recalculated and changed when the status of the payment changes. We suggest
892
+ * using the List balance transactions endpoint instead to get more accurate settlement amounts for your payments.
893
+ */
894
+ settlementAmount?: ListSettlementPaymentResponseSettlementAmount | undefined;
895
+ /**
896
+ * The URL your customer will be redirected to after the payment process.
897
+ *
898
+ * @remarks
899
+ *
900
+ * It could make sense for the redirectUrl to contain a unique identifier – like your order ID – so you can show the
901
+ * right page referencing the order when your customer returns.
902
+ *
903
+ * The parameter is normally required, but can be omitted for recurring payments (`sequenceType: recurring`) and for
904
+ * Apple Pay payments with an `applePayPaymentToken`.
905
+ */
906
+ redirectUrl?: string | null | undefined;
907
+ /**
908
+ * The URL your customer will be redirected to when the customer explicitly cancels the payment. If this URL is not
909
+ *
910
+ * @remarks
911
+ * provided, the customer will be redirected to the `redirectUrl` instead — see above.
912
+ *
913
+ * Mollie will always give you status updates via webhooks, including for the canceled status. This parameter is
914
+ * therefore entirely optional, but can be useful when implementing a dedicated customer-facing flow to handle
915
+ * payment cancellations.
916
+ */
917
+ cancelUrl?: string | null | undefined;
918
+ /**
919
+ * The webhook URL where we will send payment status updates to.
920
+ *
921
+ * @remarks
922
+ *
923
+ * The webhookUrl is optional, but without a webhook you will miss out on important status changes to your payment.
924
+ *
925
+ * The webhookUrl must be reachable from Mollie's point of view, so you cannot use `localhost`. If you want to use
926
+ * webhook during development on `localhost`, you must use a tool like ngrok to have the webhooks delivered to your
927
+ * local machine.
928
+ */
929
+ webhookUrl?: string | null | undefined;
930
+ /**
931
+ * Optionally provide the order lines for the payment. Each line contains details such as a description of the item
932
+ *
933
+ * @remarks
934
+ * ordered and its price.
935
+ *
936
+ * All lines must have the same currency as the payment.
937
+ *
938
+ * Required for payment methods `billie`, `in3`, `klarna`, `riverty` and `voucher`.
939
+ */
940
+ lines?: Array<ListSettlementPaymentResponseLine> | null | undefined;
941
+ /**
942
+ * The customer's billing address details. We advise to provide these details to improve fraud protection and
943
+ *
944
+ * @remarks
945
+ * conversion.
946
+ *
947
+ * Should include `email` or a valid postal address consisting of `streetAndNumber`, `postalCode`, `city` and
948
+ * `country`.
949
+ *
950
+ * Required for payment method `alma`, `in3`, `klarna`, `billie` and `riverty`.
951
+ */
952
+ billingAddress?: ListSettlementPaymentResponseBillingAddress | undefined;
953
+ shippingAddress?: PaymentAddress | undefined;
954
+ /**
955
+ * Allows you to preset the language to be used.
956
+ */
957
+ locale?: LocaleResponse | null | undefined;
958
+ /**
959
+ * This optional field contains your customer's ISO 3166-1 alpha-2 country code, detected by us during checkout. This
960
+ *
961
+ * @remarks
962
+ * field is omitted if the country code was not detected.
963
+ */
964
+ countryCode?: string | null | undefined;
965
+ /**
966
+ * Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment
967
+ *
968
+ * @remarks
969
+ * method and your customer will skip the selection screen and is sent directly to the chosen payment method. The
970
+ * parameter enables you to fully integrate the payment method selection into your website.
971
+ *
972
+ * You can also specify the methods in an array. By doing so we will still show the payment method selection screen
973
+ * but will only show the methods specified in the array. For example, you can use this functionality to only show
974
+ * payment methods from a specific country to your customer `['bancontact', 'belfius']`.
975
+ */
976
+ method?: MethodResponse | null | undefined;
977
+ /**
978
+ * For digital goods in most jurisdictions, you must apply the VAT rate from your customer's country. Choose the VAT
979
+ *
980
+ * @remarks
981
+ * rates you have used for the order to ensure your customer's country matches the VAT country.
982
+ *
983
+ * Use this parameter to restrict the payment methods available to your customer to those from a single country.
984
+ *
985
+ * If available, the credit card method will still be offered, but only cards from the allowed country are accepted.
986
+ *
987
+ * The field expects a country code in ISO 3166-1 alpha-2 format, for example `NL`.
988
+ */
989
+ restrictPaymentMethodsToCountry?: string | null | undefined;
990
+ /**
991
+ * Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
992
+ *
993
+ * @remarks
994
+ * you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
995
+ */
996
+ metadata?: Metadata | null | undefined;
997
+ /**
998
+ * Indicate if the funds should be captured immediately or if you want to [place a hold](https://docs.mollie.com/docs/place-a-hold-for-a-payment#/)
999
+ *
1000
+ * @remarks
1001
+ * and capture at a later time.
1002
+ *
1003
+ * This field needs to be set to `manual` for method `riverty`.
1004
+ */
1005
+ captureMode?: CaptureModeResponse | null | undefined;
1006
+ /**
1007
+ * **Only relevant if you wish to manage authorization and capturing separately.**
1008
+ *
1009
+ * @remarks
1010
+ *
1011
+ * Some payment methods allow placing a hold on the card or bank account. This hold or 'authorization' can then at a
1012
+ * later point either be 'captured' or canceled.
1013
+ *
1014
+ * By default, we charge the customer's card or bank account immediately when they complete the payment. If you set a
1015
+ * capture delay however, we will delay the automatic capturing of the payment for the specified amount of time. For
1016
+ * example `8 hours` or `2 days`.
1017
+ *
1018
+ * To schedule an automatic capture, the `captureMode` must be set to `automatic`.
1019
+ *
1020
+ * The maximum delay is 7 days (168 hours).
1021
+ *
1022
+ * Possible values: `... hours` `... days`
1023
+ */
1024
+ captureDelay?: string | null | undefined;
1025
+ /**
1026
+ * Indicates the date before which the payment needs to be captured, in ISO 8601 format. From this date onwards we
1027
+ *
1028
+ * @remarks
1029
+ * can no longer guarantee a successful capture. The parameter is omitted if the payment is not authorized (yet).
1030
+ */
1031
+ captureBefore?: string | null | undefined;
1032
+ /**
1033
+ * With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
1034
+ *
1035
+ * @remarks
1036
+ * merchants.
1037
+ *
1038
+ * If you use OAuth to create payments on a connected merchant's account, you can charge a fee using this
1039
+ * `applicationFee` parameter. If the payment succeeds, the fee will be deducted from the merchant's balance and sent
1040
+ * to your own account balance.
1041
+ *
1042
+ * If instead you want to split a payment on your own account between yourself and a connected merchant, refer to the
1043
+ * `routing` parameter.
1044
+ */
1045
+ applicationFee?:
1046
+ | ListSettlementPaymentResponseApplicationFee
1047
+ | null
1048
+ | undefined;
1049
+ /**
1050
+ * *This functionality is not enabled by default. Reach out to our partner management team if you wish to use it.*
1051
+ *
1052
+ * @remarks
1053
+ *
1054
+ * With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
1055
+ * merchants.
1056
+ *
1057
+ * If you create payments on your own account that you want to split between yourself and one or more connected
1058
+ * merchants, you can use this `routing` parameter to route the payment accordingly.
1059
+ *
1060
+ * The `routing` parameter should contain an array of objects, with each object describing the destination for a
1061
+ * specific portion of the payment.
1062
+ *
1063
+ * It is not necessary to indicate in the array which portion goes to yourself. After all portions of the total
1064
+ * payment amount have been routed, the amount left will be routed to the current organization automatically.
1065
+ *
1066
+ * If instead you use OAuth to create payments on a connected merchant's account, refer to the `applicationFee`
1067
+ * parameter.
1068
+ */
1069
+ routing?: Array<EntityPaymentRouteResponse> | null | undefined;
1070
+ sequenceType: SequenceTypeResponse;
1071
+ /**
1072
+ * If the payment was automatically created via a subscription, the ID of the [subscription](get-subscription) will
1073
+ *
1074
+ * @remarks
1075
+ * be added to the response.
1076
+ */
1077
+ subscriptionId?: string | null | undefined;
1078
+ /**
1079
+ * **Only relevant for recurring payments.**
1080
+ *
1081
+ * @remarks
1082
+ *
1083
+ * When creating recurring payments, the ID of a specific [mandate](get-mandate) can be supplied to indicate which of
1084
+ * the customer's accounts should be credited.
1085
+ */
1086
+ mandateId?: string | null | undefined;
1087
+ customerId?: string | undefined;
1088
+ /**
1089
+ * The identifier referring to the [profile](get-profile) this entity belongs to.
1090
+ *
1091
+ * @remarks
1092
+ *
1093
+ * Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted in the creation
1094
+ * request. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is
1095
+ * required.
1096
+ */
1097
+ profileId: string;
1098
+ /**
1099
+ * The identifier referring to the [settlement](get-settlement) this payment was settled with.
1100
+ */
1101
+ settlementId?: string | null | undefined;
1102
+ /**
1103
+ * If the payment was created for an [order](get-order), the ID of that order will be part of the response.
1104
+ */
1105
+ orderId?: string | null | undefined;
1106
+ /**
1107
+ * The payment's status. Settlement payments always have a status of `paid`.
1108
+ */
1109
+ status: SettlementPaymentStatus;
1110
+ /**
1111
+ * This object offers details about the status of a payment. Currently it is only available for point-of-sale
1112
+ *
1113
+ * @remarks
1114
+ * payments.
1115
+ *
1116
+ * You can find more information about the possible values of this object on
1117
+ * [this page](status-reasons).**
1118
+ */
1119
+ statusReason?: StatusReason | null | undefined;
1120
+ /**
1121
+ * Whether the payment can be canceled. This parameter is omitted if the payment reaches a final state.
1122
+ */
1123
+ isCancelable?: boolean | null | undefined;
1124
+ /**
1125
+ * An object containing payment details collected during the payment process. For example, details may include the
1126
+ *
1127
+ * @remarks
1128
+ * customer's card or bank details and a payment reference. For the full list of details, please refer to the
1129
+ * [method-specific parameters](extra-payment-parameters) guide.
1130
+ */
1131
+ details?: ListSettlementPaymentResponseDetails | null | undefined;
1132
+ /**
1133
+ * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
1134
+ */
1135
+ createdAt: string;
1136
+ /**
1137
+ * The date and time the payment became authorized, in ISO 8601 format. This parameter is omitted if the payment is
1138
+ *
1139
+ * @remarks
1140
+ * not authorized (yet).
1141
+ */
1142
+ authorizedAt?: string | null | undefined;
1143
+ /**
1144
+ * The date and time the payment became paid, in ISO 8601 format. This parameter is omitted if the payment is not
1145
+ *
1146
+ * @remarks
1147
+ * completed (yet).
1148
+ */
1149
+ paidAt?: string | null | undefined;
1150
+ /**
1151
+ * The date and time the payment was canceled, in ISO 8601 format. This parameter is omitted if the payment is not
1152
+ *
1153
+ * @remarks
1154
+ * canceled (yet).
1155
+ */
1156
+ canceledAt?: string | null | undefined;
1157
+ /**
1158
+ * The date and time the payment will expire, in ISO 8601 format. This parameter is omitted if the payment can no
1159
+ *
1160
+ * @remarks
1161
+ * longer expire.
1162
+ */
1163
+ expiresAt?: string | null | undefined;
1164
+ /**
1165
+ * The date and time the payment was expired, in ISO 8601 format. This parameter is omitted if the payment did not
1166
+ *
1167
+ * @remarks
1168
+ * expire (yet).
1169
+ */
1170
+ expiredAt?: string | null | undefined;
1171
+ /**
1172
+ * The date and time the payment failed, in ISO 8601 format. This parameter is omitted if the payment did not fail
1173
+ *
1174
+ * @remarks
1175
+ * (yet).
1176
+ */
1177
+ failedAt?: string | null | undefined;
1178
+ /**
1179
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
1180
+ */
1181
+ links: ListSettlementPaymentResponseLinks;
1182
+ };
1183
+
1184
+ /** @internal */
1185
+ export const ListSettlementPaymentResponseAmountRefunded$inboundSchema:
1186
+ z.ZodType<
1187
+ ListSettlementPaymentResponseAmountRefunded,
1188
+ z.ZodTypeDef,
1189
+ unknown
1190
+ > = z.object({
1191
+ currency: z.string(),
1192
+ value: z.string(),
1193
+ });
1194
+ /** @internal */
1195
+ export type ListSettlementPaymentResponseAmountRefunded$Outbound = {
1196
+ currency: string;
1197
+ value: string;
1198
+ };
1199
+
1200
+ /** @internal */
1201
+ export const ListSettlementPaymentResponseAmountRefunded$outboundSchema:
1202
+ z.ZodType<
1203
+ ListSettlementPaymentResponseAmountRefunded$Outbound,
1204
+ z.ZodTypeDef,
1205
+ ListSettlementPaymentResponseAmountRefunded
1206
+ > = z.object({
1207
+ currency: z.string(),
1208
+ value: z.string(),
1209
+ });
1210
+
1211
+ export function listSettlementPaymentResponseAmountRefundedToJSON(
1212
+ listSettlementPaymentResponseAmountRefunded:
1213
+ ListSettlementPaymentResponseAmountRefunded,
1214
+ ): string {
1215
+ return JSON.stringify(
1216
+ ListSettlementPaymentResponseAmountRefunded$outboundSchema.parse(
1217
+ listSettlementPaymentResponseAmountRefunded,
1218
+ ),
1219
+ );
1220
+ }
1221
+ export function listSettlementPaymentResponseAmountRefundedFromJSON(
1222
+ jsonString: string,
1223
+ ): SafeParseResult<
1224
+ ListSettlementPaymentResponseAmountRefunded,
1225
+ SDKValidationError
1226
+ > {
1227
+ return safeParse(
1228
+ jsonString,
1229
+ (x) =>
1230
+ ListSettlementPaymentResponseAmountRefunded$inboundSchema.parse(
1231
+ JSON.parse(x),
1232
+ ),
1233
+ `Failed to parse 'ListSettlementPaymentResponseAmountRefunded' from JSON`,
1234
+ );
1235
+ }
1236
+
1237
+ /** @internal */
1238
+ export const ListSettlementPaymentResponseAmountRemaining$inboundSchema:
1239
+ z.ZodType<
1240
+ ListSettlementPaymentResponseAmountRemaining,
1241
+ z.ZodTypeDef,
1242
+ unknown
1243
+ > = z.object({
1244
+ currency: z.string(),
1245
+ value: z.string(),
1246
+ });
1247
+ /** @internal */
1248
+ export type ListSettlementPaymentResponseAmountRemaining$Outbound = {
1249
+ currency: string;
1250
+ value: string;
1251
+ };
1252
+
1253
+ /** @internal */
1254
+ export const ListSettlementPaymentResponseAmountRemaining$outboundSchema:
1255
+ z.ZodType<
1256
+ ListSettlementPaymentResponseAmountRemaining$Outbound,
1257
+ z.ZodTypeDef,
1258
+ ListSettlementPaymentResponseAmountRemaining
1259
+ > = z.object({
1260
+ currency: z.string(),
1261
+ value: z.string(),
1262
+ });
1263
+
1264
+ export function listSettlementPaymentResponseAmountRemainingToJSON(
1265
+ listSettlementPaymentResponseAmountRemaining:
1266
+ ListSettlementPaymentResponseAmountRemaining,
1267
+ ): string {
1268
+ return JSON.stringify(
1269
+ ListSettlementPaymentResponseAmountRemaining$outboundSchema.parse(
1270
+ listSettlementPaymentResponseAmountRemaining,
1271
+ ),
1272
+ );
1273
+ }
1274
+ export function listSettlementPaymentResponseAmountRemainingFromJSON(
1275
+ jsonString: string,
1276
+ ): SafeParseResult<
1277
+ ListSettlementPaymentResponseAmountRemaining,
1278
+ SDKValidationError
1279
+ > {
1280
+ return safeParse(
1281
+ jsonString,
1282
+ (x) =>
1283
+ ListSettlementPaymentResponseAmountRemaining$inboundSchema.parse(
1284
+ JSON.parse(x),
1285
+ ),
1286
+ `Failed to parse 'ListSettlementPaymentResponseAmountRemaining' from JSON`,
1287
+ );
1288
+ }
1289
+
1290
+ /** @internal */
1291
+ export const ListSettlementPaymentResponseAmountCaptured$inboundSchema:
1292
+ z.ZodType<
1293
+ ListSettlementPaymentResponseAmountCaptured,
1294
+ z.ZodTypeDef,
1295
+ unknown
1296
+ > = z.object({
1297
+ currency: z.string(),
1298
+ value: z.string(),
1299
+ });
1300
+ /** @internal */
1301
+ export type ListSettlementPaymentResponseAmountCaptured$Outbound = {
1302
+ currency: string;
1303
+ value: string;
1304
+ };
1305
+
1306
+ /** @internal */
1307
+ export const ListSettlementPaymentResponseAmountCaptured$outboundSchema:
1308
+ z.ZodType<
1309
+ ListSettlementPaymentResponseAmountCaptured$Outbound,
1310
+ z.ZodTypeDef,
1311
+ ListSettlementPaymentResponseAmountCaptured
1312
+ > = z.object({
1313
+ currency: z.string(),
1314
+ value: z.string(),
1315
+ });
1316
+
1317
+ export function listSettlementPaymentResponseAmountCapturedToJSON(
1318
+ listSettlementPaymentResponseAmountCaptured:
1319
+ ListSettlementPaymentResponseAmountCaptured,
1320
+ ): string {
1321
+ return JSON.stringify(
1322
+ ListSettlementPaymentResponseAmountCaptured$outboundSchema.parse(
1323
+ listSettlementPaymentResponseAmountCaptured,
1324
+ ),
1325
+ );
1326
+ }
1327
+ export function listSettlementPaymentResponseAmountCapturedFromJSON(
1328
+ jsonString: string,
1329
+ ): SafeParseResult<
1330
+ ListSettlementPaymentResponseAmountCaptured,
1331
+ SDKValidationError
1332
+ > {
1333
+ return safeParse(
1334
+ jsonString,
1335
+ (x) =>
1336
+ ListSettlementPaymentResponseAmountCaptured$inboundSchema.parse(
1337
+ JSON.parse(x),
1338
+ ),
1339
+ `Failed to parse 'ListSettlementPaymentResponseAmountCaptured' from JSON`,
1340
+ );
1341
+ }
1342
+
1343
+ /** @internal */
1344
+ export const ListSettlementPaymentResponseAmountChargedBack$inboundSchema:
1345
+ z.ZodType<
1346
+ ListSettlementPaymentResponseAmountChargedBack,
1347
+ z.ZodTypeDef,
1348
+ unknown
1349
+ > = z.object({
1350
+ currency: z.string(),
1351
+ value: z.string(),
1352
+ });
1353
+ /** @internal */
1354
+ export type ListSettlementPaymentResponseAmountChargedBack$Outbound = {
1355
+ currency: string;
1356
+ value: string;
1357
+ };
1358
+
1359
+ /** @internal */
1360
+ export const ListSettlementPaymentResponseAmountChargedBack$outboundSchema:
1361
+ z.ZodType<
1362
+ ListSettlementPaymentResponseAmountChargedBack$Outbound,
1363
+ z.ZodTypeDef,
1364
+ ListSettlementPaymentResponseAmountChargedBack
1365
+ > = z.object({
1366
+ currency: z.string(),
1367
+ value: z.string(),
1368
+ });
1369
+
1370
+ export function listSettlementPaymentResponseAmountChargedBackToJSON(
1371
+ listSettlementPaymentResponseAmountChargedBack:
1372
+ ListSettlementPaymentResponseAmountChargedBack,
1373
+ ): string {
1374
+ return JSON.stringify(
1375
+ ListSettlementPaymentResponseAmountChargedBack$outboundSchema.parse(
1376
+ listSettlementPaymentResponseAmountChargedBack,
1377
+ ),
1378
+ );
1379
+ }
1380
+ export function listSettlementPaymentResponseAmountChargedBackFromJSON(
1381
+ jsonString: string,
1382
+ ): SafeParseResult<
1383
+ ListSettlementPaymentResponseAmountChargedBack,
1384
+ SDKValidationError
1385
+ > {
1386
+ return safeParse(
1387
+ jsonString,
1388
+ (x) =>
1389
+ ListSettlementPaymentResponseAmountChargedBack$inboundSchema.parse(
1390
+ JSON.parse(x),
1391
+ ),
1392
+ `Failed to parse 'ListSettlementPaymentResponseAmountChargedBack' from JSON`,
1393
+ );
1394
+ }
1395
+
1396
+ /** @internal */
1397
+ export const ListSettlementPaymentResponseSettlementAmount$inboundSchema:
1398
+ z.ZodType<
1399
+ ListSettlementPaymentResponseSettlementAmount,
1400
+ z.ZodTypeDef,
1401
+ unknown
1402
+ > = z.object({
1403
+ currency: z.string(),
1404
+ value: z.string(),
1405
+ });
1406
+ /** @internal */
1407
+ export type ListSettlementPaymentResponseSettlementAmount$Outbound = {
1408
+ currency: string;
1409
+ value: string;
1410
+ };
1411
+
1412
+ /** @internal */
1413
+ export const ListSettlementPaymentResponseSettlementAmount$outboundSchema:
1414
+ z.ZodType<
1415
+ ListSettlementPaymentResponseSettlementAmount$Outbound,
1416
+ z.ZodTypeDef,
1417
+ ListSettlementPaymentResponseSettlementAmount
1418
+ > = z.object({
1419
+ currency: z.string(),
1420
+ value: z.string(),
1421
+ });
1422
+
1423
+ export function listSettlementPaymentResponseSettlementAmountToJSON(
1424
+ listSettlementPaymentResponseSettlementAmount:
1425
+ ListSettlementPaymentResponseSettlementAmount,
1426
+ ): string {
1427
+ return JSON.stringify(
1428
+ ListSettlementPaymentResponseSettlementAmount$outboundSchema.parse(
1429
+ listSettlementPaymentResponseSettlementAmount,
1430
+ ),
1431
+ );
1432
+ }
1433
+ export function listSettlementPaymentResponseSettlementAmountFromJSON(
1434
+ jsonString: string,
1435
+ ): SafeParseResult<
1436
+ ListSettlementPaymentResponseSettlementAmount,
1437
+ SDKValidationError
1438
+ > {
1439
+ return safeParse(
1440
+ jsonString,
1441
+ (x) =>
1442
+ ListSettlementPaymentResponseSettlementAmount$inboundSchema.parse(
1443
+ JSON.parse(x),
1444
+ ),
1445
+ `Failed to parse 'ListSettlementPaymentResponseSettlementAmount' from JSON`,
1446
+ );
1447
+ }
1448
+
1449
+ /** @internal */
1450
+ export const ListSettlementPaymentResponseLine$inboundSchema: z.ZodType<
1451
+ ListSettlementPaymentResponseLine,
1452
+ z.ZodTypeDef,
1453
+ unknown
1454
+ > = z.object({
1455
+ type: PaymentLineTypeResponse$inboundSchema.optional(),
1456
+ description: z.string(),
1457
+ quantity: z.number().int(),
1458
+ quantityUnit: z.string().optional(),
1459
+ unitPrice: Amount$inboundSchema,
1460
+ discountAmount: Amount$inboundSchema.optional(),
1461
+ totalAmount: Amount$inboundSchema,
1462
+ vatRate: z.string().optional(),
1463
+ vatAmount: Amount$inboundSchema.optional(),
1464
+ sku: z.string().optional(),
1465
+ categories: z.array(LineCategoriesResponse$inboundSchema).optional(),
1466
+ imageUrl: z.string().optional(),
1467
+ productUrl: z.string().optional(),
1468
+ recurring: RecurringLineItem$inboundSchema.optional(),
1469
+ });
1470
+ /** @internal */
1471
+ export type ListSettlementPaymentResponseLine$Outbound = {
1472
+ type?: string | undefined;
1473
+ description: string;
1474
+ quantity: number;
1475
+ quantityUnit?: string | undefined;
1476
+ unitPrice: Amount$Outbound;
1477
+ discountAmount?: Amount$Outbound | undefined;
1478
+ totalAmount: Amount$Outbound;
1479
+ vatRate?: string | undefined;
1480
+ vatAmount?: Amount$Outbound | undefined;
1481
+ sku?: string | undefined;
1482
+ categories?: Array<string> | undefined;
1483
+ imageUrl?: string | undefined;
1484
+ productUrl?: string | undefined;
1485
+ recurring?: RecurringLineItem$Outbound | undefined;
1486
+ };
1487
+
1488
+ /** @internal */
1489
+ export const ListSettlementPaymentResponseLine$outboundSchema: z.ZodType<
1490
+ ListSettlementPaymentResponseLine$Outbound,
1491
+ z.ZodTypeDef,
1492
+ ListSettlementPaymentResponseLine
1493
+ > = z.object({
1494
+ type: PaymentLineTypeResponse$outboundSchema.optional(),
1495
+ description: z.string(),
1496
+ quantity: z.number().int(),
1497
+ quantityUnit: z.string().optional(),
1498
+ unitPrice: Amount$outboundSchema,
1499
+ discountAmount: Amount$outboundSchema.optional(),
1500
+ totalAmount: Amount$outboundSchema,
1501
+ vatRate: z.string().optional(),
1502
+ vatAmount: Amount$outboundSchema.optional(),
1503
+ sku: z.string().optional(),
1504
+ categories: z.array(LineCategoriesResponse$outboundSchema).optional(),
1505
+ imageUrl: z.string().optional(),
1506
+ productUrl: z.string().optional(),
1507
+ recurring: RecurringLineItem$outboundSchema.optional(),
1508
+ });
1509
+
1510
+ export function listSettlementPaymentResponseLineToJSON(
1511
+ listSettlementPaymentResponseLine: ListSettlementPaymentResponseLine,
1512
+ ): string {
1513
+ return JSON.stringify(
1514
+ ListSettlementPaymentResponseLine$outboundSchema.parse(
1515
+ listSettlementPaymentResponseLine,
1516
+ ),
1517
+ );
1518
+ }
1519
+ export function listSettlementPaymentResponseLineFromJSON(
1520
+ jsonString: string,
1521
+ ): SafeParseResult<ListSettlementPaymentResponseLine, SDKValidationError> {
1522
+ return safeParse(
1523
+ jsonString,
1524
+ (x) => ListSettlementPaymentResponseLine$inboundSchema.parse(JSON.parse(x)),
1525
+ `Failed to parse 'ListSettlementPaymentResponseLine' from JSON`,
1526
+ );
1527
+ }
1528
+
1529
+ /** @internal */
1530
+ export const ListSettlementPaymentResponseBillingAddress$inboundSchema:
1531
+ z.ZodType<
1532
+ ListSettlementPaymentResponseBillingAddress,
1533
+ z.ZodTypeDef,
1534
+ unknown
1535
+ > = z.object({
1536
+ title: z.string().optional(),
1537
+ givenName: z.string().optional(),
1538
+ familyName: z.string().optional(),
1539
+ organizationName: z.any().optional(),
1540
+ streetAndNumber: z.string().optional(),
1541
+ streetAdditional: z.string().optional(),
1542
+ postalCode: z.string().optional(),
1543
+ email: z.string().optional(),
1544
+ phone: z.string().optional(),
1545
+ city: z.string().optional(),
1546
+ region: z.string().optional(),
1547
+ country: z.string().optional(),
1548
+ });
1549
+ /** @internal */
1550
+ export type ListSettlementPaymentResponseBillingAddress$Outbound = {
1551
+ title?: string | undefined;
1552
+ givenName?: string | undefined;
1553
+ familyName?: string | undefined;
1554
+ organizationName?: any | undefined;
1555
+ streetAndNumber?: string | undefined;
1556
+ streetAdditional?: string | undefined;
1557
+ postalCode?: string | undefined;
1558
+ email?: string | undefined;
1559
+ phone?: string | undefined;
1560
+ city?: string | undefined;
1561
+ region?: string | undefined;
1562
+ country?: string | undefined;
1563
+ };
1564
+
1565
+ /** @internal */
1566
+ export const ListSettlementPaymentResponseBillingAddress$outboundSchema:
1567
+ z.ZodType<
1568
+ ListSettlementPaymentResponseBillingAddress$Outbound,
1569
+ z.ZodTypeDef,
1570
+ ListSettlementPaymentResponseBillingAddress
1571
+ > = z.object({
1572
+ title: z.string().optional(),
1573
+ givenName: z.string().optional(),
1574
+ familyName: z.string().optional(),
1575
+ organizationName: z.any().optional(),
1576
+ streetAndNumber: z.string().optional(),
1577
+ streetAdditional: z.string().optional(),
1578
+ postalCode: z.string().optional(),
1579
+ email: z.string().optional(),
1580
+ phone: z.string().optional(),
1581
+ city: z.string().optional(),
1582
+ region: z.string().optional(),
1583
+ country: z.string().optional(),
1584
+ });
1585
+
1586
+ export function listSettlementPaymentResponseBillingAddressToJSON(
1587
+ listSettlementPaymentResponseBillingAddress:
1588
+ ListSettlementPaymentResponseBillingAddress,
1589
+ ): string {
1590
+ return JSON.stringify(
1591
+ ListSettlementPaymentResponseBillingAddress$outboundSchema.parse(
1592
+ listSettlementPaymentResponseBillingAddress,
1593
+ ),
1594
+ );
1595
+ }
1596
+ export function listSettlementPaymentResponseBillingAddressFromJSON(
1597
+ jsonString: string,
1598
+ ): SafeParseResult<
1599
+ ListSettlementPaymentResponseBillingAddress,
1600
+ SDKValidationError
1601
+ > {
1602
+ return safeParse(
1603
+ jsonString,
1604
+ (x) =>
1605
+ ListSettlementPaymentResponseBillingAddress$inboundSchema.parse(
1606
+ JSON.parse(x),
1607
+ ),
1608
+ `Failed to parse 'ListSettlementPaymentResponseBillingAddress' from JSON`,
1609
+ );
1610
+ }
1611
+
1612
+ /** @internal */
1613
+ export const ListSettlementPaymentResponseApplicationFee$inboundSchema:
1614
+ z.ZodType<
1615
+ ListSettlementPaymentResponseApplicationFee,
1616
+ z.ZodTypeDef,
1617
+ unknown
1618
+ > = z.object({
1619
+ amount: Amount$inboundSchema.optional(),
1620
+ description: z.string().optional(),
1621
+ });
1622
+ /** @internal */
1623
+ export type ListSettlementPaymentResponseApplicationFee$Outbound = {
1624
+ amount?: Amount$Outbound | undefined;
1625
+ description?: string | undefined;
1626
+ };
1627
+
1628
+ /** @internal */
1629
+ export const ListSettlementPaymentResponseApplicationFee$outboundSchema:
1630
+ z.ZodType<
1631
+ ListSettlementPaymentResponseApplicationFee$Outbound,
1632
+ z.ZodTypeDef,
1633
+ ListSettlementPaymentResponseApplicationFee
1634
+ > = z.object({
1635
+ amount: Amount$outboundSchema.optional(),
1636
+ description: z.string().optional(),
1637
+ });
1638
+
1639
+ export function listSettlementPaymentResponseApplicationFeeToJSON(
1640
+ listSettlementPaymentResponseApplicationFee:
1641
+ ListSettlementPaymentResponseApplicationFee,
1642
+ ): string {
1643
+ return JSON.stringify(
1644
+ ListSettlementPaymentResponseApplicationFee$outboundSchema.parse(
1645
+ listSettlementPaymentResponseApplicationFee,
1646
+ ),
1647
+ );
1648
+ }
1649
+ export function listSettlementPaymentResponseApplicationFeeFromJSON(
1650
+ jsonString: string,
1651
+ ): SafeParseResult<
1652
+ ListSettlementPaymentResponseApplicationFee,
1653
+ SDKValidationError
1654
+ > {
1655
+ return safeParse(
1656
+ jsonString,
1657
+ (x) =>
1658
+ ListSettlementPaymentResponseApplicationFee$inboundSchema.parse(
1659
+ JSON.parse(x),
1660
+ ),
1661
+ `Failed to parse 'ListSettlementPaymentResponseApplicationFee' from JSON`,
1662
+ );
1663
+ }
1664
+
1665
+ /** @internal */
1666
+ export const ListSettlementPaymentResponseReceipt$inboundSchema: z.ZodType<
1667
+ ListSettlementPaymentResponseReceipt,
1668
+ z.ZodTypeDef,
1669
+ unknown
1670
+ > = z.object({
1671
+ authorizationCode: z.nullable(z.string()).optional(),
1672
+ applicationIdentifier: z.nullable(z.string()).optional(),
1673
+ cardReadMethod: z.nullable(
1674
+ PaymentDetailsReceiptCardReadMethodResponse$inboundSchema,
1675
+ ).optional(),
1676
+ cardVerificationMethod: z.nullable(
1677
+ PaymentDetailsReceiptCardVerificationMethodResponse$inboundSchema,
1678
+ ).optional(),
1679
+ });
1680
+ /** @internal */
1681
+ export type ListSettlementPaymentResponseReceipt$Outbound = {
1682
+ authorizationCode?: string | null | undefined;
1683
+ applicationIdentifier?: string | null | undefined;
1684
+ cardReadMethod?: string | null | undefined;
1685
+ cardVerificationMethod?: string | null | undefined;
1686
+ };
1687
+
1688
+ /** @internal */
1689
+ export const ListSettlementPaymentResponseReceipt$outboundSchema: z.ZodType<
1690
+ ListSettlementPaymentResponseReceipt$Outbound,
1691
+ z.ZodTypeDef,
1692
+ ListSettlementPaymentResponseReceipt
1693
+ > = z.object({
1694
+ authorizationCode: z.nullable(z.string()).optional(),
1695
+ applicationIdentifier: z.nullable(z.string()).optional(),
1696
+ cardReadMethod: z.nullable(
1697
+ PaymentDetailsReceiptCardReadMethodResponse$outboundSchema,
1698
+ ).optional(),
1699
+ cardVerificationMethod: z.nullable(
1700
+ PaymentDetailsReceiptCardVerificationMethodResponse$outboundSchema,
1701
+ ).optional(),
1702
+ });
1703
+
1704
+ export function listSettlementPaymentResponseReceiptToJSON(
1705
+ listSettlementPaymentResponseReceipt: ListSettlementPaymentResponseReceipt,
1706
+ ): string {
1707
+ return JSON.stringify(
1708
+ ListSettlementPaymentResponseReceipt$outboundSchema.parse(
1709
+ listSettlementPaymentResponseReceipt,
1710
+ ),
1711
+ );
1712
+ }
1713
+ export function listSettlementPaymentResponseReceiptFromJSON(
1714
+ jsonString: string,
1715
+ ): SafeParseResult<ListSettlementPaymentResponseReceipt, SDKValidationError> {
1716
+ return safeParse(
1717
+ jsonString,
1718
+ (x) =>
1719
+ ListSettlementPaymentResponseReceipt$inboundSchema.parse(JSON.parse(x)),
1720
+ `Failed to parse 'ListSettlementPaymentResponseReceipt' from JSON`,
1721
+ );
1722
+ }
1723
+
1724
+ /** @internal */
1725
+ export const ListSettlementPaymentResponseQrCode$inboundSchema: z.ZodType<
1726
+ ListSettlementPaymentResponseQrCode,
1727
+ z.ZodTypeDef,
1728
+ unknown
1729
+ > = z.object({
1730
+ height: z.number().int().optional(),
1731
+ width: z.number().int().optional(),
1732
+ src: z.string().optional(),
1733
+ });
1734
+ /** @internal */
1735
+ export type ListSettlementPaymentResponseQrCode$Outbound = {
1736
+ height?: number | undefined;
1737
+ width?: number | undefined;
1738
+ src?: string | undefined;
1739
+ };
1740
+
1741
+ /** @internal */
1742
+ export const ListSettlementPaymentResponseQrCode$outboundSchema: z.ZodType<
1743
+ ListSettlementPaymentResponseQrCode$Outbound,
1744
+ z.ZodTypeDef,
1745
+ ListSettlementPaymentResponseQrCode
1746
+ > = z.object({
1747
+ height: z.number().int().optional(),
1748
+ width: z.number().int().optional(),
1749
+ src: z.string().optional(),
1750
+ });
1751
+
1752
+ export function listSettlementPaymentResponseQrCodeToJSON(
1753
+ listSettlementPaymentResponseQrCode: ListSettlementPaymentResponseQrCode,
1754
+ ): string {
1755
+ return JSON.stringify(
1756
+ ListSettlementPaymentResponseQrCode$outboundSchema.parse(
1757
+ listSettlementPaymentResponseQrCode,
1758
+ ),
1759
+ );
1760
+ }
1761
+ export function listSettlementPaymentResponseQrCodeFromJSON(
1762
+ jsonString: string,
1763
+ ): SafeParseResult<ListSettlementPaymentResponseQrCode, SDKValidationError> {
1764
+ return safeParse(
1765
+ jsonString,
1766
+ (x) =>
1767
+ ListSettlementPaymentResponseQrCode$inboundSchema.parse(JSON.parse(x)),
1768
+ `Failed to parse 'ListSettlementPaymentResponseQrCode' from JSON`,
1769
+ );
1770
+ }
1771
+
1772
+ /** @internal */
1773
+ export const ListSettlementPaymentResponseDetails$inboundSchema: z.ZodType<
1774
+ ListSettlementPaymentResponseDetails,
1775
+ z.ZodTypeDef,
1776
+ unknown
1777
+ > = z.object({
1778
+ consumerName: z.nullable(z.string()).optional(),
1779
+ consumerAccount: z.nullable(z.string()).optional(),
1780
+ consumerBic: z.nullable(z.string()).optional(),
1781
+ shippingAddress: z.nullable(z.record(z.any())).optional(),
1782
+ cardNumber: z.nullable(z.string()).optional(),
1783
+ bankName: z.string().optional(),
1784
+ bankAccount: z.string().optional(),
1785
+ bankBic: z.string().optional(),
1786
+ transferReference: z.nullable(z.string()).optional(),
1787
+ cardFingerprint: z.nullable(z.string()).optional(),
1788
+ cardHolder: z.nullable(z.string()).optional(),
1789
+ cardAudition: z.nullable(PaymentDetailsCardAuditionResponse$inboundSchema)
1790
+ .optional(),
1791
+ cardLabel: z.nullable(PaymentDetailsCardLabelResponse$inboundSchema)
1792
+ .optional(),
1793
+ cardCountryCode: z.nullable(z.string()).optional(),
1794
+ cardExpiryDate: z.nullable(z.string()).optional(),
1795
+ cardFunding: z.nullable(PaymentDetailsCardFundingResponse$inboundSchema)
1796
+ .optional(),
1797
+ cardSecurity: z.nullable(PaymentDetailsCardSecurityResponse$inboundSchema)
1798
+ .optional(),
1799
+ feeRegion: z.nullable(PaymentDetailsFeeRegionResponse$inboundSchema)
1800
+ .optional(),
1801
+ cardMaskedNumber: z.nullable(z.string()).optional(),
1802
+ card3dsEci: z.nullable(z.string()).optional(),
1803
+ cardBin: z.nullable(z.string()).optional(),
1804
+ cardIssuer: z.nullable(z.string()).optional(),
1805
+ failureReason: z.nullable(PaymentDetailsFailureReasonResponse$inboundSchema)
1806
+ .optional(),
1807
+ failureMessage: z.nullable(z.string()).optional(),
1808
+ wallet: z.nullable(PaymentDetailsWalletResponse$inboundSchema).optional(),
1809
+ paypalReference: z.nullable(z.string()).optional(),
1810
+ paypalPayerId: z.nullable(z.string()).optional(),
1811
+ sellerProtection: z.nullable(
1812
+ PaymentDetailsSellerProtectionResponse$inboundSchema,
1813
+ ).optional(),
1814
+ paypalFee: z.nullable(AmountNullable$inboundSchema).optional(),
1815
+ customerReference: z.string().optional(),
1816
+ terminalId: z.string().optional(),
1817
+ maskedNumber: z.nullable(z.string()).optional(),
1818
+ receipt: z.lazy(() => ListSettlementPaymentResponseReceipt$inboundSchema)
1819
+ .optional(),
1820
+ creditorIdentifier: z.nullable(z.string()).optional(),
1821
+ dueDate: z.nullable(z.string().transform(v => new RFCDate(v))).optional(),
1822
+ signatureDate: z.nullable(z.string().transform(v => new RFCDate(v)))
1823
+ .optional(),
1824
+ bankReasonCode: z.nullable(z.string()).optional(),
1825
+ bankReason: z.nullable(z.string()).optional(),
1826
+ endToEndIdentifier: z.nullable(z.string()).optional(),
1827
+ mandateReference: z.nullable(z.string()).optional(),
1828
+ batchReference: z.nullable(z.string()).optional(),
1829
+ fileReference: z.nullable(z.string()).optional(),
1830
+ qrCode: z.lazy(() => ListSettlementPaymentResponseQrCode$inboundSchema)
1831
+ .optional(),
1832
+ voucherNumber: z.string().optional(),
1833
+ giftcards: z.array(z.record(z.any())).optional(),
1834
+ issuer: z.string().optional(),
1835
+ vouchers: z.array(z.record(z.any())).optional(),
1836
+ remainderAmount: Amount$inboundSchema.optional(),
1837
+ remainderMethod: z.string().optional(),
1838
+ remainderDetails: z.record(z.any()).optional(),
1839
+ multibancoReference: z.nullable(z.string()).optional(),
1840
+ multibancoEntity: z.nullable(z.string()).optional(),
1841
+ });
1842
+ /** @internal */
1843
+ export type ListSettlementPaymentResponseDetails$Outbound = {
1844
+ consumerName?: string | null | undefined;
1845
+ consumerAccount?: string | null | undefined;
1846
+ consumerBic?: string | null | undefined;
1847
+ shippingAddress?: { [k: string]: any } | null | undefined;
1848
+ cardNumber?: string | null | undefined;
1849
+ bankName?: string | undefined;
1850
+ bankAccount?: string | undefined;
1851
+ bankBic?: string | undefined;
1852
+ transferReference?: string | null | undefined;
1853
+ cardFingerprint?: string | null | undefined;
1854
+ cardHolder?: string | null | undefined;
1855
+ cardAudition?: string | null | undefined;
1856
+ cardLabel?: string | null | undefined;
1857
+ cardCountryCode?: string | null | undefined;
1858
+ cardExpiryDate?: string | null | undefined;
1859
+ cardFunding?: string | null | undefined;
1860
+ cardSecurity?: string | null | undefined;
1861
+ feeRegion?: string | null | undefined;
1862
+ cardMaskedNumber?: string | null | undefined;
1863
+ card3dsEci?: string | null | undefined;
1864
+ cardBin?: string | null | undefined;
1865
+ cardIssuer?: string | null | undefined;
1866
+ failureReason?: string | null | undefined;
1867
+ failureMessage?: string | null | undefined;
1868
+ wallet?: string | null | undefined;
1869
+ paypalReference?: string | null | undefined;
1870
+ paypalPayerId?: string | null | undefined;
1871
+ sellerProtection?: string | null | undefined;
1872
+ paypalFee?: AmountNullable$Outbound | null | undefined;
1873
+ customerReference?: string | undefined;
1874
+ terminalId?: string | undefined;
1875
+ maskedNumber?: string | null | undefined;
1876
+ receipt?: ListSettlementPaymentResponseReceipt$Outbound | undefined;
1877
+ creditorIdentifier?: string | null | undefined;
1878
+ dueDate?: string | null | undefined;
1879
+ signatureDate?: string | null | undefined;
1880
+ bankReasonCode?: string | null | undefined;
1881
+ bankReason?: string | null | undefined;
1882
+ endToEndIdentifier?: string | null | undefined;
1883
+ mandateReference?: string | null | undefined;
1884
+ batchReference?: string | null | undefined;
1885
+ fileReference?: string | null | undefined;
1886
+ qrCode?: ListSettlementPaymentResponseQrCode$Outbound | undefined;
1887
+ voucherNumber?: string | undefined;
1888
+ giftcards?: Array<{ [k: string]: any }> | undefined;
1889
+ issuer?: string | undefined;
1890
+ vouchers?: Array<{ [k: string]: any }> | undefined;
1891
+ remainderAmount?: Amount$Outbound | undefined;
1892
+ remainderMethod?: string | undefined;
1893
+ remainderDetails?: { [k: string]: any } | undefined;
1894
+ multibancoReference?: string | null | undefined;
1895
+ multibancoEntity?: string | null | undefined;
1896
+ };
1897
+
1898
+ /** @internal */
1899
+ export const ListSettlementPaymentResponseDetails$outboundSchema: z.ZodType<
1900
+ ListSettlementPaymentResponseDetails$Outbound,
1901
+ z.ZodTypeDef,
1902
+ ListSettlementPaymentResponseDetails
1903
+ > = z.object({
1904
+ consumerName: z.nullable(z.string()).optional(),
1905
+ consumerAccount: z.nullable(z.string()).optional(),
1906
+ consumerBic: z.nullable(z.string()).optional(),
1907
+ shippingAddress: z.nullable(z.record(z.any())).optional(),
1908
+ cardNumber: z.nullable(z.string()).optional(),
1909
+ bankName: z.string().optional(),
1910
+ bankAccount: z.string().optional(),
1911
+ bankBic: z.string().optional(),
1912
+ transferReference: z.nullable(z.string()).optional(),
1913
+ cardFingerprint: z.nullable(z.string()).optional(),
1914
+ cardHolder: z.nullable(z.string()).optional(),
1915
+ cardAudition: z.nullable(PaymentDetailsCardAuditionResponse$outboundSchema)
1916
+ .optional(),
1917
+ cardLabel: z.nullable(PaymentDetailsCardLabelResponse$outboundSchema)
1918
+ .optional(),
1919
+ cardCountryCode: z.nullable(z.string()).optional(),
1920
+ cardExpiryDate: z.nullable(z.string()).optional(),
1921
+ cardFunding: z.nullable(PaymentDetailsCardFundingResponse$outboundSchema)
1922
+ .optional(),
1923
+ cardSecurity: z.nullable(PaymentDetailsCardSecurityResponse$outboundSchema)
1924
+ .optional(),
1925
+ feeRegion: z.nullable(PaymentDetailsFeeRegionResponse$outboundSchema)
1926
+ .optional(),
1927
+ cardMaskedNumber: z.nullable(z.string()).optional(),
1928
+ card3dsEci: z.nullable(z.string()).optional(),
1929
+ cardBin: z.nullable(z.string()).optional(),
1930
+ cardIssuer: z.nullable(z.string()).optional(),
1931
+ failureReason: z.nullable(PaymentDetailsFailureReasonResponse$outboundSchema)
1932
+ .optional(),
1933
+ failureMessage: z.nullable(z.string()).optional(),
1934
+ wallet: z.nullable(PaymentDetailsWalletResponse$outboundSchema).optional(),
1935
+ paypalReference: z.nullable(z.string()).optional(),
1936
+ paypalPayerId: z.nullable(z.string()).optional(),
1937
+ sellerProtection: z.nullable(
1938
+ PaymentDetailsSellerProtectionResponse$outboundSchema,
1939
+ ).optional(),
1940
+ paypalFee: z.nullable(AmountNullable$outboundSchema).optional(),
1941
+ customerReference: z.string().optional(),
1942
+ terminalId: z.string().optional(),
1943
+ maskedNumber: z.nullable(z.string()).optional(),
1944
+ receipt: z.lazy(() => ListSettlementPaymentResponseReceipt$outboundSchema)
1945
+ .optional(),
1946
+ creditorIdentifier: z.nullable(z.string()).optional(),
1947
+ dueDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString()))
1948
+ .optional(),
1949
+ signatureDate: z.nullable(z.instanceof(RFCDate).transform(v => v.toString()))
1950
+ .optional(),
1951
+ bankReasonCode: z.nullable(z.string()).optional(),
1952
+ bankReason: z.nullable(z.string()).optional(),
1953
+ endToEndIdentifier: z.nullable(z.string()).optional(),
1954
+ mandateReference: z.nullable(z.string()).optional(),
1955
+ batchReference: z.nullable(z.string()).optional(),
1956
+ fileReference: z.nullable(z.string()).optional(),
1957
+ qrCode: z.lazy(() => ListSettlementPaymentResponseQrCode$outboundSchema)
1958
+ .optional(),
1959
+ voucherNumber: z.string().optional(),
1960
+ giftcards: z.array(z.record(z.any())).optional(),
1961
+ issuer: z.string().optional(),
1962
+ vouchers: z.array(z.record(z.any())).optional(),
1963
+ remainderAmount: Amount$outboundSchema.optional(),
1964
+ remainderMethod: z.string().optional(),
1965
+ remainderDetails: z.record(z.any()).optional(),
1966
+ multibancoReference: z.nullable(z.string()).optional(),
1967
+ multibancoEntity: z.nullable(z.string()).optional(),
1968
+ });
1969
+
1970
+ export function listSettlementPaymentResponseDetailsToJSON(
1971
+ listSettlementPaymentResponseDetails: ListSettlementPaymentResponseDetails,
1972
+ ): string {
1973
+ return JSON.stringify(
1974
+ ListSettlementPaymentResponseDetails$outboundSchema.parse(
1975
+ listSettlementPaymentResponseDetails,
1976
+ ),
1977
+ );
1978
+ }
1979
+ export function listSettlementPaymentResponseDetailsFromJSON(
1980
+ jsonString: string,
1981
+ ): SafeParseResult<ListSettlementPaymentResponseDetails, SDKValidationError> {
1982
+ return safeParse(
1983
+ jsonString,
1984
+ (x) =>
1985
+ ListSettlementPaymentResponseDetails$inboundSchema.parse(JSON.parse(x)),
1986
+ `Failed to parse 'ListSettlementPaymentResponseDetails' from JSON`,
1987
+ );
1988
+ }
1989
+
1990
+ /** @internal */
1991
+ export const ListSettlementPaymentResponseLinks$inboundSchema: z.ZodType<
1992
+ ListSettlementPaymentResponseLinks,
1993
+ z.ZodTypeDef,
1994
+ unknown
1995
+ > = z.object({
1996
+ self: Url$inboundSchema,
1997
+ checkout: Url$inboundSchema.optional(),
1998
+ mobileAppCheckout: Url$inboundSchema.optional(),
1999
+ changePaymentState: z.nullable(UrlNullable$inboundSchema).optional(),
2000
+ dashboard: Url$inboundSchema,
2001
+ refunds: Url$inboundSchema.optional(),
2002
+ chargebacks: Url$inboundSchema.optional(),
2003
+ captures: Url$inboundSchema.optional(),
2004
+ settlement: Url$inboundSchema.optional(),
2005
+ customer: Url$inboundSchema.optional(),
2006
+ mandate: Url$inboundSchema.optional(),
2007
+ subscription: Url$inboundSchema.optional(),
2008
+ order: Url$inboundSchema.optional(),
2009
+ terminal: Url$inboundSchema.optional(),
2010
+ status: Url$inboundSchema.optional(),
2011
+ payOnline: Url$inboundSchema.optional(),
2012
+ });
2013
+ /** @internal */
2014
+ export type ListSettlementPaymentResponseLinks$Outbound = {
2015
+ self: Url$Outbound;
2016
+ checkout?: Url$Outbound | undefined;
2017
+ mobileAppCheckout?: Url$Outbound | undefined;
2018
+ changePaymentState?: UrlNullable$Outbound | null | undefined;
2019
+ dashboard: Url$Outbound;
2020
+ refunds?: Url$Outbound | undefined;
2021
+ chargebacks?: Url$Outbound | undefined;
2022
+ captures?: Url$Outbound | undefined;
2023
+ settlement?: Url$Outbound | undefined;
2024
+ customer?: Url$Outbound | undefined;
2025
+ mandate?: Url$Outbound | undefined;
2026
+ subscription?: Url$Outbound | undefined;
2027
+ order?: Url$Outbound | undefined;
2028
+ terminal?: Url$Outbound | undefined;
2029
+ status?: Url$Outbound | undefined;
2030
+ payOnline?: Url$Outbound | undefined;
2031
+ };
2032
+
2033
+ /** @internal */
2034
+ export const ListSettlementPaymentResponseLinks$outboundSchema: z.ZodType<
2035
+ ListSettlementPaymentResponseLinks$Outbound,
2036
+ z.ZodTypeDef,
2037
+ ListSettlementPaymentResponseLinks
2038
+ > = z.object({
2039
+ self: Url$outboundSchema,
2040
+ checkout: Url$outboundSchema.optional(),
2041
+ mobileAppCheckout: Url$outboundSchema.optional(),
2042
+ changePaymentState: z.nullable(UrlNullable$outboundSchema).optional(),
2043
+ dashboard: Url$outboundSchema,
2044
+ refunds: Url$outboundSchema.optional(),
2045
+ chargebacks: Url$outboundSchema.optional(),
2046
+ captures: Url$outboundSchema.optional(),
2047
+ settlement: Url$outboundSchema.optional(),
2048
+ customer: Url$outboundSchema.optional(),
2049
+ mandate: Url$outboundSchema.optional(),
2050
+ subscription: Url$outboundSchema.optional(),
2051
+ order: Url$outboundSchema.optional(),
2052
+ terminal: Url$outboundSchema.optional(),
2053
+ status: Url$outboundSchema.optional(),
2054
+ payOnline: Url$outboundSchema.optional(),
2055
+ });
2056
+
2057
+ export function listSettlementPaymentResponseLinksToJSON(
2058
+ listSettlementPaymentResponseLinks: ListSettlementPaymentResponseLinks,
2059
+ ): string {
2060
+ return JSON.stringify(
2061
+ ListSettlementPaymentResponseLinks$outboundSchema.parse(
2062
+ listSettlementPaymentResponseLinks,
2063
+ ),
2064
+ );
2065
+ }
2066
+ export function listSettlementPaymentResponseLinksFromJSON(
2067
+ jsonString: string,
2068
+ ): SafeParseResult<ListSettlementPaymentResponseLinks, SDKValidationError> {
2069
+ return safeParse(
2070
+ jsonString,
2071
+ (x) =>
2072
+ ListSettlementPaymentResponseLinks$inboundSchema.parse(JSON.parse(x)),
2073
+ `Failed to parse 'ListSettlementPaymentResponseLinks' from JSON`,
2074
+ );
2075
+ }
2076
+
2077
+ /** @internal */
2078
+ export const ListSettlementPaymentResponse$inboundSchema: z.ZodType<
2079
+ ListSettlementPaymentResponse,
2080
+ z.ZodTypeDef,
2081
+ unknown
2082
+ > = z.object({
2083
+ resource: z.string(),
2084
+ id: z.string(),
2085
+ mode: SettlementMode$inboundSchema,
2086
+ description: z.string(),
2087
+ amount: Amount$inboundSchema,
2088
+ amountRefunded: z.lazy(() =>
2089
+ ListSettlementPaymentResponseAmountRefunded$inboundSchema
2090
+ ).optional(),
2091
+ amountRemaining: z.lazy(() =>
2092
+ ListSettlementPaymentResponseAmountRemaining$inboundSchema
2093
+ ).optional(),
2094
+ amountCaptured: z.lazy(() =>
2095
+ ListSettlementPaymentResponseAmountCaptured$inboundSchema
2096
+ ).optional(),
2097
+ amountChargedBack: z.lazy(() =>
2098
+ ListSettlementPaymentResponseAmountChargedBack$inboundSchema
2099
+ ).optional(),
2100
+ settlementAmount: z.lazy(() =>
2101
+ ListSettlementPaymentResponseSettlementAmount$inboundSchema
2102
+ ).optional(),
2103
+ redirectUrl: z.nullable(z.string()).optional(),
2104
+ cancelUrl: z.nullable(z.string()).optional(),
2105
+ webhookUrl: z.nullable(z.string()).optional(),
2106
+ lines: z.nullable(
2107
+ z.array(z.lazy(() => ListSettlementPaymentResponseLine$inboundSchema)),
2108
+ ).optional(),
2109
+ billingAddress: z.lazy(() =>
2110
+ ListSettlementPaymentResponseBillingAddress$inboundSchema
2111
+ ).optional(),
2112
+ shippingAddress: PaymentAddress$inboundSchema.optional(),
2113
+ locale: z.nullable(LocaleResponse$inboundSchema).optional(),
2114
+ countryCode: z.nullable(z.string()).optional(),
2115
+ method: z.nullable(MethodResponse$inboundSchema).optional(),
2116
+ restrictPaymentMethodsToCountry: z.nullable(z.string()).optional(),
2117
+ metadata: z.nullable(Metadata$inboundSchema).optional(),
2118
+ captureMode: z.nullable(CaptureModeResponse$inboundSchema).optional(),
2119
+ captureDelay: z.nullable(z.string()).optional(),
2120
+ captureBefore: z.nullable(z.string()).optional(),
2121
+ applicationFee: z.nullable(
2122
+ z.lazy(() => ListSettlementPaymentResponseApplicationFee$inboundSchema),
2123
+ ).optional(),
2124
+ routing: z.nullable(z.array(EntityPaymentRouteResponse$inboundSchema))
2125
+ .optional(),
2126
+ sequenceType: SequenceTypeResponse$inboundSchema,
2127
+ subscriptionId: z.nullable(z.string()).optional(),
2128
+ mandateId: z.nullable(z.string()).optional(),
2129
+ customerId: z.string().optional(),
2130
+ profileId: z.string(),
2131
+ settlementId: z.nullable(z.string()).optional(),
2132
+ orderId: z.nullable(z.string()).optional(),
2133
+ status: SettlementPaymentStatus$inboundSchema,
2134
+ statusReason: z.nullable(StatusReason$inboundSchema).optional(),
2135
+ isCancelable: z.nullable(z.boolean()).optional(),
2136
+ details: z.nullable(
2137
+ z.lazy(() => ListSettlementPaymentResponseDetails$inboundSchema),
2138
+ ).optional(),
2139
+ createdAt: z.string(),
2140
+ authorizedAt: z.nullable(z.string()).optional(),
2141
+ paidAt: z.nullable(z.string()).optional(),
2142
+ canceledAt: z.nullable(z.string()).optional(),
2143
+ expiresAt: z.nullable(z.string()).optional(),
2144
+ expiredAt: z.nullable(z.string()).optional(),
2145
+ failedAt: z.nullable(z.string()).optional(),
2146
+ _links: z.lazy(() => ListSettlementPaymentResponseLinks$inboundSchema),
2147
+ }).transform((v) => {
2148
+ return remap$(v, {
2149
+ "_links": "links",
2150
+ });
2151
+ });
2152
+ /** @internal */
2153
+ export type ListSettlementPaymentResponse$Outbound = {
2154
+ resource: string;
2155
+ id: string;
2156
+ mode: string;
2157
+ description: string;
2158
+ amount: Amount$Outbound;
2159
+ amountRefunded?:
2160
+ | ListSettlementPaymentResponseAmountRefunded$Outbound
2161
+ | undefined;
2162
+ amountRemaining?:
2163
+ | ListSettlementPaymentResponseAmountRemaining$Outbound
2164
+ | undefined;
2165
+ amountCaptured?:
2166
+ | ListSettlementPaymentResponseAmountCaptured$Outbound
2167
+ | undefined;
2168
+ amountChargedBack?:
2169
+ | ListSettlementPaymentResponseAmountChargedBack$Outbound
2170
+ | undefined;
2171
+ settlementAmount?:
2172
+ | ListSettlementPaymentResponseSettlementAmount$Outbound
2173
+ | undefined;
2174
+ redirectUrl?: string | null | undefined;
2175
+ cancelUrl?: string | null | undefined;
2176
+ webhookUrl?: string | null | undefined;
2177
+ lines?: Array<ListSettlementPaymentResponseLine$Outbound> | null | undefined;
2178
+ billingAddress?:
2179
+ | ListSettlementPaymentResponseBillingAddress$Outbound
2180
+ | undefined;
2181
+ shippingAddress?: PaymentAddress$Outbound | undefined;
2182
+ locale?: string | null | undefined;
2183
+ countryCode?: string | null | undefined;
2184
+ method?: string | null | undefined;
2185
+ restrictPaymentMethodsToCountry?: string | null | undefined;
2186
+ metadata?: Metadata$Outbound | null | undefined;
2187
+ captureMode?: string | null | undefined;
2188
+ captureDelay?: string | null | undefined;
2189
+ captureBefore?: string | null | undefined;
2190
+ applicationFee?:
2191
+ | ListSettlementPaymentResponseApplicationFee$Outbound
2192
+ | null
2193
+ | undefined;
2194
+ routing?: Array<EntityPaymentRouteResponse$Outbound> | null | undefined;
2195
+ sequenceType: string;
2196
+ subscriptionId?: string | null | undefined;
2197
+ mandateId?: string | null | undefined;
2198
+ customerId?: string | undefined;
2199
+ profileId: string;
2200
+ settlementId?: string | null | undefined;
2201
+ orderId?: string | null | undefined;
2202
+ status: string;
2203
+ statusReason?: StatusReason$Outbound | null | undefined;
2204
+ isCancelable?: boolean | null | undefined;
2205
+ details?: ListSettlementPaymentResponseDetails$Outbound | null | undefined;
2206
+ createdAt: string;
2207
+ authorizedAt?: string | null | undefined;
2208
+ paidAt?: string | null | undefined;
2209
+ canceledAt?: string | null | undefined;
2210
+ expiresAt?: string | null | undefined;
2211
+ expiredAt?: string | null | undefined;
2212
+ failedAt?: string | null | undefined;
2213
+ _links: ListSettlementPaymentResponseLinks$Outbound;
2214
+ };
2215
+
2216
+ /** @internal */
2217
+ export const ListSettlementPaymentResponse$outboundSchema: z.ZodType<
2218
+ ListSettlementPaymentResponse$Outbound,
2219
+ z.ZodTypeDef,
2220
+ ListSettlementPaymentResponse
2221
+ > = z.object({
2222
+ resource: z.string(),
2223
+ id: z.string(),
2224
+ mode: SettlementMode$outboundSchema,
2225
+ description: z.string(),
2226
+ amount: Amount$outboundSchema,
2227
+ amountRefunded: z.lazy(() =>
2228
+ ListSettlementPaymentResponseAmountRefunded$outboundSchema
2229
+ ).optional(),
2230
+ amountRemaining: z.lazy(() =>
2231
+ ListSettlementPaymentResponseAmountRemaining$outboundSchema
2232
+ ).optional(),
2233
+ amountCaptured: z.lazy(() =>
2234
+ ListSettlementPaymentResponseAmountCaptured$outboundSchema
2235
+ ).optional(),
2236
+ amountChargedBack: z.lazy(() =>
2237
+ ListSettlementPaymentResponseAmountChargedBack$outboundSchema
2238
+ ).optional(),
2239
+ settlementAmount: z.lazy(() =>
2240
+ ListSettlementPaymentResponseSettlementAmount$outboundSchema
2241
+ ).optional(),
2242
+ redirectUrl: z.nullable(z.string()).optional(),
2243
+ cancelUrl: z.nullable(z.string()).optional(),
2244
+ webhookUrl: z.nullable(z.string()).optional(),
2245
+ lines: z.nullable(
2246
+ z.array(z.lazy(() => ListSettlementPaymentResponseLine$outboundSchema)),
2247
+ ).optional(),
2248
+ billingAddress: z.lazy(() =>
2249
+ ListSettlementPaymentResponseBillingAddress$outboundSchema
2250
+ ).optional(),
2251
+ shippingAddress: PaymentAddress$outboundSchema.optional(),
2252
+ locale: z.nullable(LocaleResponse$outboundSchema).optional(),
2253
+ countryCode: z.nullable(z.string()).optional(),
2254
+ method: z.nullable(MethodResponse$outboundSchema).optional(),
2255
+ restrictPaymentMethodsToCountry: z.nullable(z.string()).optional(),
2256
+ metadata: z.nullable(Metadata$outboundSchema).optional(),
2257
+ captureMode: z.nullable(CaptureModeResponse$outboundSchema).optional(),
2258
+ captureDelay: z.nullable(z.string()).optional(),
2259
+ captureBefore: z.nullable(z.string()).optional(),
2260
+ applicationFee: z.nullable(
2261
+ z.lazy(() => ListSettlementPaymentResponseApplicationFee$outboundSchema),
2262
+ ).optional(),
2263
+ routing: z.nullable(z.array(EntityPaymentRouteResponse$outboundSchema))
2264
+ .optional(),
2265
+ sequenceType: SequenceTypeResponse$outboundSchema,
2266
+ subscriptionId: z.nullable(z.string()).optional(),
2267
+ mandateId: z.nullable(z.string()).optional(),
2268
+ customerId: z.string().optional(),
2269
+ profileId: z.string(),
2270
+ settlementId: z.nullable(z.string()).optional(),
2271
+ orderId: z.nullable(z.string()).optional(),
2272
+ status: SettlementPaymentStatus$outboundSchema,
2273
+ statusReason: z.nullable(StatusReason$outboundSchema).optional(),
2274
+ isCancelable: z.nullable(z.boolean()).optional(),
2275
+ details: z.nullable(
2276
+ z.lazy(() => ListSettlementPaymentResponseDetails$outboundSchema),
2277
+ ).optional(),
2278
+ createdAt: z.string(),
2279
+ authorizedAt: z.nullable(z.string()).optional(),
2280
+ paidAt: z.nullable(z.string()).optional(),
2281
+ canceledAt: z.nullable(z.string()).optional(),
2282
+ expiresAt: z.nullable(z.string()).optional(),
2283
+ expiredAt: z.nullable(z.string()).optional(),
2284
+ failedAt: z.nullable(z.string()).optional(),
2285
+ links: z.lazy(() => ListSettlementPaymentResponseLinks$outboundSchema),
2286
+ }).transform((v) => {
2287
+ return remap$(v, {
2288
+ links: "_links",
2289
+ });
2290
+ });
2291
+
2292
+ export function listSettlementPaymentResponseToJSON(
2293
+ listSettlementPaymentResponse: ListSettlementPaymentResponse,
2294
+ ): string {
2295
+ return JSON.stringify(
2296
+ ListSettlementPaymentResponse$outboundSchema.parse(
2297
+ listSettlementPaymentResponse,
2298
+ ),
2299
+ );
2300
+ }
2301
+ export function listSettlementPaymentResponseFromJSON(
2302
+ jsonString: string,
2303
+ ): SafeParseResult<ListSettlementPaymentResponse, SDKValidationError> {
2304
+ return safeParse(
2305
+ jsonString,
2306
+ (x) => ListSettlementPaymentResponse$inboundSchema.parse(JSON.parse(x)),
2307
+ `Failed to parse 'ListSettlementPaymentResponse' from JSON`,
2308
+ );
2309
+ }