@getivy/node-sdk 0.1.0-alpha.9 → 1.1.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 (231) hide show
  1. package/CHANGELOG.md +334 -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 +36 -18
  13. package/index.d.ts +36 -18
  14. package/index.d.ts.map +1 -1
  15. package/index.js +27 -8
  16. package/index.js.map +1 -1
  17. package/index.mjs +27 -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/data/accounts.d.ts +83 -0
  47. package/resources/data/accounts.d.ts.map +1 -0
  48. package/resources/data/accounts.js +15 -0
  49. package/resources/data/accounts.js.map +1 -0
  50. package/resources/data/accounts.mjs +11 -0
  51. package/resources/data/accounts.mjs.map +1 -0
  52. package/resources/data/balances.d.ts +48 -0
  53. package/resources/data/balances.d.ts.map +1 -0
  54. package/resources/data/balances.js +15 -0
  55. package/resources/data/balances.js.map +1 -0
  56. package/resources/data/balances.mjs +11 -0
  57. package/resources/data/balances.mjs.map +1 -0
  58. package/resources/data/consent.d.ts +80 -0
  59. package/resources/data/consent.d.ts.map +1 -0
  60. package/resources/data/consent.js +21 -0
  61. package/resources/data/consent.js.map +1 -0
  62. package/resources/data/consent.mjs +17 -0
  63. package/resources/data/consent.mjs.map +1 -0
  64. package/resources/data/data.d.ts +26 -0
  65. package/resources/data/data.d.ts.map +1 -0
  66. package/resources/data/data.js +55 -0
  67. package/resources/data/data.js.map +1 -0
  68. package/resources/data/data.mjs +28 -0
  69. package/resources/data/data.mjs.map +1 -0
  70. package/resources/data/index.d.ts +7 -0
  71. package/resources/data/index.d.ts.map +1 -0
  72. package/resources/data/index.js +17 -0
  73. package/resources/data/index.js.map +1 -0
  74. package/resources/data/index.mjs +8 -0
  75. package/resources/data/index.mjs.map +1 -0
  76. package/resources/data/session.d.ts +258 -0
  77. package/resources/data/session.d.ts.map +1 -0
  78. package/resources/data/session.js +21 -0
  79. package/resources/data/session.js.map +1 -0
  80. package/resources/data/session.mjs +17 -0
  81. package/resources/data/session.mjs.map +1 -0
  82. package/resources/data/transactions.d.ts +175 -0
  83. package/resources/data/transactions.d.ts.map +1 -0
  84. package/resources/data/transactions.js +16 -0
  85. package/resources/data/transactions.js.map +1 -0
  86. package/resources/data/transactions.mjs +12 -0
  87. package/resources/data/transactions.mjs.map +1 -0
  88. package/resources/data.d.ts +2 -0
  89. package/resources/data.d.ts.map +1 -0
  90. package/resources/data.js +19 -0
  91. package/resources/data.js.map +1 -0
  92. package/resources/data.mjs +3 -0
  93. package/resources/data.mjs.map +1 -0
  94. package/resources/deposits.d.ts +165 -0
  95. package/resources/deposits.d.ts.map +1 -0
  96. package/resources/deposits.js +15 -0
  97. package/resources/deposits.js.map +1 -0
  98. package/resources/deposits.mjs +11 -0
  99. package/resources/deposits.mjs.map +1 -0
  100. package/resources/fx.d.ts +90 -0
  101. package/resources/fx.d.ts.map +1 -0
  102. package/resources/fx.js +22 -0
  103. package/resources/fx.js.map +1 -0
  104. package/resources/fx.mjs +18 -0
  105. package/resources/fx.mjs.map +1 -0
  106. package/resources/index.d.ts +13 -8
  107. package/resources/index.d.ts.map +1 -1
  108. package/resources/index.js +15 -5
  109. package/resources/index.js.map +1 -1
  110. package/resources/index.mjs +7 -2
  111. package/resources/index.mjs.map +1 -1
  112. package/resources/mandates.d.ts +55 -17
  113. package/resources/mandates.d.ts.map +1 -1
  114. package/resources/orders.d.ts +720 -743
  115. package/resources/orders.d.ts.map +1 -1
  116. package/resources/orders.js +13 -3
  117. package/resources/orders.js.map +1 -1
  118. package/resources/orders.mjs +13 -3
  119. package/resources/orders.mjs.map +1 -1
  120. package/resources/payouts.d.ts +219 -103
  121. package/resources/payouts.d.ts.map +1 -1
  122. package/resources/payouts.js +3 -4
  123. package/resources/payouts.js.map +1 -1
  124. package/resources/payouts.mjs +3 -4
  125. package/resources/payouts.mjs.map +1 -1
  126. package/resources/refunds.d.ts +53 -97
  127. package/resources/refunds.d.ts.map +1 -1
  128. package/resources/refunds.js +8 -12
  129. package/resources/refunds.js.map +1 -1
  130. package/resources/refunds.mjs +8 -12
  131. package/resources/refunds.mjs.map +1 -1
  132. package/resources/returns.d.ts +104 -0
  133. package/resources/returns.d.ts.map +1 -0
  134. package/resources/returns.js +21 -0
  135. package/resources/returns.js.map +1 -0
  136. package/resources/returns.mjs +17 -0
  137. package/resources/returns.mjs.map +1 -0
  138. package/resources/subaccounts.d.ts +15 -5
  139. package/resources/subaccounts.d.ts.map +1 -1
  140. package/resources/subaccounts.js.map +1 -1
  141. package/resources/subaccounts.mjs.map +1 -1
  142. package/resources/transactions.d.ts +174 -0
  143. package/resources/transactions.d.ts.map +1 -0
  144. package/resources/transactions.js +15 -0
  145. package/resources/transactions.js.map +1 -0
  146. package/resources/transactions.mjs +11 -0
  147. package/resources/transactions.mjs.map +1 -0
  148. package/resources/webhook/index.d.ts +3 -0
  149. package/resources/webhook/index.d.ts.map +1 -0
  150. package/resources/webhook/index.js +9 -0
  151. package/resources/webhook/index.js.map +1 -0
  152. package/resources/webhook/index.mjs +4 -0
  153. package/resources/webhook/index.mjs.map +1 -0
  154. package/resources/webhook/subscription.d.ts +152 -0
  155. package/resources/webhook/subscription.d.ts.map +1 -0
  156. package/resources/{webhooksubscription.js → webhook/subscription.js} +6 -6
  157. package/resources/webhook/subscription.js.map +1 -0
  158. package/resources/{webhooksubscription.mjs → webhook/subscription.mjs} +4 -4
  159. package/resources/webhook/subscription.mjs.map +1 -0
  160. package/resources/webhook/webhook.d.ts +28 -0
  161. package/resources/webhook/webhook.d.ts.map +1 -0
  162. package/resources/webhook/webhook.js +45 -0
  163. package/resources/webhook/webhook.js.map +1 -0
  164. package/resources/webhook/webhook.mjs +18 -0
  165. package/resources/webhook/webhook.mjs.map +1 -0
  166. package/resources/webhook.d.ts +2 -0
  167. package/resources/webhook.d.ts.map +1 -0
  168. package/resources/webhook.js +19 -0
  169. package/resources/webhook.js.map +1 -0
  170. package/resources/webhook.mjs +3 -0
  171. package/resources/webhook.mjs.map +1 -0
  172. package/resources.d.ts +2 -0
  173. package/resources.d.ts.map +1 -0
  174. package/resources.js +18 -0
  175. package/resources.js.map +1 -0
  176. package/resources.mjs +2 -0
  177. package/resources.mjs.map +1 -0
  178. package/src/_shims/index.d.ts +2 -0
  179. package/src/_shims/index.js +5 -1
  180. package/src/_shims/index.mjs +5 -1
  181. package/src/core.ts +44 -16
  182. package/src/index.ts +111 -60
  183. package/src/resource.ts +1 -1
  184. package/src/resources/balance.ts +8 -5
  185. package/src/resources/banks.ts +130 -67
  186. package/src/resources/beneficiary-payouts.ts +78 -0
  187. package/src/resources/capabilities.ts +1 -10
  188. package/src/resources/charges.ts +30 -21
  189. package/src/resources/checkoutsession.ts +1224 -3096
  190. package/src/resources/customers.ts +164 -9
  191. package/src/resources/data/accounts.ts +113 -0
  192. package/src/resources/data/balances.ts +60 -0
  193. package/src/resources/data/consent.ts +110 -0
  194. package/src/resources/data/data.ts +75 -0
  195. package/src/resources/data/index.ts +20 -0
  196. package/src/resources/data/session.ts +1317 -0
  197. package/src/resources/data/transactions.ts +235 -0
  198. package/src/resources/data.ts +3 -0
  199. package/src/resources/deposits.ts +231 -0
  200. package/src/resources/fx.ts +119 -0
  201. package/src/resources/index.ts +33 -28
  202. package/src/resources/mandates.ts +79 -17
  203. package/src/resources/orders.ts +1449 -1075
  204. package/src/resources/payouts.ts +273 -103
  205. package/src/resources/refunds.ts +70 -111
  206. package/src/resources/returns.ts +140 -0
  207. package/src/resources/subaccounts.ts +26 -4
  208. package/src/resources/transactions.ts +234 -0
  209. package/src/resources/webhook/index.ts +16 -0
  210. package/src/resources/{webhooksubscription.ts → webhook/subscription.ts} +164 -112
  211. package/src/resources/webhook/webhook.ts +69 -0
  212. package/src/resources/webhook.ts +3 -0
  213. package/src/resources.ts +1 -0
  214. package/src/version.ts +1 -1
  215. package/version.d.ts +1 -1
  216. package/version.d.ts.map +1 -1
  217. package/version.js +1 -1
  218. package/version.js.map +1 -1
  219. package/version.mjs +1 -1
  220. package/version.mjs.map +1 -1
  221. package/resources/reports.d.ts +0 -120
  222. package/resources/reports.d.ts.map +0 -1
  223. package/resources/reports.js +0 -31
  224. package/resources/reports.js.map +0 -1
  225. package/resources/reports.mjs +0 -27
  226. package/resources/reports.mjs.map +0 -1
  227. package/resources/webhooksubscription.d.ts +0 -155
  228. package/resources/webhooksubscription.d.ts.map +0 -1
  229. package/resources/webhooksubscription.js.map +0 -1
  230. package/resources/webhooksubscription.mjs.map +0 -1
  231. package/src/resources/reports.ts +0 -172
