@getivy/node-sdk 0.1.0-alpha.31 → 0.1.0-alpha.33

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 (123) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/index.d.mts +14 -14
  3. package/index.d.ts +14 -14
  4. package/index.d.ts.map +1 -1
  5. package/index.js.map +1 -1
  6. package/index.mjs +1 -1
  7. package/index.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/balance.d.ts +6 -3
  10. package/resources/balance.d.ts.map +1 -1
  11. package/resources/banks.d.ts +38 -59
  12. package/resources/banks.d.ts.map +1 -1
  13. package/resources/capabilities.d.ts +1 -10
  14. package/resources/capabilities.d.ts.map +1 -1
  15. package/resources/charges.d.ts +30 -21
  16. package/resources/charges.d.ts.map +1 -1
  17. package/resources/checkoutsession.d.ts +315 -807
  18. package/resources/checkoutsession.d.ts.map +1 -1
  19. package/resources/customers.d.ts +9 -12
  20. package/resources/customers.d.ts.map +1 -1
  21. package/resources/data/accounts.d.ts +0 -100
  22. package/resources/data/accounts.d.ts.map +1 -1
  23. package/resources/data/accounts.js +0 -6
  24. package/resources/data/accounts.js.map +1 -1
  25. package/resources/data/accounts.mjs +0 -6
  26. package/resources/data/accounts.mjs.map +1 -1
  27. package/resources/data/balances.d.ts +0 -41
  28. package/resources/data/balances.d.ts.map +1 -1
  29. package/resources/data/balances.js +0 -6
  30. package/resources/data/balances.js.map +1 -1
  31. package/resources/data/balances.mjs +0 -6
  32. package/resources/data/balances.mjs.map +1 -1
  33. package/resources/data/consent.d.ts +0 -76
  34. package/resources/data/consent.d.ts.map +1 -1
  35. package/resources/data/consent.js +0 -12
  36. package/resources/data/consent.js.map +1 -1
  37. package/resources/data/consent.mjs +0 -12
  38. package/resources/data/consent.mjs.map +1 -1
  39. package/resources/data/data.d.ts +10 -10
  40. package/resources/data/data.d.ts.map +1 -1
  41. package/resources/data/data.js.map +1 -1
  42. package/resources/data/data.mjs +2 -2
  43. package/resources/data/data.mjs.map +1 -1
  44. package/resources/data/index.d.ts +5 -5
  45. package/resources/data/index.d.ts.map +1 -1
  46. package/resources/data/index.js.map +1 -1
  47. package/resources/data/index.mjs +2 -2
  48. package/resources/data/index.mjs.map +1 -1
  49. package/resources/data/session.d.ts +0 -230
  50. package/resources/data/session.d.ts.map +1 -1
  51. package/resources/data/session.js +0 -12
  52. package/resources/data/session.js.map +1 -1
  53. package/resources/data/session.mjs +0 -12
  54. package/resources/data/session.mjs.map +1 -1
  55. package/resources/data/transactions.d.ts +0 -50
  56. package/resources/data/transactions.d.ts.map +1 -1
  57. package/resources/data/transactions.js +0 -7
  58. package/resources/data/transactions.js.map +1 -1
  59. package/resources/data/transactions.mjs +0 -7
  60. package/resources/data/transactions.mjs.map +1 -1
  61. package/resources/index.d.ts +7 -7
  62. package/resources/index.d.ts.map +1 -1
  63. package/resources/index.js.map +1 -1
  64. package/resources/index.mjs +1 -1
  65. package/resources/index.mjs.map +1 -1
  66. package/resources/mandates.d.ts +55 -17
  67. package/resources/mandates.d.ts.map +1 -1
  68. package/resources/mandates.js.map +1 -1
  69. package/resources/mandates.mjs.map +1 -1
  70. package/resources/orders.d.ts +242 -524
  71. package/resources/orders.d.ts.map +1 -1
  72. package/resources/payouts.d.ts +146 -70
  73. package/resources/payouts.d.ts.map +1 -1
  74. package/resources/payouts.js.map +1 -1
  75. package/resources/payouts.mjs.map +1 -1
  76. package/resources/refunds.d.ts +16 -92
  77. package/resources/refunds.d.ts.map +1 -1
  78. package/resources/refunds.js +4 -4
  79. package/resources/refunds.js.map +1 -1
  80. package/resources/refunds.mjs +4 -4
  81. package/resources/refunds.mjs.map +1 -1
  82. package/resources/reports.d.ts +4 -78
  83. package/resources/reports.d.ts.map +1 -1
  84. package/resources/reports.js +5 -1
  85. package/resources/reports.js.map +1 -1
  86. package/resources/reports.mjs +5 -1
  87. package/resources/reports.mjs.map +1 -1
  88. package/resources/subaccounts.d.ts +19 -7
  89. package/resources/subaccounts.d.ts.map +1 -1
  90. package/resources/subaccounts.js.map +1 -1
  91. package/resources/subaccounts.mjs.map +1 -1
  92. package/resources/webhooksubscription.d.ts +0 -151
  93. package/resources/webhooksubscription.d.ts.map +1 -1
  94. package/resources/webhooksubscription.js +0 -33
  95. package/resources/webhooksubscription.js.map +1 -1
  96. package/resources/webhooksubscription.mjs +0 -33
  97. package/resources/webhooksubscription.mjs.map +1 -1
  98. package/src/index.ts +22 -38
  99. package/src/resources/balance.ts +6 -3
  100. package/src/resources/banks.ts +41 -59
  101. package/src/resources/capabilities.ts +1 -10
  102. package/src/resources/charges.ts +32 -23
  103. package/src/resources/checkoutsession.ts +1399 -1003
  104. package/src/resources/customers.ts +9 -12
  105. package/src/resources/data/accounts.ts +1 -130
  106. package/src/resources/data/balances.ts +1 -53
  107. package/src/resources/data/consent.ts +1 -106
  108. package/src/resources/data/data.ts +10 -46
  109. package/src/resources/data/index.ts +5 -17
  110. package/src/resources/data/session.ts +1 -1295
  111. package/src/resources/data/transactions.ts +1 -67
  112. package/src/resources/index.ts +9 -19
  113. package/src/resources/mandates.ts +82 -17
  114. package/src/resources/orders.ts +1149 -805
  115. package/src/resources/payouts.ts +239 -70
  116. package/src/resources/refunds.ts +33 -94
  117. package/src/resources/reports.ts +8 -98
  118. package/src/resources/subaccounts.ts +36 -7
  119. package/src/resources/webhooksubscription.ts +1 -349
  120. package/src/version.ts +1 -1
  121. package/version.d.ts +1 -1
  122. package/version.js +1 -1
  123. package/version.mjs +1 -1
