@getivy/node-sdk 0.1.0-alpha.9 → 1.0.0

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 (150) hide show
  1. package/CHANGELOG.md +326 -0
  2. package/README.md +16 -26
  3. package/_shims/index.d.ts +2 -0
  4. package/_shims/index.js +5 -1
  5. package/_shims/index.mjs +5 -1
  6. package/core.d.ts +19 -5
  7. package/core.d.ts.map +1 -1
  8. package/core.js +25 -15
  9. package/core.js.map +1 -1
  10. package/core.mjs +26 -16
  11. package/core.mjs.map +1 -1
  12. package/index.d.mts +30 -18
  13. package/index.d.ts +30 -18
  14. package/index.d.ts.map +1 -1
  15. package/index.js +21 -8
  16. package/index.js.map +1 -1
  17. package/index.mjs +21 -8
  18. package/index.mjs.map +1 -1
  19. package/package.json +11 -33
  20. package/resource.d.ts +1 -1
  21. package/resource.d.ts.map +1 -1
  22. package/resource.js.map +1 -1
  23. package/resource.mjs.map +1 -1
  24. package/resources/balance.d.ts +8 -5
  25. package/resources/balance.d.ts.map +1 -1
  26. package/resources/banks.d.ts +82 -67
  27. package/resources/banks.d.ts.map +1 -1
  28. package/resources/beneficiary-payouts.d.ts +61 -0
  29. package/resources/beneficiary-payouts.d.ts.map +1 -0
  30. package/resources/beneficiary-payouts.js +16 -0
  31. package/resources/beneficiary-payouts.js.map +1 -0
  32. package/resources/beneficiary-payouts.mjs +12 -0
  33. package/resources/beneficiary-payouts.mjs.map +1 -0
  34. package/resources/capabilities.d.ts +1 -10
  35. package/resources/capabilities.d.ts.map +1 -1
  36. package/resources/charges.d.ts +28 -19
  37. package/resources/charges.d.ts.map +1 -1
  38. package/resources/checkoutsession.d.ts +275 -1360
  39. package/resources/checkoutsession.d.ts.map +1 -1
  40. package/resources/customers.d.ts +140 -10
  41. package/resources/customers.d.ts.map +1 -1
  42. package/resources/customers.js +9 -2
  43. package/resources/customers.js.map +1 -1
  44. package/resources/customers.mjs +9 -2
  45. package/resources/customers.mjs.map +1 -1
  46. package/resources/deposits.d.ts +165 -0
  47. package/resources/deposits.d.ts.map +1 -0
  48. package/resources/deposits.js +15 -0
  49. package/resources/deposits.js.map +1 -0
  50. package/resources/deposits.mjs +11 -0
  51. package/resources/deposits.mjs.map +1 -0
  52. package/resources/fx.d.ts +90 -0
  53. package/resources/fx.d.ts.map +1 -0
  54. package/resources/fx.js +22 -0
  55. package/resources/fx.js.map +1 -0
  56. package/resources/fx.mjs +18 -0
  57. package/resources/fx.mjs.map +1 -0
  58. package/resources/index.d.ts +11 -8
  59. package/resources/index.d.ts.map +1 -1
  60. package/resources/index.js +11 -5
  61. package/resources/index.js.map +1 -1
  62. package/resources/index.mjs +5 -2
  63. package/resources/index.mjs.map +1 -1
  64. package/resources/mandates.d.ts +55 -17
  65. package/resources/mandates.d.ts.map +1 -1
  66. package/resources/orders.d.ts +720 -743
  67. package/resources/orders.d.ts.map +1 -1
  68. package/resources/orders.js +13 -3
  69. package/resources/orders.js.map +1 -1
  70. package/resources/orders.mjs +13 -3
  71. package/resources/orders.mjs.map +1 -1
  72. package/resources/payouts.d.ts +219 -103
  73. package/resources/payouts.d.ts.map +1 -1
  74. package/resources/payouts.js +3 -4
  75. package/resources/payouts.js.map +1 -1
  76. package/resources/payouts.mjs +3 -4
  77. package/resources/payouts.mjs.map +1 -1
  78. package/resources/refunds.d.ts +53 -97
  79. package/resources/refunds.d.ts.map +1 -1
  80. package/resources/refunds.js +8 -12
  81. package/resources/refunds.js.map +1 -1
  82. package/resources/refunds.mjs +8 -12
  83. package/resources/refunds.mjs.map +1 -1
  84. package/resources/returns.d.ts +104 -0
  85. package/resources/returns.d.ts.map +1 -0
  86. package/resources/returns.js +21 -0
  87. package/resources/returns.js.map +1 -0
  88. package/resources/returns.mjs +17 -0
  89. package/resources/returns.mjs.map +1 -0
  90. package/resources/subaccounts.d.ts +15 -5
  91. package/resources/subaccounts.d.ts.map +1 -1
  92. package/resources/subaccounts.js.map +1 -1
  93. package/resources/subaccounts.mjs.map +1 -1
  94. package/resources/transactions.d.ts +174 -0
  95. package/resources/transactions.d.ts.map +1 -0
  96. package/resources/transactions.js +15 -0
  97. package/resources/transactions.js.map +1 -0
  98. package/resources/transactions.mjs +11 -0
  99. package/resources/transactions.mjs.map +1 -0
  100. package/resources.d.ts +2 -0
  101. package/resources.d.ts.map +1 -0
  102. package/resources.js +18 -0
  103. package/resources.js.map +1 -0
  104. package/resources.mjs +2 -0
  105. package/resources.mjs.map +1 -0
  106. package/src/_shims/index.d.ts +2 -0
  107. package/src/_shims/index.js +5 -1
  108. package/src/_shims/index.mjs +5 -1
  109. package/src/core.ts +44 -16
  110. package/src/index.ts +100 -63
  111. package/src/resource.ts +1 -1
  112. package/src/resources/balance.ts +8 -5
  113. package/src/resources/banks.ts +130 -67
  114. package/src/resources/beneficiary-payouts.ts +78 -0
  115. package/src/resources/capabilities.ts +1 -10
  116. package/src/resources/charges.ts +30 -21
  117. package/src/resources/checkoutsession.ts +1224 -3096
  118. package/src/resources/customers.ts +164 -9
  119. package/src/resources/deposits.ts +231 -0
  120. package/src/resources/fx.ts +119 -0
  121. package/src/resources/index.ts +31 -28
  122. package/src/resources/mandates.ts +79 -17
  123. package/src/resources/orders.ts +1449 -1075
  124. package/src/resources/payouts.ts +273 -103
  125. package/src/resources/refunds.ts +70 -111
  126. package/src/resources/returns.ts +140 -0
  127. package/src/resources/subaccounts.ts +26 -4
  128. package/src/resources/transactions.ts +234 -0
  129. package/src/resources.ts +1 -0
  130. package/src/version.ts +1 -1
  131. package/version.d.ts +1 -1
  132. package/version.d.ts.map +1 -1
  133. package/version.js +1 -1
  134. package/version.js.map +1 -1
  135. package/version.mjs +1 -1
  136. package/version.mjs.map +1 -1
  137. package/resources/reports.d.ts +0 -120
  138. package/resources/reports.d.ts.map +0 -1
  139. package/resources/reports.js +0 -31
  140. package/resources/reports.js.map +0 -1
  141. package/resources/reports.mjs +0 -27
  142. package/resources/reports.mjs.map +0 -1
  143. package/resources/webhooksubscription.d.ts +0 -155
  144. package/resources/webhooksubscription.d.ts.map +0 -1
  145. package/resources/webhooksubscription.js +0 -42
  146. package/resources/webhooksubscription.js.map +0 -1
  147. package/resources/webhooksubscription.mjs +0 -38
  148. package/resources/webhooksubscription.mjs.map +0 -1
  149. package/src/resources/reports.ts +0 -172
  150. package/src/resources/webhooksubscription.ts +0 -353