@@ -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 {
@@ -0,0 +1,78 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../resource';
4
+ import * as Core from '../core';
5
+
6
+ export class BeneficiaryPayouts extends APIResource {
7
+ /**
8
+ * Perform a payout. This endpoint will be deprecated in favor of the new payout
9
+ * endpoint that will support more payout types.
10
+ */
11
+ create(options?: Core.RequestOptions): Core.APIPromise<BeneficiaryPayoutCreateResponse> {
12
+ return this._client.post('/api/service/beneficiary-payout/create', options);
13
+ }
14
+ }
15
+
16
+ /**
17
+ * Array of payout objects
18
+ */
19
+ export type BeneficiaryPayoutCreateResponse =
20
+ Array<BeneficiaryPayoutCreateResponse.BeneficiaryPayoutCreateResponseItem>;
21
+
22
+ export namespace BeneficiaryPayoutCreateResponse {
23
+ export interface BeneficiaryPayoutCreateResponseItem {
24
+ /**
25
+ * The unique identifier of the payout
26
+ */
27
+ id: string;
28
+
29
+ /**
30
+ * The payout amount
31
+ */
32
+ amount: number;
33
+
34
+ /**
35
+ * The creation timestamp of the payout
36
+ */
37
+ createdAt: unknown;
38
+
39
+ /**
40
+ * The currency of the payout
41
+ */
42
+ currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
43
+
44
+ /**
45
+ * Description of the payout
46
+ */
47
+ description: string;
48
+
49
+ /**
50
+ * The merchant identifier
51
+ */
52
+ merchant: string;
53
+
54
+ /**
55
+ * The reference identifier for the payout
56
+ */
57
+ referenceId: string;
58
+
59
+ /**
60
+ * The descriptor that appears on bank statements
61
+ */
62
+ statementDescriptor: string;
63
+
64
+ /**
65
+ * The current status of the payout
66
+ */
67
+ status: 'paid' | 'pending' | 'in_transit' | 'failed' | 'canceled';
68
+
69
+ /**
70
+ * The type of payout
71
+ */
72
+ type: 'merchant' | 'customer';
73
+ }
74
+ }
75
+
76
+ export declare namespace BeneficiaryPayouts {
77
+ export { type BeneficiaryPayoutCreateResponse as BeneficiaryPayoutCreateResponse };
78
+ }
@@ -17,19 +17,10 @@ export class Capabilities extends APIResource {
17
17
  }
18
18
 
19
19
  export interface CapabilityRetrieveResponse {
20
- /**
21
- * Either `'pis'` or `'ais'` or both. The capabilities of the merchant set in the
22
- * merchant dashboard for the specific market. If no capabilities are set, the
23
- * response will be an empty array. Check if `'pis'` is present in the array for
24
- * payments capabilities.
25
- */
26
- capabilities: Array<'pis' | 'ais'>;
20
+ capabilities?: Array<'ais' | 'pis'>;
27
21
  }
28
22
 
29
23
  export interface CapabilityRetrieveParams {
30
- /**
31
- * The market for which you want to retrieve the capabilities.
32
- */
33
24
  market:
34
25
  | 'AF'
35
26
  | 'AL'
@@ -13,12 +13,24 @@ export class Charges extends APIResource {
13
13
  }
14
14
 
15
15
  export interface Charge {
16
+ /**
17
+ * The unique identifier of the created charge
18
+ */
16
19
  id: string;
17
20
 
21
+ /**
22
+ * The mandate id used for the charge
23
+ */
18
24
  mandateId: string;
19
25
 
20
- orderId?: string;
26
+ /**
27
+ * The order id associated with the charge
28
+ */
29
+ orderId?: unknown;
21
30
 
31
+ /**
32
+ * The subaccount id used for the charge
33
+ */
22
34
  subaccountId?: string;
23
35
  }
24
36
 
@@ -34,6 +46,11 @@ export interface ChargeCreateParams {
34
46
  */
35
47
  mandateId: string;
36
48
 
49
+ /**
50
+ * Additional data to be stored with the charge.
51
+ */
52
+ metadata: ChargeCreateParams.Metadata;
53
+
37
54
  /**
38
55
  * The price to be charged.
39
56
  */
@@ -46,11 +63,6 @@ export interface ChargeCreateParams {
46
63
  */
47
64
  referenceId: string;
48
65
 
49
- /**
50
- * Additional data to be stored with the charge.
51
- */
52
- metadata?: ChargeCreateParams.Metadata;
53
-
54
66
  /**
55
67
  * The subaccount id to be used for the charge.
56
68
  */
@@ -58,15 +70,23 @@ export interface ChargeCreateParams {
58
70
  }
59
71
 
60
72
  export namespace ChargeCreateParams {
73
+ /**
74
+ * Additional data to be stored with the charge.
75
+ */
76
+ export interface Metadata {
77
+ /**
78
+ * A token to verify incoming webhooks. Used in the shopware plugin. Limited to 200
79
+ * characters.
80
+ */
81
+ verificationToken?: string;
82
+ }
83
+
61
84
  /**
62
85
  * The price to be charged.
63
86
  */
64
87
  export interface Price {
65
- currency: 'EUR' | 'GBP' | 'PLN';
88
+ currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
66
89
 
67
- /**
68
- * The total amount to be paid.
69
- */
70
90
  total: number;
71
91
 
72
92
  shipping?: number;
@@ -77,17 +97,6 @@ export namespace ChargeCreateParams {
77
97
 
78
98
  vat?: number;
79
99
  }
80
-
81
- /**
82
- * Additional data to be stored with the charge.
83
- */
84
- export interface Metadata {
85
- /**
86
- * A token to verify incoming webhooks. Used in the shopware plugin. Limited to 200
87
- * characters.
88
- */
89
- verificationToken?: string;
90
- }
91
100
  }
92
101
 
93
102
  export declare namespace Charges {