package/src/index.ts CHANGED
@@ -16,7 +16,7 @@ import {
16
16
  Banks,
17
17
  } from './resources/banks';
18
18
  import { Capabilities, CapabilityRetrieveParams, CapabilityRetrieveResponse } from './resources/capabilities';
19
- import { Charge, ChargeCreateParams, Charges } from './resources/charges';
19
+ import { ChargeCreateParams, ChargeCreateResponse, Charges } from './resources/charges';
20
20
  import {
21
21
  Checkoutsession,
22
22
  CheckoutsessionCreateParams,
@@ -35,8 +35,9 @@ import {
35
35
  } from './resources/customers';
36
36
  import {
37
37
  MandateLookupParams,
38
- MandateResponse,
38
+ MandateLookupResponse,
39
39
  MandateRetrieveParams,
40
+ MandateRetrieveResponse,
40
41
  MandateRevokeParams,
41
42
  MandateRevokeResponse,
42
43
  Mandates,
@@ -50,21 +51,21 @@ import {
50
51
  } from './resources/orders';
51
52
  import {
52
53
  PayoutCreateParams,
54
+ PayoutCreateResponse,
53
55
  PayoutListParams,
54
56
  PayoutListResponse,
55
57
  PayoutRetrieveParams,
58
+ PayoutRetrieveResponse,
56
59
  Payouts,
57
- PublicUserPayout,
58
60
  } from './resources/payouts';
59
61
  import {
60
62
  RefundBatchParams,
61
63
  RefundBatchResponse,
62
64
  RefundCreateParams,
63
- RefundResponse,
65
+ RefundCreateResponse,
64
66
  Refunds,
65
67
  } from './resources/refunds';
66
68
  import {
67
- PayoutReport,
68
69
  ReportCreateParams,
69
70
  ReportCreateResponse,
70
71
  ReportDownloadParams,
@@ -73,24 +74,13 @@ import {
73
74
  Reports,
74
75
  } from './resources/reports';
75
76
  import {
76
- Subaccount,
77
77
  SubaccountCreateParams,
78
+ SubaccountCreateResponse,
78
79
  SubaccountRetrieveParams,
80
+ SubaccountRetrieveResponse,
79
81
  Subaccounts,
80
82
  } 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';
83
+ import { Webhooksubscription } from './resources/webhooksubscription';
94
84
  import { Data } from './resources/data/data';
95
85
 
96
86
  const environments = {
@@ -335,11 +325,16 @@ export declare namespace Ivy {
335
325
  type OrderRetrieveParams as OrderRetrieveParams,
336
326
  };
337
327
 
338
- export { Charges as Charges, type Charge as Charge, type ChargeCreateParams as ChargeCreateParams };
328
+ export {
329
+ Charges as Charges,
330
+ type ChargeCreateResponse as ChargeCreateResponse,
331
+ type ChargeCreateParams as ChargeCreateParams,
332
+ };
339
333
 
340
334
  export {
341
335
  Mandates as Mandates,
342
- type MandateResponse as MandateResponse,
336
+ type MandateRetrieveResponse as MandateRetrieveResponse,
337
+ type MandateLookupResponse as MandateLookupResponse,
343
338
  type MandateRevokeResponse as MandateRevokeResponse,
344
339
  type MandateRetrieveParams as MandateRetrieveParams,
345
340
  type MandateLookupParams as MandateLookupParams,
@@ -354,7 +349,7 @@ export declare namespace Ivy {
354
349
 
355
350
  export {
356
351
  Refunds as Refunds,
357
- type RefundResponse as RefundResponse,
352
+ type RefundCreateResponse as RefundCreateResponse,
358
353
  type RefundBatchResponse as RefundBatchResponse,
359
354
  type RefundCreateParams as RefundCreateParams,
360
355
  type RefundBatchParams as RefundBatchParams,
@@ -362,7 +357,8 @@ export declare namespace Ivy {
362
357
 
363
358
  export {
364
359
  Payouts as Payouts,
365
- type PublicUserPayout as PublicUserPayout,
360
+ type PayoutCreateResponse as PayoutCreateResponse,
361
+ type PayoutRetrieveResponse as PayoutRetrieveResponse,
366
362
  type PayoutListResponse as PayoutListResponse,
367
363
  type PayoutCreateParams as PayoutCreateParams,
368
364
  type PayoutRetrieveParams as PayoutRetrieveParams,
@@ -371,7 +367,6 @@ export declare namespace Ivy {
371
367
 
372
368
  export {
373
369
  Reports as Reports,
374
- type PayoutReport as PayoutReport,
375
370
  type ReportCreateResponse as ReportCreateResponse,
376
371
  type ReportRetrieveResponse as ReportRetrieveResponse,
377
372
  type ReportCreateParams as ReportCreateParams,
@@ -381,7 +376,8 @@ export declare namespace Ivy {
381
376
 
382
377
  export {
383
378
  Subaccounts as Subaccounts,
384
- type Subaccount as Subaccount,
379
+ type SubaccountCreateResponse as SubaccountCreateResponse,
380
+ type SubaccountRetrieveResponse as SubaccountRetrieveResponse,
385
381
  type SubaccountCreateParams as SubaccountCreateParams,
386
382
  type SubaccountRetrieveParams as SubaccountRetrieveParams,
387
383
  };
@@ -392,19 +388,7 @@ export declare namespace Ivy {
392
388
  type BalanceRetrieveParams as BalanceRetrieveParams,
393
389
  };
394
390
 
395
- export {
396
- Webhooksubscription as Webhooksubscription,
397
- type WebhooksubscriptionCreateResponse as WebhooksubscriptionCreateResponse,
398
- type WebhooksubscriptionUpdateResponse as WebhooksubscriptionUpdateResponse,
399
- type WebhooksubscriptionListResponse as WebhooksubscriptionListResponse,
400
- type WebhooksubscriptionDeleteResponse as WebhooksubscriptionDeleteResponse,
401
- type WebhooksubscriptionPingResponse as WebhooksubscriptionPingResponse,
402
- type WebhooksubscriptionCreateParams as WebhooksubscriptionCreateParams,
403
- type WebhooksubscriptionUpdateParams as WebhooksubscriptionUpdateParams,
404
- type WebhooksubscriptionListParams as WebhooksubscriptionListParams,
405
- type WebhooksubscriptionDeleteParams as WebhooksubscriptionDeleteParams,
406
- type WebhooksubscriptionPingParams as WebhooksubscriptionPingParams,
407
- };
391
+ export { Webhooksubscription as Webhooksubscription };
408
392
  }
409
393
 
410
394
  export { toFile, fileFromPath } from './uploads';
@@ -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
 
@@ -38,6 +38,9 @@ export namespace BalanceRetrieveResponse {
38
38
  }
39
39
 
40
40
  export interface BalanceRetrieveParams {
41
+ /**
42
+ * The currency to retrieve the balance for
43
+ */
41
44
  currency: 'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK';
42
45
  }
43
46
 
@@ -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
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,7 +296,7 @@ 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
 
@@ -322,26 +315,26 @@ export interface BankRetrieveResponse {
322
315
  >;
323
316
 
324
317
  /**
325
- * If true, the bank is only available in test (sandbox) mode.
318
+ * Whether the bank is a test bank.
326
319
  */
327
320
  test: boolean;
328
321
 
329
322
  /**
330
- * The capabilities of the bank. The capabilities determine which products the bank
331
- * supports. `ais` for data products, `pis` for payment products.
323
+ * The capabilities of the bank.
332
324
  */
333
- capabilities?: Array<'pis' | 'ais'>;
325
+ capabilities?: Array<'ais' | 'pis'>;
334
326
 
335
- /**
336
- * The group of the bank, e.g. "Sparkasse", i.e. a group of different bank branches
337
- * of the same brand.
338
- */
339
327
  group?: string;
340
328
 
341
329
  /**
342
- * The logo of the bank provided as a URL.
330
+ * The logo in the form of an URL
343
331
  */
344
332
  logo?: string;
333
+
334
+ /**
335
+ * The URL of the bank's website.
336
+ */
337
+ url?: string;
345
338
  }
346
339
 
347
340
  export interface BankListResponse {
@@ -369,24 +362,17 @@ export interface BankListResponse {
369
362
  export namespace BankListResponse {
370
363
  export interface Bank {
371
364
  /**
372
- * Unique identifier for the bank, conforming to the regex pattern
373
- * /^[a-z]{2}-[a-z0-9+/-]{1,}$/. This pattern typically represents a country code
374
- * followed by a bank-specific identifier, e.g.,
375
- * 'de-alxingbruckergenossenschaftsbank'.
365
+ * Unique identifier of the bank.
376
366
  */
377
367
  id: string;
378
368
 
379
369
  currencies: Array<'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK'>;
380
370
 
381
371
  /**
382
- * If true, the bank is part of the set of default banks for a given market.
372
+ * Whether the bank is a default bank.
383
373
  */
384
374
  default: boolean;
385
375
 
386
- /**
387
- * Array of ISO 3166-1 alpha-2 country codes. The markets where the bank is
388
- * available.
389
- */
390
376
  market: Array<
391
377
  | 'AF'
392
378
  | 'AL'
@@ -641,7 +627,7 @@ export namespace BankListResponse {
641
627
  >;
642
628
 
643
629
  /**
644
- * Customer-facing name of the bank.
630
+ * Name of the bank.
645
631
  */
646
632
  name: string;
647
633
 
@@ -660,26 +646,26 @@ export namespace BankListResponse {
660
646
  >;
661
647
 
662
648
  /**
663
- * If true, the bank is only available in test (sandbox) mode.
649
+ * Whether the bank is a test bank.
664
650
  */
665
651
  test: boolean;
666
652
 
667
653
  /**
668
- * The capabilities of the bank. The capabilities determine which products the bank
669
- * supports. `ais` for data products, `pis` for payment products.
654
+ * The capabilities of the bank.
670
655
  */
671
- capabilities?: Array<'pis' | 'ais'>;
656
+ capabilities?: Array<'ais' | 'pis'>;
672
657
 
673
- /**
674
- * The group of the bank, e.g. "Sparkasse", i.e. a group of different bank branches
675
- * of the same brand.
676
- */
677
658
  group?: string;
678
659
 
679
660
  /**
680
- * The logo of the bank provided as a URL.
661
+ * The logo in the form of an URL
681
662
  */
682
663
  logo?: string;
664
+
665
+ /**
666
+ * The URL of the bank's website.
667
+ */
668
+ url?: string;
683
669
  }
684
670
  }
685
671
 
@@ -708,24 +694,17 @@ export interface BankSearchResponse {
708
694
  export namespace BankSearchResponse {
709
695
  export interface Bank {
710
696
  /**
711
- * Unique identifier for the bank, conforming to the regex pattern
712
- * /^[a-z]{2}-[a-z0-9+/-]{1,}$/. This pattern typically represents a country code
713
- * followed by a bank-specific identifier, e.g.,
714
- * 'de-alxingbruckergenossenschaftsbank'.
697
+ * Unique identifier of the bank.
715
698
  */
716
699
  id: string;
717
700
 
718
701
  currencies: Array<'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK'>;
719
702
 
720
703
  /**
721
- * If true, the bank is part of the set of default banks for a given market.
704
+ * Whether the bank is a default bank.
722
705
  */
723
706
  default: boolean;
724
707
 
725
- /**
726
- * Array of ISO 3166-1 alpha-2 country codes. The markets where the bank is
727
- * available.
728
- */
729
708
  market: Array<
730
709
  | 'AF'
731
710
  | 'AL'
@@ -980,7 +959,7 @@ export namespace BankSearchResponse {
980
959
  >;
981
960
 
982
961
  /**
983
- * Customer-facing name of the bank.
962
+ * Name of the bank.
984
963
  */
985
964
  name: string;
986
965
 
@@ -999,30 +978,33 @@ export namespace BankSearchResponse {
999
978
  >;
1000
979
 
1001
980
  /**
1002
- * If true, the bank is only available in test (sandbox) mode.
981
+ * Whether the bank is a test bank.
1003
982
  */
1004
983
  test: boolean;
1005
984
 
1006
985
  /**
1007
- * The capabilities of the bank. The capabilities determine which products the bank
1008
- * supports. `ais` for data products, `pis` for payment products.
986
+ * The capabilities of the bank.
1009
987
  */
1010
- capabilities?: Array<'pis' | 'ais'>;
988
+ capabilities?: Array<'ais' | 'pis'>;
1011
989
 
1012
- /**
1013
- * The group of the bank, e.g. "Sparkasse", i.e. a group of different bank branches
1014
- * of the same brand.
1015
- */
1016
990
  group?: string;
1017
991
 
1018
992
  /**
1019
- * The logo of the bank provided as a URL.
993
+ * The logo in the form of an URL
1020
994
  */
1021
995
  logo?: string;
996
+
997
+ /**
998
+ * The URL of the bank's website.
999
+ */
1000
+ url?: string;
1022
1001
  }
1023
1002
  }
1024
1003
 
1025
1004
  export interface BankRetrieveParams {
1005
+ /**
1006
+ * The id is a unique identifier of the bank within Ivy.
1007
+ */
1026
1008
  id: string;
1027
1009
  }
1028
1010
 
@@ -1307,7 +1289,7 @@ export interface BankListParams {
1307
1289
  /**
1308
1290
  * The internal checkout session id. For internal use only.
1309
1291
  */
1310
- sessionId?: string;
1292
+ sessionId?: unknown;
1311
1293
 
1312
1294
  /**
1313
1295
  * The number of banks to skip
@@ -1603,7 +1585,7 @@ export interface BankSearchParams {
1603
1585
  /**
1604
1586
  * The internal checkout session id. For internal use only.
1605
1587
  */
1606
- sessionId?: string;
1588
+ sessionId?: unknown;
1607
1589
 
1608
1590
  /**
1609
1591
  * The number of banks to skip
@@ -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'
@@ -7,18 +7,30 @@ export class Charges extends APIResource {
7
7
  /**
8
8
  * Creates a Direct Debit Charge with a valid mandate.
9
9
  */
10
- create(body: ChargeCreateParams, options?: Core.RequestOptions): Core.APIPromise<Charge> {
10
+ create(body: ChargeCreateParams, options?: Core.RequestOptions): Core.APIPromise<ChargeCreateResponse> {
11
11
  return this._client.post('/api/service/charge/create', { body, ...options });
12
12
  }
13
13
  }
14
14
 
15
- export interface Charge {
15
+ export interface ChargeCreateResponse {
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
- * @deprecated 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
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,19 +97,8 @@ export namespace ChargeCreateParams {
77
97
 
78
98
  vat?: number;
79
99
  }
80
-
81
- /**
82
- * @deprecated 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 {
94
- export { type Charge as Charge, type ChargeCreateParams as ChargeCreateParams };
103
+ export { type ChargeCreateResponse as ChargeCreateResponse, type ChargeCreateParams as ChargeCreateParams };
95
104
  }