package/src/index.ts CHANGED
@@ -15,6 +15,7 @@ import {
15
15
  BankSearchResponse,
16
16
  Banks,
17
17
  } from './resources/banks';
18
+ import { BeneficiaryPayoutCreateResponse, BeneficiaryPayouts } from './resources/beneficiary-payouts';
18
19
  import { Capabilities, CapabilityRetrieveParams, CapabilityRetrieveResponse } from './resources/capabilities';
19
20
  import { Charge, ChargeCreateParams, Charges } from './resources/charges';
20
21
  import {
@@ -31,66 +32,68 @@ import {
31
32
  CustomerCreateResponse,
32
33
  CustomerRetrieveParams,
33
34
  CustomerRetrieveResponse,
35
+ CustomerSearchParams,
36
+ CustomerSearchResponse,
34
37
  Customers,
35
38
  } from './resources/customers';
39
+ import { DepositRetrieveParams, DepositRetrieveResponse, Deposits } from './resources/deposits';
36
40
  import {
41
+ Fx,
42
+ FxRetrieveParams,
43
+ FxRetrieveRateParams,
44
+ FxRetrieveRateResponse,
45
+ FxRetrieveResponse,
46
+ } from './resources/fx';
47
+ import {
48
+ Mandate,
37
49
  MandateLookupParams,
38
- MandateResponse,
50
+ MandateLookupResponse,
39
51
  MandateRetrieveParams,
40
52
  MandateRevokeParams,
41
53
  MandateRevokeResponse,
42
54
  Mandates,
43
55
  } from './resources/mandates';
44
56
  import {
57
+ OrderCreateParams,
58
+ OrderCreateResponse,
59
+ OrderExpireParams,
60
+ OrderExpireResponse,
45
61
  OrderRetrieveParams,
46
62
  OrderRetrieveResponse,
47
- OrderUpdateParams,
48
- OrderUpdateResponse,
49
63
  Orders,
50
64
  } from './resources/orders';
51
65
  import {
66
+ Payout,
52
67
  PayoutCreateParams,
53
68
  PayoutListParams,
54
69
  PayoutListResponse,
55
70
  PayoutRetrieveParams,
71
+ PayoutRetrieveResponse,
56
72
  Payouts,
57
- PublicUserPayout,
58
73
  } from './resources/payouts';
59
74
  import {
60
- RefundBatchParams,
61
- RefundBatchResponse,
75
+ Refund,
62
76
  RefundCreateParams,
63
- RefundResponse,
77
+ RefundCreateResponse,
78
+ RefundRetrieveParams,
79
+ RefundRetrieveResponse,
64
80
  Refunds,
65
81
  } from './resources/refunds';
66
82
  import {
67
- PayoutReport,
68
- ReportCreateParams,
69
- ReportCreateResponse,
70
- ReportDownloadParams,
71
- ReportRetrieveParams,
72
- ReportRetrieveResponse,
73
- Reports,
74
- } from './resources/reports';
83
+ ReturnCreateParams,
84
+ ReturnCreateResponse,
85
+ ReturnRetrieveParams,
86
+ ReturnRetrieveResponse,
87
+ Returns,
88
+ } from './resources/returns';
75
89
  import {
76
90
  Subaccount,
77
91
  SubaccountCreateParams,
92
+ SubaccountCreateResponse,
78
93
  SubaccountRetrieveParams,
79
94
  Subaccounts,
80
95
  } from './resources/subaccounts';
