@getivy/node-sdk 0.1.0-alpha.20 → 0.1.0-alpha.21

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.
@@ -4,13 +4,1661 @@ import { APIResource } from '../resource';
4
4
  import * as Core from '../core';
5
5
 
6
6
  export class Orders extends APIResource {
7
+ /**
8
+ * Create a new order
9
+ */
10
+ create(body: OrderCreateParams, options?: Core.RequestOptions): Core.APIPromise<OrderCreateResponse> {
11
+ return this._client.post('/api/service/order/create', { body, ...options });
12
+ }
13
+
7
14
  /**
8
15
  * Retrieve details of an order. You can retrieve the order by passing either the
9
16
  * internal Ivy order id or the `referenceId` you specified when creating a
10
17
  * Checkout Session to the `id` field.
11
18
  */
12
- retrieve(body: OrderRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<OrderRetrieveResponse> {
13
- return this._client.post('/api/service/order/details', { body, ...options });
19
+ retrieve(body: OrderRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<OrderRetrieveResponse> {
20
+ return this._client.post('/api/service/order/details', { body, ...options });
21
+ }
22
+ }
23
+
24
+ export interface OrderCreateResponse {
25
+ /**
26
+ * The Ivy unique identifier for the order.
27
+ */
28
+ id: string;
29
+
30
+ /**
31
+ * @deprecated The unique identifier for the merchantApp which initiated the order
32
+ * / payment attempt.
33
+ */
34
+ appId: string;
35
+
36
+ /**
37
+ * The Ivy fee for the payment.
38
+ */
39
+ applicationFeeAmount: number;
40
+
41
+ createdAt: string;
42
+
43
+ instantPaymentScheme: boolean;
44
+
45
+ /**
46
+ * @deprecated Deprecated in favor of `appId`.
47
+ */
48
+ merchantAppId: string;
49
+
50
+ /**
51
+ * The unique identifier for the merchant which initiated the order / payment
52
+ * attempt.
53
+ */
54
+ merchantId: string;
55
+
56
+ /**
57
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
58
+ * represents EUR 10.23. Any amount of decimal places can be provided on
59
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
60
+ * as this is the format accepted by most banks.
61
+ */
62
+ price: OrderCreateResponse.Price;
63
+
64
+ /**
65
+ * An internal reference id which will be stored with the checkout & corresponding
66
+ * order. Needs to be unique per shop per order and can be up to 200 characters.
67
+ */
68
+ referenceId: string;
69
+
70
+ /**
71
+ * The name of the merchant which initiated the order.
72
+ */
73
+ shopName: string;
74
+
75
+ /**
76
+ * The order status. This status symbolises the state of the user's payment
77
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
78
+ * information.
79
+ */
80
+ status:
81
+ | 'failed'
82
+ | 'canceled'
83
+ | 'processing'
84
+ | 'waiting_for_payment'
85
+ | 'paid'
86
+ | 'in_refund'
87
+ | 'refunded'
88
+ | 'refund_failed'
89
+ | 'partially_refunded'
90
+ | 'in_dispute'
91
+ | 'disputed'
92
+ | 'refused';
93
+
94
+ updatedAt: string;
95
+
96
+ /**
97
+ * The unique identifier of Ivy of the chosen bank to make the payment. Not there,
98
+ * if no payment was made.
99
+ */
100
+ bankId?: string;
101
+
102
+ /**
103
+ * @deprecated The bank statement reference of the payment for the order. This is
104
+ * the reference that will be visible on the bank statement.
105
+ */
106
+ bankStatementReference?: string;
107
+
108
+ /**
109
+ * The billing address of the user. Required when handshake=true.
110
+ */
111
+ billingAddress?: OrderCreateResponse.BillingAddress;
112
+
113
+ /**
114
+ * The merchant category code or
115
+ * [MCC](https://en.wikipedia.org/wiki/Merchant_category_code).
116
+ */
117
+ category?: string;
118
+
119
+ /**
120
+ * @deprecated
121
+ */
122
+ climateActionMode?: OrderCreateResponse.ClimateActionMode;
123
+
124
+ /**
125
+ * @deprecated
126
+ */
127
+ co2Grams?: number;
128
+
129
+ /**
130
+ * The unique identifier of the customer who placed the order.
131
+ */
132
+ customerId?: string;
133
+
134
+ destination?: OrderCreateResponse.Destination;
135
+
136
+ /**
137
+ * The customer facing id. This id is displayed to the user during the checkout and
138
+ * in the merchant dashboard.
139
+ */
140
+ displayId?: string;
141
+
142
+ /**
143
+ * False by default. If set to true, customers skip email input and jump directly
144
+ * to their bank login. For express Checkout Sessions this is always false.
145
+ */
146
+ guest?: boolean;
147
+
148
+ /**
149
+ * Only valid for sustainable incentive mode. The social / sustainable projects
150
+ * available to the user during Checkout.
151
+ */
152
+ impactOffsetProjects?: Array<string>;
153
+
154
+ /**
155
+ * The incentive mode of the checkout session. For any use-case apart from
156
+ * e-commerce, please use `white_label` as the value. If set to `white_label`, the
157
+ * checkout session will be white labeled. If set to `sustainable`, the checkout
158
+ * session will contain sustainable incentives for users.
159
+ */
160
+ incentiveMode?: 'white_label' | 'sustainable';
161
+
162
+ /**
163
+ * The line items of the Checkout.
164
+ */
165
+ lineItems?: Array<OrderCreateResponse.LineItem>;
166
+
167
+ mandate?: OrderCreateResponse.Mandate;
168
+
169
+ /**
170
+ * @deprecated
171
+ */
172
+ merchantFinancialAddress?: OrderCreateResponse.MerchantFinancialAddress;
173
+
174
+ /**
175
+ * Any data which will be stored and returned for this checkout session and
176
+ * corresponding order. See [here](https://docs.getivy.de/reference/metadata) for
177
+ * more info.
178
+ */
179
+ metadata?: Record<string, unknown>;
180
+
181
+ /**
182
+ * Only valid for sustainable incentive mode. The social / sustainability project
183
+ * chosen by the user during Checkout.
184
+ */
185
+ offsetProject?: string;
186
+
187
+ /**
188
+ * The source bank account where the money is send from.
189
+ */
190
+ payerFinancialAddress?: OrderCreateResponse.PayerFinancialAddress;
191
+
192
+ paymentMethodType?: 'sepa_debit' | 'customer_balance' | 'manual_bank_transfer';
193
+
194
+ /**
195
+ * The payment mode of the order. Can be either 'settlement' or 'direct'.
196
+ */
197
+ paymentMode?: 'settlement' | 'direct';
198
+
199
+ /**
200
+ * @deprecated Deprecated in favor of `status`. Do not use this field to trigger
201
+ * actions in your system.
202
+ */
203
+ paymentStatus?:
204
+ | 'failed'
205
+ | 'canceled'
206
+ | 'processing'
207
+ | 'requires_action'
208
+ | 'succeeded'
209
+ | 'in_refund'
210
+ | 'refunded'
211
+ | 'refund_failed'
212
+ | 'partially_refunded'
213
+ | 'not_settled'
214
+ | 'disputed'
215
+ | 'frozen_due_to_aml';
216
+
217
+ /**
218
+ * The total amount in the currency of all successful refunds for this order
219
+ */
220
+ refundAmount?: number;
221
+
222
+ /**
223
+ * The list of refunds connected to this order.
224
+ */
225
+ refunds?: Array<OrderCreateResponse.Refund>;
226
+
227
+ /**
228
+ * The shipping address of the user. This is only collected in express Checkouts.
229
+ */
230
+ shippingAddress?: OrderCreateResponse.ShippingAddress;
231
+
232
+ /**
233
+ * The selected shipping method by the user. Can either be selected during an
234
+ * express Checkout Session or passed during Checkout Session creation.
235
+ */
236
+ shippingMethod?: OrderCreateResponse.ShippingMethod;
237
+
238
+ /**
239
+ * The logo of the shop provided as a URL.
240
+ */
241
+ shopLogo?: string;
242
+
243
+ /**
244
+ * The shopper object. Contains information collected from the user during the
245
+ * Checkout.
246
+ */
247
+ shopper?: OrderCreateResponse.Shopper;
248
+
249
+ /**
250
+ * @deprecated Deprecated in favor of `shopper.email`. The email of the user if
251
+ * collected in the Checkout.
252
+ */
253
+ shopperEmail?: string;
254
+
255
+ statusClassification?: OrderCreateResponse.StatusClassification;
256
+
257
+ /**
258
+ * List of status history items for the order, used for logging every update on
259
+ * status.
260
+ */
261
+ statusHistoryList?: Array<OrderCreateResponse.StatusHistoryList>;
262
+
263
+ /**
264
+ * The subaccount id of the order.
265
+ */
266
+ subaccountId?: string;
267
+
268
+ /**
269
+ * The legal name of the subaccount
270
+ */
271
+ subaccountLegalName?: string;
272
+
273
+ /**
274
+ * @deprecated
275
+ */
276
+ trees?: number;
277
+ }
278
+
279
+ export namespace OrderCreateResponse {
280
+ /**
281
+ * The amount to be paid by the user. The amounts is in decimals, i.e. 10.23
282
+ * represents EUR 10.23. Any amount of decimal places can be provided on
283
+ * initialization, but the actual transfer amount is rounded to 2 decimal places,
284
+ * as this is the format accepted by most banks.
285
+ */
286
+ export interface Price {
287
+ currency: 'EUR' | 'GBP' | 'PLN';
288
+
289
+ /**
290
+ * The total amount to be paid.
291
+ */
292
+ total: number;
293
+
294
+ shipping?: number;
295
+
296
+ subTotal?: number;
297
+
298
+ totalNet?: number;
299
+
300
+ vat?: number;
301
+ }
302
+
303
+ /**
304
+ * The billing address of the user. Required when handshake=true.
305
+ */
306
+ export interface BillingAddress {
307
+ city: string;
308
+
309
+ /**
310
+ * The country code in
311
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
312
+ */
313
+ country:
314
+ | 'AF'
315
+ | 'AL'
316
+ | 'DZ'
317
+ | 'AS'
318
+ | 'AD'
319
+ | 'AO'
320
+ | 'AI'
321
+ | 'AQ'
322
+ | 'AG'
323
+ | 'AR'
324
+ | 'AM'
325
+ | 'AW'
326
+ | 'AU'
327
+ | 'AT'
328
+ | 'AZ'
329
+ | 'BS'
330
+ | 'BH'
331
+ | 'BD'
332
+ | 'BB'
333
+ | 'BY'
334
+ | 'BE'
335
+ | 'BZ'
336
+ | 'BJ'
337
+ | 'BM'
338
+ | 'BT'
339
+ | 'BO'
340
+ | 'BA'
341
+ | 'BW'
342
+ | 'BV'
343
+ | 'BR'
344
+ | 'IO'
345
+ | 'BN'
346
+ | 'BG'
347
+ | 'BF'
348
+ | 'BI'
349
+ | 'KH'
350
+ | 'CM'
351
+ | 'CA'
352
+ | 'CV'
353
+ | 'KY'
354
+ | 'CF'
355
+ | 'TD'
356
+ | 'CL'
357
+ | 'CN'
358
+ | 'CX'
359
+ | 'CC'
360
+ | 'CO'
361
+ | 'KM'
362
+ | 'CG'
363
+ | 'CD'
364
+ | 'CK'
365
+ | 'CR'
366
+ | 'CI'
367
+ | 'HR'
368
+ | 'CU'
369
+ | 'CY'
370
+ | 'CZ'
371
+ | 'DK'
372
+ | 'DJ'
373
+ | 'DM'
374
+ | 'DO'
375
+ | 'EC'
376
+ | 'EG'
377
+ | 'SV'
378
+ | 'GQ'
379
+ | 'ER'
380
+ | 'EE'
381
+ | 'ET'
382
+ | 'FK'
383
+ | 'FO'
384
+ | 'FJ'
385
+ | 'FI'
386
+ | 'FR'
387
+ | 'GF'
388
+ | 'PF'
389
+ | 'TF'
390
+ | 'GA'
391
+ | 'GM'
392
+ | 'GE'
393
+ | 'DE'
394
+ | 'GH'
395
+ | 'GI'
396
+ | 'GR'
397
+ | 'GL'
398
+ | 'GD'
399
+ | 'GP'
400
+ | 'GU'
401
+ | 'GT'
402
+ | 'GN'
403
+ | 'GW'
404
+ | 'GY'
405
+ | 'HT'
406
+ | 'HM'
407
+ | 'VA'
408
+ | 'HN'
409
+ | 'HK'
410
+ | 'HU'
411
+ | 'IS'
412
+ | 'IN'
413
+ | 'ID'
414
+ | 'IR'
415
+ | 'IQ'
416
+ | 'IE'
417
+ | 'IL'
418
+ | 'IT'
419
+ | 'JM'
420
+ | 'JP'
421
+ | 'JO'
422
+ | 'KZ'
423
+ | 'KE'
424
+ | 'KI'
425
+ | 'KP'
426
+ | 'KR'
427
+ | 'KW'
428
+ | 'KG'
429
+ | 'LA'
430
+ | 'LV'
431
+ | 'LB'
432
+ | 'LS'
433
+ | 'LR'
434
+ | 'LY'
435
+ | 'LI'
436
+ | 'LT'
437
+ | 'LU'
438
+ | 'MO'
439
+ | 'MG'
440
+ | 'MW'
441
+ | 'MY'
442
+ | 'MV'
443
+ | 'ML'
444
+ | 'MT'
445
+ | 'MH'
446
+ | 'MQ'
447
+ | 'MR'
448
+ | 'MU'
449
+ | 'YT'
450
+ | 'MX'
451
+ | 'FM'
452
+ | 'MD'
453
+ | 'MC'
454
+ | 'MN'
455
+ | 'MS'
456
+ | 'MA'
457
+ | 'MZ'
458
+ | 'MM'
459
+ | 'NA'
460
+ | 'NR'
461
+ | 'NP'
462
+ | 'NL'
463
+ | 'NC'
464
+ | 'NZ'
465
+ | 'NI'
466
+ | 'NE'
467
+ | 'NG'
468
+ | 'NU'
469
+ | 'NF'
470
+ | 'MP'
471
+ | 'MK'
472
+ | 'NO'
473
+ | 'OM'
474
+ | 'PK'
475
+ | 'PW'
476
+ | 'PS'
477
+ | 'PA'
478
+ | 'PG'
479
+ | 'PY'
480
+ | 'PE'
481
+ | 'PH'
482
+ | 'PN'
483
+ | 'PL'
484
+ | 'PT'
485
+ | 'PR'
486
+ | 'QA'
487
+ | 'RE'
488
+ | 'RO'
489
+ | 'RU'
490
+ | 'RW'
491
+ | 'SH'
492
+ | 'KN'
493
+ | 'LC'
494
+ | 'PM'
495
+ | 'VC'
496
+ | 'WS'
497
+ | 'SM'
498
+ | 'ST'
499
+ | 'SA'
500
+ | 'SN'
501
+ | 'SC'
502
+ | 'SL'
503
+ | 'SG'
504
+ | 'SK'
505
+ | 'SI'
506
+ | 'SB'
507
+ | 'SO'
508
+ | 'ZA'
509
+ | 'GS'
510
+ | 'ES'
511
+ | 'LK'
512
+ | 'SD'
513
+ | 'SR'
514
+ | 'SJ'
515
+ | 'SZ'
516
+ | 'SE'
517
+ | 'CH'
518
+ | 'SY'
519
+ | 'TW'
520
+ | 'TJ'
521
+ | 'TZ'
522
+ | 'TH'
523
+ | 'TL'
524
+ | 'TG'
525
+ | 'TK'
526
+ | 'TO'
527
+ | 'TT'
528
+ | 'TN'
529
+ | 'TR'
530
+ | 'TM'
531
+ | 'TC'
532
+ | 'TV'
533
+ | 'UG'
534
+ | 'UA'
535
+ | 'AE'
536
+ | 'GB'
537
+ | 'US'
538
+ | 'UM'
539
+ | 'UY'
540
+ | 'UZ'
541
+ | 'VU'
542
+ | 'VE'
543
+ | 'VN'
544
+ | 'VG'
545
+ | 'VI'
546
+ | 'WF'
547
+ | 'EH'
548
+ | 'YE'
549
+ | 'ZM'
550
+ | 'ZW'
551
+ | 'AX'
552
+ | 'BQ'
553
+ | 'CW'
554
+ | 'GG'
555
+ | 'IM'
556
+ | 'JE'
557
+ | 'ME'
558
+ | 'BL'
559
+ | 'MF'
560
+ | 'RS'
561
+ | 'SX'
562
+ | 'SS'
563
+ | 'XK';
564
+
565
+ line1: string;
566
+
567
+ zipCode: string;
568
+
569
+ firstName?: string;
570
+
571
+ lastName?: string;
572
+
573
+ line2?: string;
574
+
575
+ region?: string;
576
+ }
577
+
578
+ /**
579
+ * @deprecated
580
+ */
581
+ export interface ClimateActionMode {
582
+ amount: number;
583
+
584
+ type: 'transaction' | 'amount';
585
+ }
586
+
587
+ export interface Destination {
588
+ /**
589
+ * The validation logic is based on the "type" field. For example, if "type" is set
590
+ * to "iban", the "iban" object must be filled out.
591
+ */
592
+ bankAccount: Destination.BankAccount;
593
+
594
+ /**
595
+ * The bank statement reference of the payment for the order. This is the reference
596
+ * that will be visible on the bank statement.
597
+ */
598
+ bankStatementReference: string;
599
+ }
600
+
601
+ export namespace Destination {
602
+ /**
603
+ * The validation logic is based on the "type" field. For example, if "type" is set
604
+ * to "iban", the "iban" object must be filled out.
605
+ */
606
+ export interface BankAccount {
607
+ /**
608
+ * The type of the financial address. The actual destination is determined by this
609
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
610
+ * validation will fail if you set e.g. type="iban", but then not fill any values
611
+ * in the "iban" object.
612
+ *
613
+ * - iban: The IBAN of the account
614
+ * - sort_code: The sort code of the account
615
+ * - bank_code: The bank code of the account
616
+ * - bban: The BBAN of the account
617
+ */
618
+ type: string;
619
+
620
+ bankCode?: BankAccount.BankCode;
621
+
622
+ bban?: BankAccount.Bban;
623
+
624
+ iban?: BankAccount.Iban;
625
+
626
+ sortCode?: BankAccount.SortCode;
627
+ }
628
+
629
+ export namespace BankAccount {
630
+ export interface BankCode {
631
+ /**
632
+ * The name of the account holder.
633
+ */
634
+ accountHolderName: string;
635
+
636
+ accountNumber: string;
637
+
638
+ code: string;
639
+ }
640
+
641
+ export interface Bban {
642
+ /**
643
+ * The name of the account holder.
644
+ */
645
+ accountHolderName: string;
646
+
647
+ bban: string;
648
+
649
+ bic?: string;
650
+ }
651
+
652
+ export interface Iban {
653
+ /**
654
+ * The name of the account holder.
655
+ */
656
+ accountHolderName: string;
657
+
658
+ iban: string;
659
+
660
+ bic?: string;
661
+ }
662
+
663
+ export interface SortCode {
664
+ /**
665
+ * The name of the account holder.
666
+ */
667
+ accountHolderName: string;
668
+
669
+ accountNumber: string;
670
+
671
+ sortCode: string;
672
+ }
673
+ }
674
+ }
675
+
676
+ export interface LineItem {
677
+ /**
678
+ * The total amount of all line items, i.e. single amount \* quantity. Given in
679
+ * decimals, i.e. 10.23 represents EUR 10.23.
680
+ */
681
+ amount: number;
682
+
683
+ /**
684
+ * The name of the line item.
685
+ */
686
+ name: string;
687
+
688
+ /**
689
+ * The quantity of the line item.
690
+ */
691
+ quantity: number;
692
+
693
+ /**
694
+ * The net amount of a single item.
695
+ */
696
+ singleNet: number;
697
+
698
+ /**
699
+ * The VAT amount of a single item.
700
+ */
701
+ singleVat: number;
702
+
703
+ /**
704
+ * The category as [MCC](https://en.wikipedia.org/wiki/Merchant_category_code) of
705
+ * the line item.
706
+ */
707
+ category?: string;
708
+
709
+ /**
710
+ * The
711
+ * [EAN](https://en.wikipedia.org/wiki/International_Article_Number#:~:text=The%20International%20Article%20Number%20(also,configuration%2C%20from%20a%20specific%20manufacturer.)
712
+ * of the line item.
713
+ */
714
+ EAN?: string;
715
+
716
+ /**
717
+ * The image of the line item as a URL.
718
+ */
719
+ image?: string;
720
+
721
+ /**
722
+ * The internal unique identifier of the line item.
723
+ */
724
+ referenceId?: string;
725
+ }
726
+
727
+ export interface Mandate {
728
+ /**
729
+ * The name of the account holder who signs the mandate.
730
+ */
731
+ accountHolderName?: string;
732
+
733
+ /**
734
+ * Additional information to display to the user during the mandate setup. This
735
+ * information is not used to setup any recurrence on the mandate. It is only
736
+ * displayed to the user during checkout.
737
+ */
738
+ additionalDisplayInformation?: Mandate.AdditionalDisplayInformation;
739
+
740
+ /**
741
+ * Mandate creditor data
742
+ */
743
+ creditor?: Mandate.Creditor;
744
+
745
+ /**
746
+ * The reference of the mandate going to be setup
747
+ */
748
+ reference?: string;
749
+
750
+ /**
751
+ * The mandate referenceId. Set this to match incoming `mandate_setup_started`,
752
+ * `mandate_setup_succeeded` or `mandate_setup_failed` webhook events to your
753
+ * mandate setup request.
754
+ */
755
+ referenceId?: string;
756
+
757
+ /**
758
+ * If true, a ready to use mandate will be set up after the payment flow.
759
+ */
760
+ setup?: boolean;
761
+
762
+ /**
763
+ * The email of the user who signs the mandate.
764
+ */
765
+ userNotificationEmail?: string;
766
+ }
767
+
768
+ export namespace Mandate {
769
+ /**
770
+ * Additional information to display to the user during the mandate setup. This
771
+ * information is not used to setup any recurrence on the mandate. It is only
772
+ * displayed to the user during checkout.
773
+ */
774
+ export interface AdditionalDisplayInformation {
775
+ /**
776
+ * The intended cadence of charges used for displaying purpose only. On demand
777
+ * would be used for unscheduled charges.
778
+ */
779
+ cadence?: 'BI_WEEKLY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUAL' | 'ANNUAL' | 'ON_DEMAND';
780
+
781
+ price?: AdditionalDisplayInformation.Price;
782
+ }
783
+
784
+ export namespace AdditionalDisplayInformation {
785
+ export interface Price {
786
+ /**
787
+ * The amount displayed to the user as decimal e.g. 10.23 would be displayed as
788
+ * 10.23 EUR.
789
+ */
790
+ amount?: number;
791
+
792
+ currency?: 'EUR' | 'GBP' | 'PLN';
793
+ }
794
+ }
795
+
796
+ /**
797
+ * Mandate creditor data
798
+ */
799
+ export interface Creditor {
800
+ id?: string;
801
+
802
+ name?: string;
803
+ }
804
+ }
805
+
806
+ /**
807
+ * @deprecated
808
+ */
809
+ export interface MerchantFinancialAddress {
810
+ bankCode?: MerchantFinancialAddress.BankCode;
811
+
812
+ bban?: MerchantFinancialAddress.Bban;
813
+
814
+ iban?: MerchantFinancialAddress.Iban;
815
+
816
+ /**
817
+ * The payment reference for the order. This is the reference that will be visible
818
+ * on the bank statement.
819
+ */
820
+ paymentReference?: string;
821
+
822
+ sortCode?: MerchantFinancialAddress.SortCode;
823
+
824
+ /**
825
+ * The type of the financial address. The actual destination is determined by this
826
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
827
+ * validation will fail if you set e.g. type="iban", but then not fill any values
828
+ * in the "iban" object.
829
+ *
830
+ * - iban: The IBAN of the account
831
+ * - sort_code: The sort code of the account
832
+ * - bank_code: The bank code of the account
833
+ * - bban: The BBAN of the account
834
+ */
835
+ type?: string;
836
+ }
837
+
838
+ export namespace MerchantFinancialAddress {
839
+ export interface BankCode {
840
+ /**
841
+ * The name of the account holder.
842
+ */
843
+ accountHolderName: string;
844
+
845
+ accountNumber: string;
846
+
847
+ code: string;
848
+ }
849
+
850
+ export interface Bban {
851
+ /**
852
+ * The name of the account holder.
853
+ */
854
+ accountHolderName: string;
855
+
856
+ bban: string;
857
+
858
+ bic?: string;
859
+ }
860
+
861
+ export interface Iban {
862
+ /**
863
+ * The name of the account holder.
864
+ */
865
+ accountHolderName: string;
866
+
867
+ iban: string;
868
+
869
+ bic?: string;
870
+ }
871
+
872
+ export interface SortCode {
873
+ /**
874
+ * The name of the account holder.
875
+ */
876
+ accountHolderName: string;
877
+
878
+ accountNumber: string;
879
+
880
+ sortCode: string;
881
+ }
882
+ }
883
+
884
+ /**
885
+ * The source bank account where the money is send from.
886
+ */
887
+ export interface PayerFinancialAddress {
888
+ /**
889
+ * The type of the financial address. The actual destination is determined by this
890
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
891
+ * validation will fail if you set e.g. type="iban", but then not fill any values
892
+ * in the "iban" object.
893
+ *
894
+ * - iban: The IBAN of the account
895
+ * - sort_code: The sort code of the account
896
+ * - bank_code: The bank code of the account
897
+ * - bban: The BBAN of the account
898
+ */
899
+ type: string;
900
+
901
+ bankCode?: PayerFinancialAddress.BankCode;
902
+
903
+ bban?: PayerFinancialAddress.Bban;
904
+
905
+ iban?: PayerFinancialAddress.Iban;
906
+
907
+ sortCode?: PayerFinancialAddress.SortCode;
908
+ }
909
+
910
+ export namespace PayerFinancialAddress {
911
+ export interface BankCode {
912
+ accountNumber: string;
913
+
914
+ code: string;
915
+
916
+ /**
917
+ * The name of the account holder.
918
+ */
919
+ accountHolderName?: string;
920
+ }
921
+
922
+ export interface Bban {
923
+ bban: string;
924
+
925
+ /**
926
+ * The name of the account holder.
927
+ */
928
+ accountHolderName?: string;
929
+
930
+ bic?: string;
931
+ }
932
+
933
+ export interface Iban {
934
+ iban: string;
935
+
936
+ /**
937
+ * The name of the account holder.
938
+ */
939
+ accountHolderName?: string;
940
+
941
+ bic?: string;
942
+ }
943
+
944
+ export interface SortCode {
945
+ accountNumber: string;
946
+
947
+ sortCode: string;
948
+
949
+ /**
950
+ * The name of the account holder.
951
+ */
952
+ accountHolderName?: string;
953
+ }
954
+ }
955
+
956
+ /**
957
+ * A Refund object. This corresponds to one Refund request.
958
+ */
959
+ export interface Refund {
960
+ id: string;
961
+
962
+ amount: number;
963
+
964
+ createdAt: string;
965
+
966
+ referenceId: string;
967
+
968
+ /**
969
+ * The status of the refund. Always use the status of the order as your source of
970
+ * truth to trigger actions in your dashboard.
971
+ */
972
+ status: 'pending' | 'succeeded' | 'failed' | 'requires_action' | 'partially_refunded';
973
+
974
+ updatedAt: string;
975
+
976
+ description?: string;
977
+ }
978
+
979
+ /**
980
+ * The shipping address of the user. This is only collected in express Checkouts.
981
+ */
982
+ export interface ShippingAddress {
983
+ city: string;
984
+
985
+ /**
986
+ * The country code in
987
+ * [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
988
+ */
989
+ country:
990
+ | 'AF'
991
+ | 'AL'
992
+ | 'DZ'
993
+ | 'AS'
994
+ | 'AD'
995
+ | 'AO'
996
+ | 'AI'
997
+ | 'AQ'
998
+ | 'AG'
999
+ | 'AR'
1000
+ | 'AM'
1001
+ | 'AW'
1002
+ | 'AU'
1003
+ | 'AT'
1004
+ | 'AZ'
1005
+ | 'BS'
1006
+ | 'BH'
1007
+ | 'BD'
1008
+ | 'BB'
1009
+ | 'BY'
1010
+ | 'BE'
1011
+ | 'BZ'
1012
+ | 'BJ'
1013
+ | 'BM'
1014
+ | 'BT'
1015
+ | 'BO'
1016
+ | 'BA'
1017
+ | 'BW'
1018
+ | 'BV'
1019
+ | 'BR'
1020
+ | 'IO'
1021
+ | 'BN'
1022
+ | 'BG'
1023
+ | 'BF'
1024
+ | 'BI'
1025
+ | 'KH'
1026
+ | 'CM'
1027
+ | 'CA'
1028
+ | 'CV'
1029
+ | 'KY'
1030
+ | 'CF'
1031
+ | 'TD'
1032
+ | 'CL'
1033
+ | 'CN'
1034
+ | 'CX'
1035
+ | 'CC'
1036
+ | 'CO'
1037
+ | 'KM'
1038
+ | 'CG'
1039
+ | 'CD'
1040
+ | 'CK'
1041
+ | 'CR'
1042
+ | 'CI'
1043
+ | 'HR'
1044
+ | 'CU'
1045
+ | 'CY'
1046
+ | 'CZ'
1047
+ | 'DK'
1048
+ | 'DJ'
1049
+ | 'DM'
1050
+ | 'DO'
1051
+ | 'EC'
1052
+ | 'EG'
1053
+ | 'SV'
1054
+ | 'GQ'
1055
+ | 'ER'
1056
+ | 'EE'
1057
+ | 'ET'
1058
+ | 'FK'
1059
+ | 'FO'
1060
+ | 'FJ'
1061
+ | 'FI'
1062
+ | 'FR'
1063
+ | 'GF'
1064
+ | 'PF'
1065
+ | 'TF'
1066
+ | 'GA'
1067
+ | 'GM'
1068
+ | 'GE'
1069
+ | 'DE'
1070
+ | 'GH'
1071
+ | 'GI'
1072
+ | 'GR'
1073
+ | 'GL'
1074
+ | 'GD'
1075
+ | 'GP'
1076
+ | 'GU'
1077
+ | 'GT'
1078
+ | 'GN'
1079
+ | 'GW'
1080
+ | 'GY'
1081
+ | 'HT'
1082
+ | 'HM'
1083
+ | 'VA'
1084
+ | 'HN'
1085
+ | 'HK'
1086
+ | 'HU'
1087
+ | 'IS'
1088
+ | 'IN'
1089
+ | 'ID'
1090
+ | 'IR'
1091
+ | 'IQ'
1092
+ | 'IE'
1093
+ | 'IL'
1094
+ | 'IT'
1095
+ | 'JM'
1096
+ | 'JP'
1097
+ | 'JO'
1098
+ | 'KZ'
1099
+ | 'KE'
1100
+ | 'KI'
1101
+ | 'KP'
1102
+ | 'KR'
1103
+ | 'KW'
1104
+ | 'KG'
1105
+ | 'LA'
1106
+ | 'LV'
1107
+ | 'LB'
1108
+ | 'LS'
1109
+ | 'LR'
1110
+ | 'LY'
1111
+ | 'LI'
1112
+ | 'LT'
1113
+ | 'LU'
1114
+ | 'MO'
1115
+ | 'MG'
1116
+ | 'MW'
1117
+ | 'MY'
1118
+ | 'MV'
1119
+ | 'ML'
1120
+ | 'MT'
1121
+ | 'MH'
1122
+ | 'MQ'
1123
+ | 'MR'
1124
+ | 'MU'
1125
+ | 'YT'
1126
+ | 'MX'
1127
+ | 'FM'
1128
+ | 'MD'
1129
+ | 'MC'
1130
+ | 'MN'
1131
+ | 'MS'
1132
+ | 'MA'
1133
+ | 'MZ'
1134
+ | 'MM'
1135
+ | 'NA'
1136
+ | 'NR'
1137
+ | 'NP'
1138
+ | 'NL'
1139
+ | 'NC'
1140
+ | 'NZ'
1141
+ | 'NI'
1142
+ | 'NE'
1143
+ | 'NG'
1144
+ | 'NU'
1145
+ | 'NF'
1146
+ | 'MP'
1147
+ | 'MK'
1148
+ | 'NO'
1149
+ | 'OM'
1150
+ | 'PK'
1151
+ | 'PW'
1152
+ | 'PS'
1153
+ | 'PA'
1154
+ | 'PG'
1155
+ | 'PY'
1156
+ | 'PE'
1157
+ | 'PH'
1158
+ | 'PN'
1159
+ | 'PL'
1160
+ | 'PT'
1161
+ | 'PR'
1162
+ | 'QA'
1163
+ | 'RE'
1164
+ | 'RO'
1165
+ | 'RU'
1166
+ | 'RW'
1167
+ | 'SH'
1168
+ | 'KN'
1169
+ | 'LC'
1170
+ | 'PM'
1171
+ | 'VC'
1172
+ | 'WS'
1173
+ | 'SM'
1174
+ | 'ST'
1175
+ | 'SA'
1176
+ | 'SN'
1177
+ | 'SC'
1178
+ | 'SL'
1179
+ | 'SG'
1180
+ | 'SK'
1181
+ | 'SI'
1182
+ | 'SB'
1183
+ | 'SO'
1184
+ | 'ZA'
1185
+ | 'GS'
1186
+ | 'ES'
1187
+ | 'LK'
1188
+ | 'SD'
1189
+ | 'SR'
1190
+ | 'SJ'
1191
+ | 'SZ'
1192
+ | 'SE'
1193
+ | 'CH'
1194
+ | 'SY'
1195
+ | 'TW'
1196
+ | 'TJ'
1197
+ | 'TZ'
1198
+ | 'TH'
1199
+ | 'TL'
1200
+ | 'TG'
1201
+ | 'TK'
1202
+ | 'TO'
1203
+ | 'TT'
1204
+ | 'TN'
1205
+ | 'TR'
1206
+ | 'TM'
1207
+ | 'TC'
1208
+ | 'TV'
1209
+ | 'UG'
1210
+ | 'UA'
1211
+ | 'AE'
1212
+ | 'GB'
1213
+ | 'US'
1214
+ | 'UM'
1215
+ | 'UY'
1216
+ | 'UZ'
1217
+ | 'VU'
1218
+ | 'VE'
1219
+ | 'VN'
1220
+ | 'VG'
1221
+ | 'VI'
1222
+ | 'WF'
1223
+ | 'EH'
1224
+ | 'YE'
1225
+ | 'ZM'
1226
+ | 'ZW'
1227
+ | 'AX'
1228
+ | 'BQ'
1229
+ | 'CW'
1230
+ | 'GG'
1231
+ | 'IM'
1232
+ | 'JE'
1233
+ | 'ME'
1234
+ | 'BL'
1235
+ | 'MF'
1236
+ | 'RS'
1237
+ | 'SX'
1238
+ | 'SS'
1239
+ | 'XK';
1240
+
1241
+ line1: string;
1242
+
1243
+ zipCode: string;
1244
+
1245
+ firstName?: string;
1246
+
1247
+ lastName?: string;
1248
+
1249
+ line2?: string;
1250
+
1251
+ region?: string;
1252
+ }
1253
+
1254
+ /**
1255
+ * The selected shipping method by the user. Can either be selected during an
1256
+ * express Checkout Session or passed during Checkout Session creation.
1257
+ */
1258
+ export interface ShippingMethod {
1259
+ /**
1260
+ * The customer-facing name of the shipping method.
1261
+ */
1262
+ name: string;
1263
+
1264
+ /**
1265
+ * The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
1266
+ */
1267
+ price: number;
1268
+
1269
+ /**
1270
+ * The unique identifier of the shipping method within Ivy.
1271
+ */
1272
+ id?: string;
1273
+
1274
+ /**
1275
+ * The list of countries where the shipping method is available.
1276
+ */
1277
+ countries?: Array<
1278
+ | 'AF'
1279
+ | 'AL'
1280
+ | 'DZ'
1281
+ | 'AS'
1282
+ | 'AD'
1283
+ | 'AO'
1284
+ | 'AI'
1285
+ | 'AQ'
1286
+ | 'AG'
1287
+ | 'AR'
1288
+ | 'AM'
1289
+ | 'AW'
1290
+ | 'AU'
1291
+ | 'AT'
1292
+ | 'AZ'
1293
+ | 'BS'
1294
+ | 'BH'
1295
+ | 'BD'
1296
+ | 'BB'
1297
+ | 'BY'
1298
+ | 'BE'
1299
+ | 'BZ'
1300
+ | 'BJ'
1301
+ | 'BM'
1302
+ | 'BT'
1303
+ | 'BO'
1304
+ | 'BA'
1305
+ | 'BW'
1306
+ | 'BV'
1307
+ | 'BR'
1308
+ | 'IO'
1309
+ | 'BN'
1310
+ | 'BG'
1311
+ | 'BF'
1312
+ | 'BI'
1313
+ | 'KH'
1314
+ | 'CM'
1315
+ | 'CA'
1316
+ | 'CV'
1317
+ | 'KY'
1318
+ | 'CF'
1319
+ | 'TD'
1320
+ | 'CL'
1321
+ | 'CN'
1322
+ | 'CX'
1323
+ | 'CC'
1324
+ | 'CO'
1325
+ | 'KM'
1326
+ | 'CG'
1327
+ | 'CD'
1328
+ | 'CK'
1329
+ | 'CR'
1330
+ | 'CI'
1331
+ | 'HR'
1332
+ | 'CU'
1333
+ | 'CY'
1334
+ | 'CZ'
1335
+ | 'DK'
1336
+ | 'DJ'
1337
+ | 'DM'
1338
+ | 'DO'
1339
+ | 'EC'
1340
+ | 'EG'
1341
+ | 'SV'
1342
+ | 'GQ'
1343
+ | 'ER'
1344
+ | 'EE'
1345
+ | 'ET'
1346
+ | 'FK'
1347
+ | 'FO'
1348
+ | 'FJ'
1349
+ | 'FI'
1350
+ | 'FR'
1351
+ | 'GF'
1352
+ | 'PF'
1353
+ | 'TF'
1354
+ | 'GA'
1355
+ | 'GM'
1356
+ | 'GE'
1357
+ | 'DE'
1358
+ | 'GH'
1359
+ | 'GI'
1360
+ | 'GR'
1361
+ | 'GL'
1362
+ | 'GD'
1363
+ | 'GP'
1364
+ | 'GU'
1365
+ | 'GT'
1366
+ | 'GN'
1367
+ | 'GW'
1368
+ | 'GY'
1369
+ | 'HT'
1370
+ | 'HM'
1371
+ | 'VA'
1372
+ | 'HN'
1373
+ | 'HK'
1374
+ | 'HU'
1375
+ | 'IS'
1376
+ | 'IN'
1377
+ | 'ID'
1378
+ | 'IR'
1379
+ | 'IQ'
1380
+ | 'IE'
1381
+ | 'IL'
1382
+ | 'IT'
1383
+ | 'JM'
1384
+ | 'JP'
1385
+ | 'JO'
1386
+ | 'KZ'
1387
+ | 'KE'
1388
+ | 'KI'
1389
+ | 'KP'
1390
+ | 'KR'
1391
+ | 'KW'
1392
+ | 'KG'
1393
+ | 'LA'
1394
+ | 'LV'
1395
+ | 'LB'
1396
+ | 'LS'
1397
+ | 'LR'
1398
+ | 'LY'
1399
+ | 'LI'
1400
+ | 'LT'
1401
+ | 'LU'
1402
+ | 'MO'
1403
+ | 'MG'
1404
+ | 'MW'
1405
+ | 'MY'
1406
+ | 'MV'
1407
+ | 'ML'
1408
+ | 'MT'
1409
+ | 'MH'
1410
+ | 'MQ'
1411
+ | 'MR'
1412
+ | 'MU'
1413
+ | 'YT'
1414
+ | 'MX'
1415
+ | 'FM'
1416
+ | 'MD'
1417
+ | 'MC'
1418
+ | 'MN'
1419
+ | 'MS'
1420
+ | 'MA'
1421
+ | 'MZ'
1422
+ | 'MM'
1423
+ | 'NA'
1424
+ | 'NR'
1425
+ | 'NP'
1426
+ | 'NL'
1427
+ | 'NC'
1428
+ | 'NZ'
1429
+ | 'NI'
1430
+ | 'NE'
1431
+ | 'NG'
1432
+ | 'NU'
1433
+ | 'NF'
1434
+ | 'MP'
1435
+ | 'MK'
1436
+ | 'NO'
1437
+ | 'OM'
1438
+ | 'PK'
1439
+ | 'PW'
1440
+ | 'PS'
1441
+ | 'PA'
1442
+ | 'PG'
1443
+ | 'PY'
1444
+ | 'PE'
1445
+ | 'PH'
1446
+ | 'PN'
1447
+ | 'PL'
1448
+ | 'PT'
1449
+ | 'PR'
1450
+ | 'QA'
1451
+ | 'RE'
1452
+ | 'RO'
1453
+ | 'RU'
1454
+ | 'RW'
1455
+ | 'SH'
1456
+ | 'KN'
1457
+ | 'LC'
1458
+ | 'PM'
1459
+ | 'VC'
1460
+ | 'WS'
1461
+ | 'SM'
1462
+ | 'ST'
1463
+ | 'SA'
1464
+ | 'SN'
1465
+ | 'SC'
1466
+ | 'SL'
1467
+ | 'SG'
1468
+ | 'SK'
1469
+ | 'SI'
1470
+ | 'SB'
1471
+ | 'SO'
1472
+ | 'ZA'
1473
+ | 'GS'
1474
+ | 'ES'
1475
+ | 'LK'
1476
+ | 'SD'
1477
+ | 'SR'
1478
+ | 'SJ'
1479
+ | 'SZ'
1480
+ | 'SE'
1481
+ | 'CH'
1482
+ | 'SY'
1483
+ | 'TW'
1484
+ | 'TJ'
1485
+ | 'TZ'
1486
+ | 'TH'
1487
+ | 'TL'
1488
+ | 'TG'
1489
+ | 'TK'
1490
+ | 'TO'
1491
+ | 'TT'
1492
+ | 'TN'
1493
+ | 'TR'
1494
+ | 'TM'
1495
+ | 'TC'
1496
+ | 'TV'
1497
+ | 'UG'
1498
+ | 'UA'
1499
+ | 'AE'
1500
+ | 'GB'
1501
+ | 'US'
1502
+ | 'UM'
1503
+ | 'UY'
1504
+ | 'UZ'
1505
+ | 'VU'
1506
+ | 'VE'
1507
+ | 'VN'
1508
+ | 'VG'
1509
+ | 'VI'
1510
+ | 'WF'
1511
+ | 'EH'
1512
+ | 'YE'
1513
+ | 'ZM'
1514
+ | 'ZW'
1515
+ | 'AX'
1516
+ | 'BQ'
1517
+ | 'CW'
1518
+ | 'GG'
1519
+ | 'IM'
1520
+ | 'JE'
1521
+ | 'ME'
1522
+ | 'BL'
1523
+ | 'MF'
1524
+ | 'RS'
1525
+ | 'SX'
1526
+ | 'SS'
1527
+ | 'XK'
1528
+ >;
1529
+
1530
+ /**
1531
+ * The delivery estimate of the shipping method.
1532
+ */
1533
+ deliveryEstimate?: ShippingMethod.DeliveryEstimate;
1534
+
1535
+ /**
1536
+ * The unique identifier within your system of the shipping method.
1537
+ */
1538
+ reference?: string;
1539
+
1540
+ /**
1541
+ * @deprecated Deprecated in favor of deliveryEstimate
1542
+ */
1543
+ timeFrame?: string;
1544
+ }
1545
+
1546
+ export namespace ShippingMethod {
1547
+ /**
1548
+ * The delivery estimate of the shipping method.
1549
+ */
1550
+ export interface DeliveryEstimate {
1551
+ /**
1552
+ * The maximum delivery time.
1553
+ */
1554
+ maximum?: DeliveryEstimate.Maximum;
1555
+
1556
+ /**
1557
+ * The minimum delivery time.
1558
+ */
1559
+ minimum?: DeliveryEstimate.Minimum;
1560
+ }
1561
+
1562
+ export namespace DeliveryEstimate {
1563
+ /**
1564
+ * The maximum delivery time.
1565
+ */
1566
+ export interface Maximum {
1567
+ /**
1568
+ * The unit of the time duration.
1569
+ */
1570
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1571
+
1572
+ /**
1573
+ * The value of the time duration.
1574
+ */
1575
+ value: number;
1576
+ }
1577
+
1578
+ /**
1579
+ * The minimum delivery time.
1580
+ */
1581
+ export interface Minimum {
1582
+ /**
1583
+ * The unit of the time duration.
1584
+ */
1585
+ unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
1586
+
1587
+ /**
1588
+ * The value of the time duration.
1589
+ */
1590
+ value: number;
1591
+ }
1592
+ }
1593
+ }
1594
+
1595
+ /**
1596
+ * The shopper object. Contains information collected from the user during the
1597
+ * Checkout.
1598
+ */
1599
+ export interface Shopper {
1600
+ email?: string;
1601
+
1602
+ phoneNumber?: string;
1603
+ }
1604
+
1605
+ export interface StatusClassification {
1606
+ /**
1607
+ * Populated with the primary payment initiation failure classsification if
1608
+ * available.
1609
+ */
1610
+ primary?: string;
1611
+
1612
+ /**
1613
+ * Populated with the secondary payment initiation failure classsification if
1614
+ * available.
1615
+ */
1616
+ secondary?: string;
1617
+ }
1618
+
1619
+ export interface StatusHistoryList {
1620
+ /**
1621
+ * The order status. This status symbolises the state of the user's payment
1622
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
1623
+ * information.
1624
+ */
1625
+ currentStatus:
1626
+ | 'failed'
1627
+ | 'canceled'
1628
+ | 'processing'
1629
+ | 'waiting_for_payment'
1630
+ | 'paid'
1631
+ | 'in_refund'
1632
+ | 'refunded'
1633
+ | 'refund_failed'
1634
+ | 'partially_refunded'
1635
+ | 'in_dispute'
1636
+ | 'disputed'
1637
+ | 'refused';
1638
+
1639
+ reason: string;
1640
+
1641
+ updatedAt: string;
1642
+
1643
+ /**
1644
+ * The order status. This status symbolises the state of the user's payment
1645
+ * attempt. See [the guide](https://docs.getivy.de/docs/payment-status) for more
1646
+ * information.
1647
+ */
1648
+ previousStatus?:
1649
+ | 'failed'
1650
+ | 'canceled'
1651
+ | 'processing'
1652
+ | 'waiting_for_payment'
1653
+ | 'paid'
1654
+ | 'in_refund'
1655
+ | 'refunded'
1656
+ | 'refund_failed'
1657
+ | 'partially_refunded'
1658
+ | 'in_dispute'
1659
+ | 'disputed'
1660
+ | 'refused'
1661
+ | null;
14
1662
  }
15
1663
  }
16
1664
 
@@ -1655,13 +3303,63 @@ export namespace OrderRetrieveResponse {
1655
3303
  }
1656
3304
  }
1657
3305
 
3306
+ export interface OrderCreateParams {
3307
+ /**
3308
+ * The total amount of the order
3309
+ */
3310
+ amount: number;
3311
+
3312
+ /**
3313
+ * The currency code of the order
3314
+ */
3315
+ currency: 'EUR' | 'GBP' | 'PLN';
3316
+
3317
+ /**
3318
+ * The merchant's unique reference ID for the order
3319
+ */
3320
+ referenceId: string;
3321
+
3322
+ /**
3323
+ * The customer of the merchant.
3324
+ */
3325
+ customer?: OrderCreateParams.Email | OrderCreateParams.ID;
3326
+
3327
+ /**
3328
+ * Optional expiration timestamp in seconds
3329
+ */
3330
+ expiresAt?: string;
3331
+
3332
+ /**
3333
+ * The subaccount id of the merchant.
3334
+ */
3335
+ subaccountId?: string;
3336
+ }
3337
+
3338
+ export namespace OrderCreateParams {
3339
+ export interface Email {
3340
+ /**
3341
+ * The email of the customer.
3342
+ */
3343
+ email: string;
3344
+ }
3345
+
3346
+ export interface ID {
3347
+ /**
3348
+ * The Ivy id of the customer.
3349
+ */
3350
+ id: string;
3351
+ }
3352
+ }
3353
+
1658
3354
  export interface OrderRetrieveParams {
1659
3355
  id: string;
1660
3356
  }
1661
3357
 
1662
3358
  export declare namespace Orders {
1663
3359
  export {
3360
+ type OrderCreateResponse as OrderCreateResponse,
1664
3361
  type OrderRetrieveResponse as OrderRetrieveResponse,
3362
+ type OrderCreateParams as OrderCreateParams,
1665
3363
  type OrderRetrieveParams as OrderRetrieveParams,
1666
3364
  };
1667
3365
  }