81
- import {
82
- Webhooksubscription,
83
- WebhooksubscriptionCreateParams,
84
- WebhooksubscriptionCreateResponse,
85
- WebhooksubscriptionDeleteParams,
86
- WebhooksubscriptionDeleteResponse,
87
- WebhooksubscriptionListParams,
88
- WebhooksubscriptionListResponse,
89
- WebhooksubscriptionPingParams,
90
- WebhooksubscriptionPingResponse,
91
- WebhooksubscriptionUpdateParams,
92
- WebhooksubscriptionUpdateResponse,
93
- } from './resources/webhooksubscription';
96
+ import { TransactionListParams, TransactionListResponse, Transactions } from './resources/transactions';
94
97
 
95
98
  const environments = {
96
99
  production: 'https://api.getivy.de',
@@ -126,6 +129,8 @@ export interface ClientOptions {
126
129
  *
127
130
  * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
128
131
  * much longer than this timeout before the promise succeeds or fails.
132
+ *
133
+ * @unit milliseconds
129
134
  */
130
135
  timeout?: number | undefined;
131
136
 
@@ -217,6 +222,7 @@ export class Ivy extends Core.APIClient {
217
222
 
218
223
  super({
219
224
  baseURL: options.baseURL || environments[options.environment || 'production'],
225
+ baseURLOverridden: baseURL ? baseURL !== environments[options.environment || 'production'] : false,
220
226
  timeout: options.timeout ?? 60000 /* 1 minute */,
221
227
  httpAgent: options.httpAgent,
222
228
  maxRetries: options.maxRetries,
@@ -233,14 +239,24 @@ export class Ivy extends Core.APIClient {
233
239
  customers: API.Customers = new API.Customers(this);
234
240
  orders: API.Orders = new API.Orders(this);
235
241
  charges: API.Charges = new API.Charges(this);
242
+ deposits: API.Deposits = new API.Deposits(this);
243
+ returns: API.Returns = new API.Returns(this);
244
+ fx: API.Fx = new API.Fx(this);
245
+ beneficiaryPayouts: API.BeneficiaryPayouts = new API.BeneficiaryPayouts(this);
246
+ transactions: API.Transactions = new API.Transactions(this);
236
247
  mandates: API.Mandates = new API.Mandates(this);
237
248
  capabilities: API.Capabilities = new API.Capabilities(this);
238
249
  refunds: API.Refunds = new API.Refunds(this);
239
250
  payouts: API.Payouts = new API.Payouts(this);
240
- reports: API.Reports = new API.Reports(this);
241
251
  subaccounts: API.Subaccounts = new API.Subaccounts(this);
242
252
  balance: API.Balance = new API.Balance(this);
243
- webhooksubscription: API.Webhooksubscription = new API.Webhooksubscription(this);
253
+
254
+ /**
255
+ * Check whether the base URL is set to its default.
256
+ */
257
+ #baseURLOverridden(): boolean {
258
+ return this.baseURL !== environments[this._options.environment || 'production'];
259
+ }
244
260
 
245
261
  protected override defaultQuery(): Core.DefaultQuery | undefined {
246
262
  return this._options.defaultQuery;
@@ -283,14 +299,18 @@ Ivy.Checkoutsession = Checkoutsession;
283
299
  Ivy.Customers = Customers;
284
300
  Ivy.Orders = Orders;
285
301
  Ivy.Charges = Charges;
302
+ Ivy.Deposits = Deposits;
303
+ Ivy.Returns = Returns;
304
+ Ivy.Fx = Fx;
305
+ Ivy.BeneficiaryPayouts = BeneficiaryPayouts;
306
+ Ivy.Transactions = Transactions;
286
307
  Ivy.Mandates = Mandates;
287
308
  Ivy.Capabilities = Capabilities;
288
309
  Ivy.Refunds = Refunds;
289
310
  Ivy.Payouts = Payouts;
290
- Ivy.Reports = Reports;
291
311
  Ivy.Subaccounts = Subaccounts;
292
312
  Ivy.Balance = Balance;
293
- Ivy.Webhooksubscription = Webhooksubscription;
313
+
294
314
  export declare namespace Ivy {
295
315
  export type RequestOptions = Core.RequestOptions;
296
316
 
@@ -318,23 +338,61 @@ export declare namespace Ivy {
318
338
  Customers as Customers,
319
339
  type CustomerCreateResponse as CustomerCreateResponse,
320
340
  type CustomerRetrieveResponse as CustomerRetrieveResponse,
341
+ type CustomerSearchResponse as CustomerSearchResponse,
321
342
  type CustomerCreateParams as CustomerCreateParams,
322
343
  type CustomerRetrieveParams as CustomerRetrieveParams,
344
+ type CustomerSearchParams as CustomerSearchParams,
323
345
  };
324
346
 
325
347
  export {
326
348
  Orders as Orders,
349
+ type OrderCreateResponse as OrderCreateResponse,
327
350
  type OrderRetrieveResponse as OrderRetrieveResponse,
328
- type OrderUpdateResponse as OrderUpdateResponse,
351
+ type OrderExpireResponse as OrderExpireResponse,
352
+ type OrderCreateParams as OrderCreateParams,
329
353
  type OrderRetrieveParams as OrderRetrieveParams,
330
- type OrderUpdateParams as OrderUpdateParams,
354
+ type OrderExpireParams as OrderExpireParams,
331
355
  };
332
356
 
333
357
  export { Charges as Charges, type Charge as Charge, type ChargeCreateParams as ChargeCreateParams };
334
358
 
359
+ export {
360
+ Deposits as Deposits,
361
+ type DepositRetrieveResponse as DepositRetrieveResponse,
362
+ type DepositRetrieveParams as DepositRetrieveParams,
363
+ };
364
+
365
+ export {
366
+ Returns as Returns,
367
+ type ReturnCreateResponse as ReturnCreateResponse,
368
+ type ReturnRetrieveResponse as ReturnRetrieveResponse,
369
+ type ReturnCreateParams as ReturnCreateParams,
370
+ type ReturnRetrieveParams as ReturnRetrieveParams,
371
+ };
372
+
373
+ export {
374
+ Fx as Fx,
375
+ type FxRetrieveResponse as FxRetrieveResponse,
376
+ type FxRetrieveRateResponse as FxRetrieveRateResponse,
377
+ type FxRetrieveParams as FxRetrieveParams,
378
+ type FxRetrieveRateParams as FxRetrieveRateParams,
379
+ };
380
+
381
+ export {
382
+ BeneficiaryPayouts as BeneficiaryPayouts,
383
+ type BeneficiaryPayoutCreateResponse as BeneficiaryPayoutCreateResponse,
384
+ };
385
+
386
+ export {
387
+ Transactions as Transactions,
388
+ type TransactionListResponse as TransactionListResponse,
389
+ type TransactionListParams as TransactionListParams,
390
+ };
391
+
335
392
  export {
336
393
  Mandates as Mandates,
337
- type MandateResponse as MandateResponse,
394
+ type Mandate as Mandate,
395
+ type MandateLookupResponse as MandateLookupResponse,
338
396
  type MandateRevokeResponse as MandateRevokeResponse,
339
397
  type MandateRetrieveParams as MandateRetrieveParams,
340
398
  type MandateLookupParams as MandateLookupParams,
@@ -349,34 +407,27 @@ export declare namespace Ivy {
349
407
 
350
408
  export {
351
409
  Refunds as Refunds,
352
- type RefundResponse as RefundResponse,
353
- type RefundBatchResponse as RefundBatchResponse,
410
+ type Refund as Refund,
411
+ type RefundCreateResponse as RefundCreateResponse,
412
+ type RefundRetrieveResponse as RefundRetrieveResponse,
354
413
  type RefundCreateParams as RefundCreateParams,
355
- type RefundBatchParams as RefundBatchParams,
414
+ type RefundRetrieveParams as RefundRetrieveParams,
356
415
  };
357
416
 
358
417
  export {
359
418
  Payouts as Payouts,
360
- type PublicUserPayout as PublicUserPayout,
419
+ type Payout as Payout,
420
+ type PayoutRetrieveResponse as PayoutRetrieveResponse,
361
421
  type PayoutListResponse as PayoutListResponse,
362
422
  type PayoutCreateParams as PayoutCreateParams,
363
423
  type PayoutRetrieveParams as PayoutRetrieveParams,
364
424
  type PayoutListParams as PayoutListParams,
365
425
  };
366
426
 
367
- export {
368
- Reports as Reports,
369
- type PayoutReport as PayoutReport,
370
- type ReportCreateResponse as ReportCreateResponse,
371
- type ReportRetrieveResponse as ReportRetrieveResponse,
372
- type ReportCreateParams as ReportCreateParams,
373
- type ReportRetrieveParams as ReportRetrieveParams,
374
- type ReportDownloadParams as ReportDownloadParams,
375
- };
376
-
377
427
  export {
378
428
  Subaccounts as Subaccounts,
379
429
  type Subaccount as Subaccount,
430
+ type SubaccountCreateResponse as SubaccountCreateResponse,
380
431
  type SubaccountCreateParams as SubaccountCreateParams,
381
432
  type SubaccountRetrieveParams as SubaccountRetrieveParams,
382
433
  };
@@ -386,20 +437,6 @@ export declare namespace Ivy {
386
437
  type BalanceRetrieveResponse as BalanceRetrieveResponse,
387
438
  type BalanceRetrieveParams as BalanceRetrieveParams,
388
439
  };
389
-
390
- export {
391
- Webhooksubscription as Webhooksubscription,
392
- type WebhooksubscriptionCreateResponse as WebhooksubscriptionCreateResponse,
393
- type WebhooksubscriptionUpdateResponse as WebhooksubscriptionUpdateResponse,
394
- type WebhooksubscriptionListResponse as WebhooksubscriptionListResponse,
395
- type WebhooksubscriptionDeleteResponse as WebhooksubscriptionDeleteResponse,
396
- type WebhooksubscriptionPingResponse as WebhooksubscriptionPingResponse,
397
- type WebhooksubscriptionCreateParams as WebhooksubscriptionCreateParams,
398
- type WebhooksubscriptionUpdateParams as WebhooksubscriptionUpdateParams,
399
- type WebhooksubscriptionListParams as WebhooksubscriptionListParams,
400
- type WebhooksubscriptionDeleteParams as WebhooksubscriptionDeleteParams,
401
- type WebhooksubscriptionPingParams as WebhooksubscriptionPingParams,
402
- };
403
440
  }
404
441
 
405
442
  export { toFile, fileFromPath } from './uploads';
package/src/resource.ts CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  import type { Ivy } from './index';
4
4
 
5
- export class APIResource {
5
+ export abstract class APIResource {
6
6
  protected _client: Ivy;
7
7
 
8
8
  constructor(client: Ivy) {
@@ -16,10 +16,10 @@ export class Balance extends APIResource {
16
16
  }
17
17
  }
18
18
 
19
- /**
20
- * Returns the Balance of your Ivy account
21
- */
22
19
  export interface BalanceRetrieveResponse {
20
+ /**
21
+ * Array of balance information for different currencies
22
+ */
23
23
  balances: Array<BalanceRetrieveResponse.Balance>;
24
24
  }
25
25
 
@@ -33,12 +33,15 @@ export namespace BalanceRetrieveResponse {
33
33
  /**
34
34
  * The currency of the balance
35
35
  */
36
- currency: 'EUR' | 'GBP' | 'PLN';
36
+ currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
37
37
  }
38
38
  }
39
39
 
40
40
  export interface BalanceRetrieveParams {
41
- currency: 'EUR' | 'GBP' | 'PLN';
41
+ /**
42
+ * The currency to retrieve the balance for
43
+ */
44
+ currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
42
45
  }
43
46
 
44
47
  export declare namespace Balance {
@@ -31,24 +31,17 @@ export class Banks extends APIResource {
31
31
 
32
32
  export interface BankRetrieveResponse {
33
33
  /**
34
- * Unique identifier for the bank, conforming to the regex pattern
35
- * /^[a-z]{2}-[a-z0-9+/-]{1,}$/. This pattern typically represents a country code
36
- * followed by a bank-specific identifier, e.g.,
37
- * 'de-alxingbruckergenossenschaftsbank'.
34
+ * Unique identifier of the bank.
38
35
  */
39
36
  id: string;
40
37
 
41
- currencies: Array<'EUR' | 'GBP' | 'PLN'>;
38
+ currencies: Array<'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK'>;
42
39
 
43
40
  /**
44
- * If true, the bank is part of the set of default banks for a given market.
41
+ * Whether the bank is a default bank.
45
42
  */
46
43
  default: boolean;
47
44
 
48
- /**
49
- * Array of ISO 3166-1 alpha-2 country codes. The markets where the bank is
50
- * available.
51
- */
52
45
  market: Array<
53
46
  | 'AF'
54
47
  | 'AL'
@@ -303,36 +296,48 @@ export interface BankRetrieveResponse {
303
296
  >;
304
297
 
305
298
  /**
306
- * Customer-facing name of the bank.
299
+ * Name of the bank.
307
300
  */
308
301
  name: string;
309
302
 
310
303
  /**
311
304
  * The payment schemes supported by the bank.
312
305
  */
313
- supportedPaymentSchemes: Array<'SEPA_INSTANT' | 'FASTER_PAYMENTS' | 'SEPA' | 'ELIXIR' | 'EXPRESS_ELIXIR'>;
306
+ supportedPaymentSchemes: Array<
307
+ | 'SEPA_INSTANT'
308
+ | 'FASTER_PAYMENTS'
309
+ | 'SEPA'
310
+ | 'ELIXIR'
311
+ | 'EXPRESS_ELIXIR'
312
+ | 'SEK_ACCOUNT_TO_ACCOUNT'
313
+ | 'SUMCLEARING'
314
+ | 'STRAKSCLEARING'
315
+ | 'SWIFT'
316
+ | 'INTERNAL'
317
+ | 'TARGET'
318
+ >;
314
319
 
315
320
  /**
316
- * If true, the bank is only available in test (sandbox) mode.
321
+ * Whether the bank is a test bank.
317
322
  */
318
323
  test: boolean;
319
324
 
320
325
  /**
321
- * The capabilities of the bank. The capabilities determine which products the bank
322
- * supports. `ais` for data products, `pis` for payment products.
326
+ * The capabilities of the bank.
323
327
  */
324
- capabilities?: Array<'pis' | 'ais'>;
328
+ capabilities?: Array<'ais' | 'pis'>;
325
329
 
326
- /**
327
- * The group of the bank, e.g. "Sparkasse", i.e. a group of different bank branches
328
- * of the same brand.
329
- */
330
330
  group?: string;
331
331
 
332
332
  /**
333
- * The logo of the bank provided as a URL.
333
+ * The logo in the form of an URL
334
334
  */
335
335
  logo?: string;
336
+
337
+ /**
338
+ * The URL of the bank's website.
339
+ */
340
+ url?: string;
336
341
  }
337
342
 
338
343
  export interface BankListResponse {
@@ -340,29 +345,37 @@ export interface BankListResponse {
340
345
  * A list of banks.
341
346
  */
342
347
  banks: Array<BankListResponse.Bank>;
348
+
349
+ /**
350
+ * The total number of banks
351
+ */
352
+ count: number;
353
+
354
+ /**
355
+ * Whether there are more banks to retrieve
356
+ */
357
+ hasNext: boolean;
358
+
359
+ /**
360
+ * The number of banks skipped
361
+ */
362
+ skip: number;
343
363
  }
344
364
 
345
365
  export namespace BankListResponse {
346
366
  export interface Bank {
347
367
  /**
348
- * Unique identifier for the bank, conforming to the regex pattern
349
- * /^[a-z]{2}-[a-z0-9+/-]{1,}$/. This pattern typically represents a country code
350
- * followed by a bank-specific identifier, e.g.,
351
- * 'de-alxingbruckergenossenschaftsbank'.
368
+ * Unique identifier of the bank.
352
369
  */
353
370
  id: string;
354
371
 
355
- currencies: Array<'EUR' | 'GBP' | 'PLN'>;
372
+ currencies: Array<'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK'>;
356
373
 
357
374
  /**
358
- * If true, the bank is part of the set of default banks for a given market.
375
+ * Whether the bank is a default bank.
359
376
  */
360
377
  default: boolean;
361
378
 
362
- /**
363
- * Array of ISO 3166-1 alpha-2 country codes. The markets where the bank is
364
- * available.
365
- */
366
379
  market: Array<
367
380
  | 'AF'
368
381
  | 'AL'
@@ -617,36 +630,48 @@ export namespace BankListResponse {
617
630
  >;
618
631
 
619
632
  /**
620
- * Customer-facing name of the bank.
633
+ * Name of the bank.
621
634
  */
622
635
  name: string;
623
636
 
624
637
  /**
625
638
  * The payment schemes supported by the bank.
626
639
  */
627
- supportedPaymentSchemes: Array<'SEPA_INSTANT' | 'FASTER_PAYMENTS' | 'SEPA' | 'ELIXIR' | 'EXPRESS_ELIXIR'>;
640
+ supportedPaymentSchemes: Array<
641
+ | 'SEPA_INSTANT'
642
+ | 'FASTER_PAYMENTS'
643
+ | 'SEPA'
644
+ | 'ELIXIR'
645
+ | 'EXPRESS_ELIXIR'
646
+ | 'SEK_ACCOUNT_TO_ACCOUNT'
647
+ | 'SUMCLEARING'
648
+ | 'STRAKSCLEARING'
649
+ | 'SWIFT'
650
+ | 'INTERNAL'
651
+ | 'TARGET'
652
+ >;
628
653
 
629
654
  /**
630
- * If true, the bank is only available in test (sandbox) mode.
655
+ * Whether the bank is a test bank.
631
656
  */
632
657
  test: boolean;
633
658
 
634
659
  /**
635
- * The capabilities of the bank. The capabilities determine which products the bank
636
- * supports. `ais` for data products, `pis` for payment products.
660
+ * The capabilities of the bank.
637
661
  */
638
- capabilities?: Array<'pis' | 'ais'>;
662
+ capabilities?: Array<'ais' | 'pis'>;
639
663
 
640
- /**
641
- * The group of the bank, e.g. "Sparkasse", i.e. a group of different bank branches
642
- * of the same brand.
643
- */
644
664
  group?: string;
645
665
 
646
666
  /**
647
- * The logo of the bank provided as a URL.
667
+ * The logo in the form of an URL
648
668
  */
649
669
  logo?: string;
670
+
671
+ /**
672
+ * The URL of the bank's website.
673
+ */
674
+ url?: string;
650
675
  }
651
676
  }
652
677
 
@@ -655,29 +680,37 @@ export interface BankSearchResponse {
655
680
  * A list of banks.
656
681
  */
657
682
  banks: Array<BankSearchResponse.Bank>;
683
+
684
+ /**
685
+ * The total number of banks
686
+ */
687
+ count: number;
688
+
689
+ /**
690
+ * Whether there are more banks to retrieve
691
+ */
692
+ hasNext: boolean;
693
+
694
+ /**
695
+ * The number of banks skipped
696
+ */
697
+ skip: number;
658
698
  }
659
699
 
660
700
  export namespace BankSearchResponse {
661
701
  export interface Bank {
662
702
  /**
663
- * Unique identifier for the bank, conforming to the regex pattern
664
- * /^[a-z]{2}-[a-z0-9+/-]{1,}$/. This pattern typically represents a country code
665
- * followed by a bank-specific identifier, e.g.,
666
- * 'de-alxingbruckergenossenschaftsbank'.
703
+ * Unique identifier of the bank.
667
704
  */
668
705
  id: string;
669
706
 
670
- currencies: Array<'EUR' | 'GBP' | 'PLN'>;
707
+ currencies: Array<'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK'>;
671
708
 
672
709
  /**
673
- * If true, the bank is part of the set of default banks for a given market.
710
+ * Whether the bank is a default bank.
674
711
  */
675
712
  default: boolean;
676
713
 
677
- /**
678
- * Array of ISO 3166-1 alpha-2 country codes. The markets where the bank is
679
- * available.
680
- */
681
714
  market: Array<
682
715
  | 'AF'
683
716
  | 'AL'
@@ -932,40 +965,55 @@ export namespace BankSearchResponse {
932
965
  >;
933
966
 
934
967
  /**
935
- * Customer-facing name of the bank.
968
+ * Name of the bank.
936
969
  */
937
970
  name: string;
938
971
 
939
972
  /**
940
973
  * The payment schemes supported by the bank.
941
974
  */
942
- supportedPaymentSchemes: Array<'SEPA_INSTANT' | 'FASTER_PAYMENTS' | 'SEPA' | 'ELIXIR' | 'EXPRESS_ELIXIR'>;
975
+ supportedPaymentSchemes: Array<
976
+ | 'SEPA_INSTANT'
977
+ | 'FASTER_PAYMENTS'
978
+ | 'SEPA'
979
+ | 'ELIXIR'
980
+ | 'EXPRESS_ELIXIR'
981
+ | 'SEK_ACCOUNT_TO_ACCOUNT'
982
+ | 'SUMCLEARING'
983
+ | 'STRAKSCLEARING'
984
+ | 'SWIFT'
985
+ | 'INTERNAL'
986
+ | 'TARGET'
987
+ >;
943
988
 
944
989
  /**
945
- * If true, the bank is only available in test (sandbox) mode.
990
+ * Whether the bank is a test bank.
946
991
  */
947
992
  test: boolean;
948
993
 
949
994
  /**
950
- * The capabilities of the bank. The capabilities determine which products the bank
951
- * supports. `ais` for data products, `pis` for payment products.
995
+ * The capabilities of the bank.
952
996
  */
953
- capabilities?: Array<'pis' | 'ais'>;
997
+ capabilities?: Array<'ais' | 'pis'>;
954
998
 
955
- /**
956
- * The group of the bank, e.g. "Sparkasse", i.e. a group of different bank branches
957
- * of the same brand.
958
- */
959
999
  group?: string;
960
1000
 
961
1001
  /**
962
- * The logo of the bank provided as a URL.
1002
+ * The logo in the form of an URL
963
1003
  */
964
1004
  logo?: string;
1005
+
1006
+ /**
1007
+ * The URL of the bank's website.
1008
+ */
1009
+ url?: string;
965
1010
  }
966
1011
  }
967
1012
 
968
1013
  export interface BankRetrieveParams {
1014
+ /**
1015
+ * The id is a unique identifier of the bank within Ivy.
1016
+ */
969
1017
  id: string;
970
1018
  }
971
1019
 
@@ -979,7 +1027,7 @@ export interface BankListParams {
979
1027
  /**
980
1028
  * ISO 4217 currency code. Filter banks with provided currency only.
981
1029
  */
982
- currency?: 'EUR' | 'GBP' | 'PLN';
1030
+ currency?: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
983
1031
 
984
1032
  /**
985
1033
  * If provided the list will show banks in this group only. Groups are e.g.
@@ -987,6 +1035,11 @@ export interface BankListParams {
987
1035
  */
988
1036
  group?: string;
989
1037
 
1038
+ /**
1039
+ * The maximum number of banks to return (default 1000)
1040
+ */
1041
+ limit?: number;
1042
+
990
1043
  /**
991
1044
  * ISO 3166-1 alpha-2 country code. Filter banks with provided market only.
992
1045
  */
@@ -1245,7 +1298,12 @@ export interface BankListParams {
1245
1298
  /**
1246
1299
  * The internal checkout session id. For internal use only.
1247
1300
  */
1248
- sessionId?: string;
1301
+ sessionId?: unknown;
1302
+
1303
+ /**
1304
+ * The number of banks to skip
1305
+ */
1306
+ skip?: number;
1249
1307
  }
1250
1308
 
1251
1309
  export interface BankSearchParams {
@@ -1258,7 +1316,7 @@ export interface BankSearchParams {
1258
1316
  /**
1259
1317
  * ISO 4217 currency code. Filter banks with provided currency only.
1260
1318
  */
1261
- currency?: 'EUR' | 'GBP' | 'PLN';
1319
+ currency?: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
1262
1320
 
1263
1321
  /**
1264
1322
  * If provided the list will show banks in this group only. Groups are e.g.
@@ -1536,7 +1594,12 @@ export interface BankSearchParams {
1536
1594
  /**
1537
1595
  * The internal checkout session id. For internal use only.
1538
1596
  */
1539
- sessionId?: string;
1597
+ sessionId?: unknown;
1598
+
1599
+ /**
1600
+ * The number of banks to skip
1601
+ */
1602
+ skip?: number;
1540
1603
  }
1541
1604
 
1542
1605
  export declare namespace Banks {