@wix/auto_sdk_ecom_orders 1.0.304 → 1.0.306

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 (29) hide show
  1. package/build/cjs/{ecom-v1-order-orders.universal-BO6gFADZ.d.ts → ecom-v1-order-orders.universal-WyKRc4fh.d.ts} +1674 -1672
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +80 -80
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +80 -80
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1674 -1672
  9. package/build/cjs/meta.js +80 -80
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-BO6gFADZ.d.mts → ecom-v1-order-orders.universal-WyKRc4fh.d.mts} +1674 -1672
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +80 -80
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +2 -2
  16. package/build/es/index.typings.mjs +80 -80
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1674 -1672
  19. package/build/es/meta.mjs +80 -80
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-Doi51FeO.d.ts → ecom-v1-order-orders.universal-BJo4OYMU.d.ts} +1826 -1824
  22. package/build/internal/cjs/index.d.ts +2 -2
  23. package/build/internal/cjs/index.typings.d.ts +2 -2
  24. package/build/internal/cjs/meta.d.ts +1826 -1824
  25. package/build/internal/es/{ecom-v1-order-orders.universal-Doi51FeO.d.mts → ecom-v1-order-orders.universal-BJo4OYMU.d.mts} +1826 -1824
  26. package/build/internal/es/index.d.mts +2 -2
  27. package/build/internal/es/index.typings.d.mts +2 -2
  28. package/build/internal/es/meta.d.mts +1826 -1824
  29. package/package.json +2 -2
@@ -1,4 +1,4 @@
1
- import { eo as ImportOrderRequest$1, I as ImportOrderResponse$1, ep as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, eq as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, eu as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, ey as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, ez as RecordManuallyCollectedPaymentRequest$1, eC as RecordManuallyCollectedPaymentResponse$1, eD as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, eE as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, eJ as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, eM as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, eO as ChargeMembershipsRequest$1, eR as ChargeMembershipsResponse$1, eS as TriggerRefundRequest$1, p as TriggerRefundResponse$1, fz as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fA as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, gU as GetOrderRequest$1, gV as GetOrderResponse$1, h5 as SearchOrdersRequest$1, x as SearchOrdersResponse$1, h9 as CreateOrderRequest$1, hd as CreateOrderResponse$1, he as UpdateOrderRequest$1, hf as UpdateOrderResponse$1, hg as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hL as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ia as AddActivityRequest$1, N as AddActivityResponse$1, ic as AddActivitiesRequest$1, W as AddActivitiesResponse$1, id as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, ie as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, il as CancelOrderRequest$1, a0 as CancelOrderResponse$1, im as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iL as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iP as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-Doi51FeO.mjs';
1
+ import { eo as ImportOrderRequest$1, I as ImportOrderResponse$1, ep as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, eq as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, fL as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, fP as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, fQ as RecordManuallyCollectedPaymentRequest$1, fT as RecordManuallyCollectedPaymentResponse$1, fU as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, fV as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, f_ as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, g1 as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, g3 as ChargeMembershipsRequest$1, g6 as ChargeMembershipsResponse$1, g7 as TriggerRefundRequest$1, p as TriggerRefundResponse$1, gL as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gM as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, gU as GetOrderRequest$1, gV as GetOrderResponse$1, h5 as SearchOrdersRequest$1, x as SearchOrdersResponse$1, h9 as CreateOrderRequest$1, hd as CreateOrderResponse$1, he as UpdateOrderRequest$1, hf as UpdateOrderResponse$1, hg as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hL as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ia as AddActivityRequest$1, N as AddActivityResponse$1, ic as AddActivitiesRequest$1, W as AddActivitiesResponse$1, id as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, ie as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, il as CancelOrderRequest$1, a0 as CancelOrderResponse$1, im as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iL as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iP as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-BJo4OYMU.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -4542,2326 +4542,2328 @@ interface BulkDeleteImportedOrdersResponse {
4542
4542
  */
4543
4543
  jobId?: string;
4544
4544
  }
4545
- interface V1TriggerReindexRequest {
4545
+ interface SendBuyerConfirmationEmailRequest {
4546
4546
  /** @format GUID */
4547
- metasiteId?: string;
4547
+ orderId?: string;
4548
+ }
4549
+ interface SendBuyerConfirmationEmailResponse {
4550
+ }
4551
+ interface SendBuyerPaymentsReceivedEmailRequest {
4548
4552
  /**
4549
4553
  * @minLength 1
4550
4554
  * @maxLength 100
4551
- * @maxSize 100
4552
4555
  */
4553
- orderIds?: string[];
4556
+ orderId?: string;
4554
4557
  }
4555
- interface V1TriggerReindexResponse {
4558
+ interface SendBuyerPaymentsReceivedEmailResponse {
4556
4559
  }
4557
- interface V1TriggerReindexOrderRequest {
4558
- /** @format GUID */
4559
- metasiteId?: string;
4560
+ interface SendBuyerPickupConfirmationEmailRequest {
4560
4561
  /**
4561
4562
  * @minLength 1
4562
4563
  * @maxLength 100
4563
4564
  */
4564
4565
  orderId?: string;
4565
4566
  }
4566
- interface PreparePaymentCollectionRequest {
4567
+ interface SendBuyerPickupConfirmationEmailResponse {
4568
+ }
4569
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
4570
+ /**
4571
+ * IDs of orders to send pickup emails for.
4572
+ * @minSize 1
4573
+ * @maxSize 300
4574
+ */
4575
+ orderIds?: string[];
4576
+ }
4577
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4578
+ }
4579
+ interface SendBuyerShippingConfirmationEmailRequest {
4567
4580
  /**
4568
- * Ecom order ID.
4569
4581
  * @minLength 1
4570
4582
  * @maxLength 100
4571
4583
  */
4572
- ecomOrderId: string;
4573
- /** Amount to collect */
4574
- amount: Price;
4584
+ orderId?: string;
4585
+ }
4586
+ interface SendBuyerShippingConfirmationEmailResponse {
4587
+ }
4588
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
4575
4589
  /**
4576
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4577
- * Existing payment gateway order will be updated with a new amount.
4578
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4590
+ * IDs of orders to send pickup emails for.
4591
+ * @minSize 1
4592
+ * @maxSize 300
4579
4593
  */
4580
- paymentGatewayOrderId?: string | null;
4594
+ orderIds?: string[];
4595
+ }
4596
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4597
+ }
4598
+ interface SendMerchantOrderReceivedNotificationRequest {
4581
4599
  /**
4582
- * Whether to delay capture of the payment.
4583
- * Default: false
4584
- * @deprecated Whether to delay capture of the payment.
4585
- * Default: false
4586
- * @replacedBy delayed_capture_settings.scheduled_action
4587
- * @targetRemovalDate 2024-09-30
4600
+ * @minLength 1
4601
+ * @maxLength 100
4588
4602
  */
4589
- delayedCapture?: boolean;
4603
+ orderId?: string;
4604
+ }
4605
+ interface SendMerchantOrderReceivedNotificationResponse {
4606
+ }
4607
+ interface SendCancelRefundEmailRequest {
4590
4608
  /**
4591
- * Specifies whether payment collection is initiated by Merchant or User of User
4592
- * Default: `true`
4593
- * @internal
4609
+ * The ID of order that is canceled/refunded
4610
+ * @minLength 1
4611
+ * @maxLength 100
4594
4612
  */
4595
- merchantInitiated?: boolean | null;
4613
+ orderId?: string;
4596
4614
  /**
4597
- * Redirect urls which are used to return buyer to third party system.
4598
- * @internal
4615
+ * Personal note added to the email (optional)
4616
+ * @minLength 1
4617
+ * @maxLength 1000
4599
4618
  */
4600
- redirectUrls?: RedirectUrls;
4601
- /** Delayed capture payment settings */
4602
- delayedCaptureSettings?: DelayedCaptureSettings;
4603
- }
4604
- interface RedirectUrls {
4619
+ customMessage?: string | null;
4620
+ /** Refund amount */
4621
+ refundAmount?: Price;
4605
4622
  /**
4606
- * URL to redirect buyer in case of approved (successful) transaction
4607
- * @format WEB_URL
4623
+ * Refund ID. (Optional)
4624
+ * @format GUID
4608
4625
  */
4609
- successUrl?: string | null;
4626
+ refundId?: string | null;
4627
+ }
4628
+ interface SendCancelRefundEmailResponse {
4629
+ }
4630
+ interface SendRefundEmailRequest {
4610
4631
  /**
4611
- * URL to redirect buyer in case of buyer canceled the transaction
4612
- * @format WEB_URL
4632
+ * The ID of order that is refunded
4633
+ * @format GUID
4613
4634
  */
4614
- cancelUrl?: string | null;
4635
+ orderId?: string;
4615
4636
  /**
4616
- * URL to redirect buyer in case of failed/rejected transaction
4617
- * @format WEB_URL
4637
+ * Refund ID
4638
+ * @format GUID
4618
4639
  */
4619
- errorUrl?: string | null;
4640
+ refundId?: string;
4620
4641
  /**
4621
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4622
- * @format WEB_URL
4642
+ * Personal note added to the email (optional)
4643
+ * @minLength 1
4644
+ * @maxLength 1000
4623
4645
  */
4624
- pendingUrl?: string | null;
4646
+ customMessage?: string | null;
4625
4647
  }
4626
- interface DelayedCaptureSettings {
4627
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4628
- scheduledAction?: ScheduledActionWithLiterals;
4629
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4630
- delayDuration?: Duration;
4648
+ interface SendRefundEmailResponse {
4631
4649
  }
4632
- declare enum ScheduledAction {
4633
- /** Whether payment will be auto-voided when duration passes */
4634
- VOID = "VOID",
4635
- /** Whether payment will be auto-captured when duration passes */
4636
- CAPTURE = "CAPTURE"
4650
+ interface SendFulfillmentEmailRequest {
4651
+ /** @format GUID */
4652
+ orderId?: string;
4653
+ /** @format GUID */
4654
+ fulfillerId?: string;
4637
4655
  }
4638
- /** @enumType */
4639
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4640
- interface Duration {
4656
+ interface SendFulfillmentEmailResponse {
4657
+ }
4658
+ interface SendMerchantOrderReceivedPushRequest {
4641
4659
  /**
4642
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4643
- * @min 1
4660
+ * @minLength 1
4661
+ * @maxLength 100
4644
4662
  */
4645
- count?: number;
4646
- /** Duration unit: MINUTES, HOURS and DAYS */
4647
- unit?: DurationUnitWithLiterals;
4663
+ orderId?: string;
4648
4664
  }
4649
- declare enum DurationUnit {
4650
- MINUTES = "MINUTES",
4651
- HOURS = "HOURS",
4652
- DAYS = "DAYS"
4665
+ interface SendMerchantOrderReceivedPushResponse {
4666
+ }
4667
+ interface PreviewEmailByTypeRequest {
4668
+ emailType?: PreviewEmailTypeWithLiterals;
4669
+ }
4670
+ declare enum PreviewEmailType {
4671
+ ORDER_PLACED = "ORDER_PLACED",
4672
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4673
+ ORDER_SHIPPED = "ORDER_SHIPPED",
4674
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4653
4675
  }
4654
4676
  /** @enumType */
4655
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4656
- interface PreparePaymentCollectionResponse {
4657
- /** Payment gateway order id which is associated with given payment */
4658
- paymentGatewayOrderId?: string;
4677
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4678
+ interface PreviewEmailByTypeResponse {
4679
+ emailPreview?: string;
4659
4680
  }
4660
- interface GetPaymentCollectabilityStatusRequest {
4681
+ interface PreviewRefundEmailRequest {
4661
4682
  /**
4662
- * Ecom order ID.
4663
4683
  * @minLength 1
4664
4684
  * @maxLength 100
4665
4685
  */
4666
- ecomOrderId: string;
4667
- }
4668
- interface GetPaymentCollectabilityStatusResponse {
4669
- /** Payment collectability status */
4670
- status?: PaymentCollectabilityStatusWithLiterals;
4671
- /** Collectable order amount */
4672
- amount?: Price;
4686
+ orderId?: string;
4687
+ /** Refund amount */
4688
+ refundAmount?: Price;
4689
+ /** Refund business details */
4690
+ details?: RefundDetails;
4673
4691
  /**
4674
- * Whether authorization supported
4675
- * @internal
4692
+ * Personal note added to the email (optional)
4693
+ * @minLength 1
4694
+ * @maxLength 1000
4676
4695
  */
4677
- authorizationSupported?: boolean;
4696
+ customMessage?: string | null;
4678
4697
  /**
4679
- * Whether custom amount is supported for payment collection
4680
- * @internal
4698
+ * Refund ID. (Optional)
4699
+ * @format GUID
4681
4700
  */
4682
- customAmountSupported?: boolean;
4683
- }
4684
- declare enum PaymentCollectabilityStatus {
4685
- UNKNOWN = "UNKNOWN",
4686
- COLLECTABLE = "COLLECTABLE",
4687
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4688
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4689
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4690
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4691
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4692
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4693
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4694
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4695
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4696
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4697
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4701
+ refundId?: string | null;
4698
4702
  }
4699
- /** @enumType */
4700
- type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
4701
- interface RecordManuallyCollectedPaymentRequest {
4703
+ /** Business model of a refund request */
4704
+ interface RefundDetails {
4702
4705
  /**
4703
- * Order ID.
4704
- * @minLength 1
4705
- * @maxLength 100
4706
+ * Order line item IDs and quantities that were refunded.
4707
+ * @maxSize 300
4706
4708
  */
4707
- orderId: string;
4708
- /** Amount to be recorded as approved manual payment for given order */
4709
- amount: Price;
4709
+ items?: RefundItem[];
4710
+ /** Whether the shipping fee was also refunded. */
4711
+ shippingIncluded?: boolean;
4710
4712
  /**
4711
- * Payment method name provided by user.
4712
- *
4713
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4714
- * @internal
4713
+ * Reason for the refund, provided by customer (optional).
4714
+ * @maxLength 200
4715
4715
  */
4716
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4717
- }
4718
- /**
4719
- * User-defined payment method name.
4720
- * Allows specifying either a predefined type or a custom name.
4721
- */
4722
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4723
- /** Predefined payment method. */
4724
- predefined?: PredefinedPaymentMethodWithLiterals;
4716
+ reason?: string | null;
4725
4717
  /**
4726
- * Custom payment method name provided by user.
4727
- *
4728
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4729
- * @minLength 1
4730
- * @maxLength 150
4718
+ * Line items that were refunded.
4719
+ * @maxSize 300
4731
4720
  */
4732
- custom?: string | null;
4733
- }
4734
- /** @oneof */
4735
- interface UserDefinedPaymentMethodNameKindOneOf {
4736
- /** Predefined payment method. */
4737
- predefined?: PredefinedPaymentMethodWithLiterals;
4721
+ lineItems?: LineItemRefund[];
4738
4722
  /**
4739
- * Custom payment method name provided by user.
4740
- *
4741
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4742
- * @minLength 1
4743
- * @maxLength 150
4723
+ * Additional fees that were refunded.
4724
+ * @maxSize 100
4744
4725
  */
4745
- custom?: string | null;
4746
- }
4747
- /** Predefined payment method types for offline/manual payments. */
4748
- declare enum PredefinedPaymentMethod {
4749
- /** Cash payment. */
4750
- CASH = "CASH",
4751
- /** Bank transfer. */
4752
- BANK_TRANSFER = "BANK_TRANSFER",
4753
- /** Payment by check. */
4754
- CHECK = "CHECK"
4755
- }
4756
- /** @enumType */
4757
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4758
- interface RecordManuallyCollectedPaymentResponse {
4726
+ additionalFees?: AdditionalFeeRefund[];
4727
+ /** Shipping amount that was refunded. */
4728
+ shipping?: ShippingRefund;
4759
4729
  }
4760
- interface MarkOrderAsPaidRequest {
4730
+ interface RefundItem {
4761
4731
  /**
4762
- * Ecom order ID.
4763
- * @minLength 1
4764
- * @maxLength 100
4732
+ * Line item ID the refunded line item.
4733
+ * @format GUID
4765
4734
  */
4766
- ecomOrderId: string;
4735
+ lineItemId?: string;
4767
4736
  /**
4768
- * Payment method name provided by user.
4769
- *
4770
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4771
- * @internal
4737
+ * Line item quantity refunded.
4738
+ * @min 1
4739
+ * @max 100000
4772
4740
  */
4773
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4774
- }
4775
- interface MarkOrderAsPaidResponse {
4776
- /** Updated order. */
4777
- order?: Order;
4741
+ quantity?: number;
4778
4742
  }
4779
- interface BulkMarkOrdersAsPaidRequest {
4743
+ interface LineItemRefund {
4780
4744
  /**
4781
- * IDs of orders to mark as paid.
4782
- * @minSize 1
4783
- * @maxSize 100
4784
- * @minLength 1
4785
- * @maxLength 100
4745
+ * Line item ID.
4746
+ * @format GUID
4747
+ * @immutable
4786
4748
  */
4787
- ecomOrderIds: string[];
4788
- }
4789
- interface BulkMarkOrdersAsPaidResponse {
4749
+ lineItemId?: string;
4790
4750
  /**
4791
- * Items updated by the bulk action.
4792
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4751
+ * Refund quantity.
4752
+ * @min 1
4753
+ * @max 100000
4754
+ * @immutable
4793
4755
  */
4794
- results?: BulkOrderResult[];
4795
- /** Bulk action metadata. */
4796
- bulkActionMetadata?: BulkActionMetadata;
4756
+ quantity?: number;
4797
4757
  }
4798
- interface BulkOrderResult {
4799
- /** Item metadata. */
4800
- itemMetadata?: ItemMetadata;
4758
+ interface AdditionalFeeRefund {
4801
4759
  /**
4802
- * Updated order.
4803
- *
4804
- * Returned when `returnFullEntity = true`.
4760
+ * Additional fee ID.
4761
+ * @format GUID
4762
+ * @immutable
4805
4763
  */
4806
- item?: Order;
4807
- }
4808
- interface ItemMetadata {
4809
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4810
- id?: string | null;
4811
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4812
- originalIndex?: number;
4813
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4814
- success?: boolean;
4815
- /** Details about the error in case of failure. */
4816
- error?: ApplicationError;
4817
- }
4818
- interface ApplicationError {
4819
- /** Error code. */
4820
- code?: string;
4821
- /** Description of the error. */
4822
- description?: string;
4823
- /** Data related to the error. */
4824
- data?: Record<string, any> | null;
4825
- }
4826
- interface BulkActionMetadata {
4827
- /** Number of items that were successfully processed. */
4828
- totalSuccesses?: number;
4829
- /** Number of items that couldn't be processed. */
4830
- totalFailures?: number;
4831
- /** Number of failures without details because detailed failure threshold was exceeded. */
4832
- undetailedFailures?: number;
4833
- }
4834
- interface GetRefundabilityStatusRequest {
4764
+ additionalFeeId?: string;
4835
4765
  /**
4836
- * Order ID.
4837
- * @minLength 1
4838
- * @maxLength 100
4766
+ * Refund amount.
4767
+ * @immutable
4839
4768
  */
4840
- ecomOrderId: string;
4769
+ amount?: Price;
4841
4770
  }
4842
- interface GetRefundabilityStatusResponse {
4843
- /**
4844
- * Refundability details.
4845
- * @maxSize 300
4846
- */
4847
- refundabilities?: Refundability[];
4771
+ interface ShippingRefund {
4848
4772
  /**
4849
- * Whether the order supports refunding per item.
4850
- * @deprecated
4773
+ * Refund amount.
4774
+ * @immutable
4851
4775
  */
4852
- refundablePerItem?: boolean;
4853
- }
4854
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4855
- /** Reason why payment is not refundable. */
4856
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4857
- /** Reason why payment is only refundable manually. */
4858
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4859
- /** Payment ID. */
4860
- paymentId?: string;
4861
- /** Payment refundability status. */
4862
- refundabilityStatus?: RefundableStatusWithLiterals;
4863
- /** Link to payment provider dashboard. */
4864
- providerLink?: string | null;
4865
- }
4866
- /** @oneof */
4867
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4868
- /** Reason why payment is not refundable. */
4869
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4870
- /** Reason why payment is only refundable manually. */
4871
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4872
- }
4873
- declare enum RefundableStatus {
4874
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4875
- MANUAL = "MANUAL",
4876
- REFUNDABLE = "REFUNDABLE"
4877
- }
4878
- /** @enumType */
4879
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4880
- declare enum NonRefundableReason {
4881
- NONE = "NONE",
4882
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4883
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4884
- INTERNAL_ERROR = "INTERNAL_ERROR",
4885
- NOT_PAID = "NOT_PAID",
4886
- ACCESS_DENIED = "ACCESS_DENIED",
4887
- ZERO_PRICE = "ZERO_PRICE",
4888
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4889
- PENDING_REFUND = "PENDING_REFUND",
4890
- FORBIDDEN = "FORBIDDEN",
4891
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4892
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4893
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4776
+ amount?: Price;
4894
4777
  }
4895
- /** @enumType */
4896
- type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
4897
- declare enum ManuallyRefundableReason {
4898
- EXPIRED = "EXPIRED",
4899
- NOT_SUPPORTED = "NOT_SUPPORTED",
4900
- OFFLINE = "OFFLINE",
4901
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4778
+ interface PreviewRefundEmailResponse {
4779
+ emailPreview?: string;
4902
4780
  }
4903
- /** @enumType */
4904
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4905
- interface CreatePaymentGatewayOrderRequest {
4781
+ interface PreviewCancelEmailRequest {
4906
4782
  /**
4907
- * Ecom order ID.
4908
4783
  * @minLength 1
4909
4784
  * @maxLength 100
4910
4785
  */
4911
- ecomOrderId: string;
4912
- /** Information about the user who initiated the payment. */
4913
- chargedBy?: ChargedBy;
4914
- /**
4915
- * Whether to delay capture of the payment.
4916
- *
4917
- * Default: false
4918
- * @internal
4919
- */
4920
- delayedCapture?: boolean;
4921
- }
4922
- interface ChargedBy {
4923
- /**
4924
- * ID - id of the user who initiated the payment
4925
- * @format GUID
4926
- */
4927
- id?: string;
4786
+ orderId?: string;
4928
4787
  /**
4929
- * Full name - name of the user who initiated the payment
4788
+ * Personal note added to the email (optional)
4930
4789
  * @minLength 1
4931
- * @maxLength 200
4790
+ * @maxLength 1000
4932
4791
  */
4933
- fullName?: string | null;
4792
+ customMessage?: string | null;
4934
4793
  }
4935
- interface CreatePaymentGatewayOrderResponse {
4936
- /** ID of the order created in the payment gateway */
4937
- paymentGatewayOrderId?: string;
4794
+ interface PreviewCancelEmailResponse {
4795
+ emailPreview?: string;
4938
4796
  }
4939
- interface ChargeMembershipsRequest {
4797
+ interface PreviewCancelRefundEmailRequest {
4940
4798
  /**
4941
- * Order ID.
4942
4799
  * @minLength 1
4943
4800
  * @maxLength 100
4944
4801
  */
4945
- ecomOrderId: string;
4946
- /**
4947
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4948
- * but a user which is using the membership on behalf of the a member
4949
- * @format GUID
4950
- */
4951
- memberId: string;
4952
- /**
4953
- * List of items to be paid by memberships
4954
- * @minSize 1
4955
- * @maxSize 300
4956
- */
4957
- membershipCharges?: MembershipChargeItem[];
4958
- }
4959
- interface MembershipChargeItem {
4802
+ orderId?: string;
4960
4803
  /**
4961
- * The id of used membership
4804
+ * Personal note added to the email (optional)
4962
4805
  * @minLength 1
4963
- * @maxLength 100
4806
+ * @maxLength 1000
4964
4807
  */
4965
- membershipId?: string;
4808
+ customMessage?: string | null;
4809
+ /** Refund amount */
4810
+ refundAmount?: Price;
4966
4811
  /**
4967
- * ID of the application providing this payment option
4812
+ * Refund ID. (Optional)
4968
4813
  * @format GUID
4969
4814
  */
4970
- appId?: string;
4971
- /** The name of used membership */
4972
- membershipName?: MembershipName;
4973
- /** Additional data about this membership */
4974
- membershipAdditionalData?: Record<string, any> | null;
4975
- /** Catalog and item reference info. */
4976
- catalogReference?: CatalogReference;
4977
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
4978
- serviceProperties?: ServiceProperties;
4979
- /**
4980
- * Usually would be the same as catalogReference.catalogItemId
4981
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
4982
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4983
- * @minLength 1
4984
- * @maxLength 36
4985
- */
4986
- rootCatalogItemId?: string | null;
4987
- /**
4988
- * line item id of Checkout/Order line item
4989
- * @minLength 1
4990
- * @maxLength 100
4991
- */
4992
- lineItemId?: string;
4815
+ refundId?: string | null;
4993
4816
  }
4994
- interface MembershipName {
4995
- /**
4996
- * Membership name.
4997
- * @maxLength 100
4998
- */
4999
- original?: string;
5000
- /**
5001
- * Translated membership name. Defaults to `original` when not provided.
5002
- * @maxLength 100
5003
- */
5004
- translated?: string | null;
4817
+ interface PreviewCancelRefundEmailResponse {
4818
+ emailPreview?: string;
5005
4819
  }
5006
- interface ChargeMembershipsResponse {
4820
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
5007
4821
  }
5008
- interface TriggerRefundRequest {
4822
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
4823
+ emailPreview?: string;
4824
+ }
4825
+ interface PreviewBuyerConfirmationEmailRequest {
4826
+ }
4827
+ interface PreviewBuyerConfirmationEmailResponse {
4828
+ emailPreview?: string;
4829
+ }
4830
+ interface PreviewBuyerPickupConfirmationEmailRequest {
4831
+ }
4832
+ interface PreviewBuyerPickupConfirmationEmailResponse {
4833
+ emailPreview?: string;
4834
+ }
4835
+ interface PreviewShippingConfirmationEmailRequest {
4836
+ }
4837
+ interface PreviewShippingConfirmationEmailResponse {
4838
+ emailPreview?: string;
4839
+ }
4840
+ interface PreviewResendDownloadLinksEmailRequest {
4841
+ }
4842
+ interface PreviewResendDownloadLinksEmailResponse {
4843
+ emailPreview?: string;
4844
+ }
4845
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4846
+ /** Emitted on a meta site creation. */
4847
+ siteCreated?: SiteCreated;
4848
+ /** Emitted on a meta site transfer completion. */
4849
+ siteTransferred?: SiteTransferred;
4850
+ /** Emitted on a meta site deletion. */
4851
+ siteDeleted?: SiteDeleted;
4852
+ /** Emitted on a meta site restoration. */
4853
+ siteUndeleted?: SiteUndeleted;
4854
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4855
+ sitePublished?: SitePublished;
4856
+ /** Emitted on a meta site unpublish. */
4857
+ siteUnpublished?: SiteUnpublished;
4858
+ /** Emitted when meta site is marked as template. */
4859
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4860
+ /** Emitted when meta site is marked as a WixSite. */
4861
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4862
+ /** Emitted when an application is provisioned (installed). */
4863
+ serviceProvisioned?: ServiceProvisioned;
4864
+ /** Emitted when an application is removed (uninstalled). */
4865
+ serviceRemoved?: ServiceRemoved;
4866
+ /** Emitted when meta site name (URL slug) is changed. */
4867
+ siteRenamedPayload?: SiteRenamed;
4868
+ /** Emitted when meta site was permanently deleted. */
4869
+ hardDeleted?: SiteHardDeleted;
4870
+ /** Emitted on a namespace change. */
4871
+ namespaceChanged?: NamespaceChanged;
4872
+ /** Emitted when Studio is attached. */
4873
+ studioAssigned?: StudioAssigned;
4874
+ /** Emitted when Studio is detached. */
4875
+ studioUnassigned?: StudioUnassigned;
5009
4876
  /**
5010
- * The order this refund related to
5011
- * @minLength 1
5012
- * @maxLength 100
4877
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4878
+ * the actual URL.
4879
+ *
4880
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4881
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5013
4882
  */
5014
- ecomOrderId: string;
4883
+ urlChanged?: SiteUrlChanged;
4884
+ /** Site is marked as PurgedExternally */
4885
+ sitePurgedExternally?: SitePurgedExternally;
4886
+ /** Emitted when Odeditor is attached. */
4887
+ odeditorAssigned?: OdeditorAssigned;
4888
+ /** Emitted when Odeditor is detached. */
4889
+ odeditorUnassigned?: OdeditorUnassigned;
4890
+ /** Emitted when Picasso is attached. */
4891
+ picassoAssigned?: PicassoAssigned;
4892
+ /** Emitted when Picasso is detached. */
4893
+ picassoUnassigned?: PicassoUnassigned;
4894
+ /** Emitted when Wixel is attached. */
4895
+ wixelAssigned?: WixelAssigned;
4896
+ /** Emitted when Wixel is detached. */
4897
+ wixelUnassigned?: WixelUnassigned;
4898
+ /** Emitted when StudioTwo is attached. */
4899
+ studioTwoAssigned?: StudioTwoAssigned;
4900
+ /** Emitted when StudioTwo is detached. */
4901
+ studioTwoUnassigned?: StudioTwoUnassigned;
4902
+ /** Emitted when media from user domain is enabled. */
4903
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4904
+ /** Emitted when media from user domain is disabled. */
4905
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4906
+ /** Emitted when Editorless is attached. */
4907
+ editorlessAssigned?: EditorlessAssigned;
4908
+ /** Emitted when Editorless is detached. */
4909
+ editorlessUnassigned?: EditorlessUnassigned;
5015
4910
  /**
5016
- * Refund operations information
5017
- * @minSize 1
5018
- * @maxSize 1
4911
+ * A meta site id.
4912
+ * @format GUID
5019
4913
  */
5020
- payments: PaymentRefund[];
5021
- /** Business model of a refund */
5022
- details?: RefundDetails;
5023
- /** Side effect details related to refund */
5024
- sideEffects?: RefundSideEffects;
4914
+ metaSiteId?: string;
4915
+ /** A meta site version. Monotonically increasing. */
4916
+ version?: string;
4917
+ /** A timestamp of the event. */
4918
+ timestamp?: string;
4919
+ /**
4920
+ * TODO(meta-site): Change validation once validations are disabled for consumers
4921
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4922
+ * @maxSize 4000
4923
+ */
4924
+ assets?: Asset[];
5025
4925
  }
5026
- interface PaymentRefund {
4926
+ /** @oneof */
4927
+ interface MetaSiteSpecialEventPayloadOneOf {
4928
+ /** Emitted on a meta site creation. */
4929
+ siteCreated?: SiteCreated;
4930
+ /** Emitted on a meta site transfer completion. */
4931
+ siteTransferred?: SiteTransferred;
4932
+ /** Emitted on a meta site deletion. */
4933
+ siteDeleted?: SiteDeleted;
4934
+ /** Emitted on a meta site restoration. */
4935
+ siteUndeleted?: SiteUndeleted;
4936
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4937
+ sitePublished?: SitePublished;
4938
+ /** Emitted on a meta site unpublish. */
4939
+ siteUnpublished?: SiteUnpublished;
4940
+ /** Emitted when meta site is marked as template. */
4941
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4942
+ /** Emitted when meta site is marked as a WixSite. */
4943
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4944
+ /** Emitted when an application is provisioned (installed). */
4945
+ serviceProvisioned?: ServiceProvisioned;
4946
+ /** Emitted when an application is removed (uninstalled). */
4947
+ serviceRemoved?: ServiceRemoved;
4948
+ /** Emitted when meta site name (URL slug) is changed. */
4949
+ siteRenamedPayload?: SiteRenamed;
4950
+ /** Emitted when meta site was permanently deleted. */
4951
+ hardDeleted?: SiteHardDeleted;
4952
+ /** Emitted on a namespace change. */
4953
+ namespaceChanged?: NamespaceChanged;
4954
+ /** Emitted when Studio is attached. */
4955
+ studioAssigned?: StudioAssigned;
4956
+ /** Emitted when Studio is detached. */
4957
+ studioUnassigned?: StudioUnassigned;
5027
4958
  /**
5028
- * Specific payment within the order to refund
5029
- * @format GUID
4959
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4960
+ * the actual URL.
4961
+ *
4962
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4963
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5030
4964
  */
5031
- paymentId?: string;
5032
- /** Refund amount. Not relevant for membership and gift card refunds. */
5033
- amount?: Price;
4965
+ urlChanged?: SiteUrlChanged;
4966
+ /** Site is marked as PurgedExternally */
4967
+ sitePurgedExternally?: SitePurgedExternally;
4968
+ /** Emitted when Odeditor is attached. */
4969
+ odeditorAssigned?: OdeditorAssigned;
4970
+ /** Emitted when Odeditor is detached. */
4971
+ odeditorUnassigned?: OdeditorUnassigned;
4972
+ /** Emitted when Picasso is attached. */
4973
+ picassoAssigned?: PicassoAssigned;
4974
+ /** Emitted when Picasso is detached. */
4975
+ picassoUnassigned?: PicassoUnassigned;
4976
+ /** Emitted when Wixel is attached. */
4977
+ wixelAssigned?: WixelAssigned;
4978
+ /** Emitted when Wixel is detached. */
4979
+ wixelUnassigned?: WixelUnassigned;
4980
+ /** Emitted when StudioTwo is attached. */
4981
+ studioTwoAssigned?: StudioTwoAssigned;
4982
+ /** Emitted when StudioTwo is detached. */
4983
+ studioTwoUnassigned?: StudioTwoUnassigned;
4984
+ /** Emitted when media from user domain is enabled. */
4985
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4986
+ /** Emitted when media from user domain is disabled. */
4987
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4988
+ /** Emitted when Editorless is attached. */
4989
+ editorlessAssigned?: EditorlessAssigned;
4990
+ /** Emitted when Editorless is detached. */
4991
+ editorlessUnassigned?: EditorlessUnassigned;
4992
+ }
4993
+ interface Asset {
5034
4994
  /**
5035
- * Whether refund is made externally and manually (on the payment provider's side)
5036
- * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
5037
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4995
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4996
+ * @maxLength 36
5038
4997
  */
5039
- externalRefund?: boolean;
4998
+ appDefId?: string;
5040
4999
  /**
5041
- * Gateway refund id. When param is present, new refund is not created.
5042
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5043
- * and all side effects from request will be executed.
5044
- * @internal
5045
- * @minLength 1
5046
- * @maxLength 100
5000
+ * An instance id. For legacy reasons may be UUID or a string.
5001
+ * @maxLength 200
5047
5002
  */
5048
- gatewayRefundId?: string | null;
5003
+ instanceId?: string;
5004
+ /** An application state. */
5005
+ state?: StateWithLiterals;
5049
5006
  }
5050
- /** Business model of a refund request */
5051
- interface RefundDetails {
5007
+ declare enum State {
5008
+ UNKNOWN = "UNKNOWN",
5009
+ ENABLED = "ENABLED",
5010
+ DISABLED = "DISABLED",
5011
+ PENDING = "PENDING",
5012
+ DEMO = "DEMO"
5013
+ }
5014
+ /** @enumType */
5015
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5016
+ interface SiteCreated {
5052
5017
  /**
5053
- * Order line item IDs and quantities that were refunded.
5054
- * @maxSize 300
5018
+ * A template identifier (empty if not created from a template).
5019
+ * @maxLength 36
5055
5020
  */
5056
- items?: RefundItem[];
5057
- /** Whether the shipping fee was also refunded. */
5058
- shippingIncluded?: boolean;
5021
+ originTemplateId?: string;
5059
5022
  /**
5060
- * Reason for the refund, provided by customer (optional).
5061
- * @maxLength 200
5023
+ * An account id of the owner.
5024
+ * @format GUID
5062
5025
  */
5063
- reason?: string | null;
5026
+ ownerId?: string;
5027
+ /** A context in which meta site was created. */
5028
+ context?: SiteCreatedContextWithLiterals;
5064
5029
  /**
5065
- * Line items that were refunded.
5066
- * @maxSize 300
5030
+ * A meta site id from which this site was created.
5031
+ *
5032
+ * In case of a creation from a template it's a template id.
5033
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5034
+ * @format GUID
5067
5035
  */
5068
- lineItems?: LineItemRefund[];
5036
+ originMetaSiteId?: string | null;
5069
5037
  /**
5070
- * Additional fees that were refunded.
5071
- * @maxSize 100
5038
+ * A meta site name (URL slug).
5039
+ * @maxLength 20
5072
5040
  */
5073
- additionalFees?: AdditionalFeeRefund[];
5074
- /** Shipping amount that was refunded. */
5075
- shipping?: ShippingRefund;
5041
+ siteName?: string;
5042
+ /** A namespace. */
5043
+ namespace?: NamespaceWithLiterals;
5076
5044
  }
5077
- interface RefundItem {
5045
+ declare enum SiteCreatedContext {
5046
+ /** A valid option, we don't expose all reasons why site might be created. */
5047
+ OTHER = "OTHER",
5048
+ /** A meta site was created from template. */
5049
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5050
+ /** A meta site was created by copying of the transfferred meta site. */
5051
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5052
+ /** A copy of existing meta site. */
5053
+ DUPLICATE = "DUPLICATE",
5054
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5055
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5056
+ /** deprecated A meta site was created for Flash editor. */
5057
+ FLASH = "FLASH"
5058
+ }
5059
+ /** @enumType */
5060
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5061
+ declare enum Namespace {
5062
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5063
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5064
+ WIX = "WIX",
5065
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5066
+ SHOUT_OUT = "SHOUT_OUT",
5067
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5068
+ ALBUMS = "ALBUMS",
5069
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5070
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5071
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5072
+ HOTELS = "HOTELS",
5073
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5074
+ CLUBS = "CLUBS",
5075
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5076
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5077
+ /**
5078
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5079
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5080
+ */
5081
+ DEV_SITE = "DEV_SITE",
5082
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5083
+ LOGOS = "LOGOS",
5084
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5085
+ VIDEO_MAKER = "VIDEO_MAKER",
5086
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5087
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5088
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5089
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5078
5090
  /**
5079
- * Line item ID the refunded line item.
5080
- * @format GUID
5091
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5092
+ *
5093
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
5081
5094
  */
5082
- lineItemId?: string;
5095
+ HTML_DRAFT = "HTML_DRAFT",
5083
5096
  /**
5084
- * Line item quantity refunded.
5085
- * @min 1
5086
- * @max 100000
5097
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5098
+ * Will be accessible from Site List and will not have a website app.
5099
+ * Once the user attaches a site, the site will become a regular wixsite.
5087
5100
  */
5088
- quantity?: number;
5089
- }
5090
- interface LineItemRefund {
5101
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5102
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5103
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5104
+ /** It is to be used in the Business First efforts. */
5105
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5106
+ /** Bookings business flow with no site. */
5107
+ ANYWHERE = "ANYWHERE",
5108
+ /** Namespace for Headless Backoffice with no editor */
5109
+ HEADLESS = "HEADLESS",
5091
5110
  /**
5092
- * Line item ID.
5093
- * @format GUID
5094
- * @immutable
5111
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5112
+ * The site will be used for account level CSM feature for enterprise
5095
5113
  */
5096
- lineItemId?: string;
5114
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5115
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5116
+ RISE = "RISE",
5097
5117
  /**
5098
- * Refund quantity.
5099
- * @min 1
5100
- * @max 100000
5101
- * @immutable
5118
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5119
+ * There's a blank site behind the scene but it's blank).
5120
+ * The Mobile company will be the owner of this namespace.
5102
5121
  */
5103
- quantity?: number;
5104
- }
5105
- interface AdditionalFeeRefund {
5122
+ BRANDED_FIRST = "BRANDED_FIRST",
5123
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5124
+ NOWNIA = "NOWNIA",
5106
5125
  /**
5107
- * Additional fee ID.
5108
- * @format GUID
5109
- * @immutable
5126
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5127
+ * The Partners company owns this namespace.
5110
5128
  */
5111
- additionalFeeId?: string;
5129
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5130
+ /** Codux Headless Sites */
5131
+ CODUX = "CODUX",
5132
+ /** Bobb - AI Design Creator. */
5133
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5112
5134
  /**
5113
- * Refund amount.
5114
- * @immutable
5135
+ * Shared Blog Site is a unique single site across Enterprise account,
5136
+ * This site will hold all Blog posts related to the Marketing product.
5115
5137
  */
5116
- amount?: Price;
5117
- }
5118
- interface ShippingRefund {
5138
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5139
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5140
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5141
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5142
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5143
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5144
+ MIMIR = "MIMIR",
5145
+ /** Wix Twins platform. */
5146
+ TWINS = "TWINS",
5147
+ /** Wix Nano. */
5148
+ NANO = "NANO",
5149
+ /** Base44 headless sites. */
5150
+ BASE44 = "BASE44",
5151
+ /** Wix Channels Sites */
5152
+ CHANNELS = "CHANNELS",
5153
+ /** Nautilus platform. */
5154
+ NAUTILUS = "NAUTILUS",
5119
5155
  /**
5120
- * Refund amount.
5121
- * @immutable
5156
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5157
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5122
5158
  */
5123
- amount?: Price;
5124
- }
5125
- interface RefundSideEffects {
5126
- /** Inventory restock details as part of this refund. */
5127
- restockInfo?: RestockInfo;
5128
- /** Whether to send a refund confirmation email to the customer. */
5129
- sendOrderRefundedEmail?: boolean;
5159
+ SYMPHONY = "SYMPHONY",
5160
+ /** Nautilus platform app. */
5161
+ NAUTILUS_APPS = "NAUTILUS_APPS",
5130
5162
  /**
5131
- * Custom message added to the refund confirmation email.
5132
- * @minLength 1
5133
- * @maxLength 1000
5163
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5164
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5134
5165
  */
5135
- customMessage?: string | null;
5136
- }
5137
- interface RestockInfo {
5138
- /** Restock type. */
5139
- type?: RestockTypeWithLiterals;
5166
+ VIBU = "VIBU",
5140
5167
  /**
5141
- * Deprecated, use items instead
5142
- * @internal
5143
- * @maxSize 300
5144
- * @deprecated
5168
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5169
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
5170
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5171
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
5145
5172
  */
5146
- lineItemIds?: string[];
5173
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5147
5174
  /**
5148
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5149
- * @maxSize 300
5175
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
5176
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5150
5177
  */
5151
- items?: RestockItem[];
5152
- }
5153
- declare enum RestockType {
5154
- NO_ITEMS = "NO_ITEMS",
5155
- ALL_ITEMS = "ALL_ITEMS",
5156
- SOME_ITEMS = "SOME_ITEMS"
5178
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5157
5179
  }
5158
5180
  /** @enumType */
5159
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5160
- interface RestockItem {
5181
+ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
5182
+ /** Site transferred to another user. */
5183
+ interface SiteTransferred {
5161
5184
  /**
5162
- * ID of the line item being restocked.
5185
+ * A previous owner id (user that transfers meta site).
5163
5186
  * @format GUID
5164
5187
  */
5165
- lineItemId?: string;
5166
- /**
5167
- * Line item quantity being restocked.
5168
- * @min 1
5169
- * @max 100000
5170
- */
5171
- quantity?: number;
5188
+ oldOwnerId?: string;
5172
5189
  /**
5173
- * Per-location breakdown of restock quantities.
5174
- * @internal
5175
- * @maxSize 5
5190
+ * A new owner id (user that accepts meta site).
5191
+ * @format GUID
5176
5192
  */
5177
- restockLocations?: RestockLocation[];
5193
+ newOwnerId?: string;
5178
5194
  }
5179
- interface TriggerRefundResponse {
5180
- /** All order's transactions after the refunds were added */
5181
- orderTransactions?: OrderTransactions;
5182
- /** Created refund ID */
5183
- refundId?: string | null;
5184
- /** Payment ID's that the refund execution had failed for */
5185
- failedPaymentIds?: ItemMetadata[];
5195
+ /** Soft deletion of the meta site. Could be restored. */
5196
+ interface SiteDeleted {
5197
+ /** A deletion context. */
5198
+ deleteContext?: DeleteContext;
5186
5199
  }
5187
- /**
5188
- * A record of all payments and refunds associated with an order.
5189
- *
5190
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5191
- */
5192
- interface OrderTransactions {
5193
- /**
5194
- * Order ID.
5195
- * @format GUID
5196
- */
5197
- orderId?: string;
5200
+ interface DeleteContext {
5201
+ /** When the meta site was deleted. */
5202
+ dateDeleted?: Date | null;
5203
+ /** A status. */
5204
+ deleteStatus?: DeleteStatusWithLiterals;
5198
5205
  /**
5199
- * Record of payments made to the merchant.
5200
- * @maxSize 100
5206
+ * A reason (flow).
5207
+ * @maxLength 255
5201
5208
  */
5202
- payments?: Payment[];
5209
+ deleteOrigin?: string;
5203
5210
  /**
5204
- * Record of refunds made to the buyer.
5205
- * @maxSize 300
5211
+ * A service that deleted it.
5212
+ * @maxLength 255
5206
5213
  */
5207
- refunds?: Refund[];
5214
+ initiatorId?: string | null;
5208
5215
  }
5209
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5210
- /** Regular payment details. */
5211
- regularPaymentDetails?: RegularPaymentDetails;
5212
- /** Gift card payment details. */
5213
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5214
- /** Membership payment details. */
5215
- membershipPaymentDetails?: MembershipPaymentDetails;
5216
- /**
5217
- * Receipt created by Wix
5218
- * @internal
5219
- */
5220
- wixReceipt?: WixReceiptInfo;
5221
- /**
5222
- * Receipt created by an external system.
5223
- * @internal
5224
- */
5225
- externalReceipt?: ExternalReceiptInfo;
5226
- /** @internal */
5227
- canceled?: CanceledStatusDetails;
5228
- /** @internal */
5229
- declined?: DeclinedStatusDetails;
5230
- /** @internal */
5231
- voided?: VoidedStatusDetails;
5232
- /**
5233
- * Payment ID.
5234
- * @format GUID
5235
- * @readonly
5236
- */
5237
- id?: string | null;
5238
- /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
5239
- createdDate?: Date | null;
5240
- /**
5241
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5242
- * @readonly
5243
- */
5244
- updatedDate?: Date | null;
5245
- /** Payment amount. */
5246
- amount?: Price;
5247
- /**
5248
- * Whether refunds for this payment are disabled.
5249
- * + `true`: This payment is not refundable.
5250
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5251
- */
5252
- refundDisabled?: boolean;
5253
- /**
5254
- * Whether receipt generation is allowed for this payment.
5255
- * + `true`: This payment supports receipt generation.
5256
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5257
- * @readonly
5258
- */
5259
- supportReceiptGeneration?: boolean;
5260
- /** Details about cash rounding applied to this payment, when relevant. */
5261
- cashRounding?: CashRoundingDetails;
5216
+ declare enum DeleteStatus {
5217
+ UNKNOWN = "UNKNOWN",
5218
+ TRASH = "TRASH",
5219
+ DELETED = "DELETED",
5220
+ PENDING_PURGE = "PENDING_PURGE",
5221
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5222
+ }
5223
+ /** @enumType */
5224
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5225
+ /** Restoration of the meta site. */
5226
+ interface SiteUndeleted {
5227
+ }
5228
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
5229
+ interface SitePublished {
5230
+ }
5231
+ interface SiteUnpublished {
5262
5232
  /**
5263
- * Overall payment status.
5264
- *
5265
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5233
+ * A list of URLs previously associated with the meta site.
5234
+ * @maxLength 4000
5235
+ * @maxSize 10000
5266
5236
  */
5267
- status?: PaymentStatusWithLiterals;
5237
+ urls?: string[];
5238
+ }
5239
+ interface SiteMarkedAsTemplate {
5240
+ }
5241
+ interface SiteMarkedAsWixSite {
5242
+ }
5243
+ /**
5244
+ * Represents a service provisioned a site.
5245
+ *
5246
+ * Note on `origin_instance_id`:
5247
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5248
+ * This is because of the following scenario:
5249
+ *
5250
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
5251
+ * such as a product catalog. When you create a site from this template, you inherit this
5252
+ * default product catalog. However, if the template's product catalog is modified,
5253
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
5254
+ * your site remains consistent with what you initially received and does not include any
5255
+ * changes made to the original template afterward.
5256
+ * To ensure this, the TPA on the template gets a new instance_id.
5257
+ */
5258
+ interface ServiceProvisioned {
5268
5259
  /**
5269
- * Detailed payment status information including gateway reason codes and status-specific details.
5270
- * @internal
5260
+ * Either UUID or EmbeddedServiceType.
5261
+ * @maxLength 36
5271
5262
  */
5272
- paymentStatusDetails?: PaymentStatusDetails;
5263
+ appDefId?: string;
5273
5264
  /**
5274
- * Location where the payment was processed.
5275
- * @internal
5276
- * @format GUID
5277
- * @immutable
5265
+ * Not only UUID. Something here could be something weird.
5266
+ * @maxLength 36
5278
5267
  */
5279
- locationId?: string | null;
5268
+ instanceId?: string;
5280
5269
  /**
5281
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5282
- * @format GUID
5270
+ * An instance id from which this instance is originated.
5271
+ * @maxLength 36
5283
5272
  */
5284
- chargeCorrelationId?: string | null;
5285
- }
5286
- /** @oneof */
5287
- interface PaymentPaymentDetailsOneOf {
5288
- /** Regular payment details. */
5289
- regularPaymentDetails?: RegularPaymentDetails;
5290
- /** Gift card payment details. */
5291
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5292
- /** Membership payment details. */
5293
- membershipPaymentDetails?: MembershipPaymentDetails;
5294
- }
5295
- /** @oneof */
5296
- interface PaymentReceiptInfoOneOf {
5273
+ originInstanceId?: string;
5297
5274
  /**
5298
- * Receipt created by Wix
5299
- * @internal
5275
+ * A version.
5276
+ * @maxLength 500
5300
5277
  */
5301
- wixReceipt?: WixReceiptInfo;
5278
+ version?: string | null;
5302
5279
  /**
5303
- * Receipt created by an external system.
5304
- * @internal
5280
+ * The origin meta site id
5281
+ * @format GUID
5305
5282
  */
5306
- externalReceipt?: ExternalReceiptInfo;
5307
- }
5308
- /** @oneof */
5309
- interface PaymentStatusDetailsOneOf {
5310
- /** @internal */
5311
- canceled?: CanceledStatusDetails;
5312
- /** @internal */
5313
- declined?: DeclinedStatusDetails;
5314
- /** @internal */
5315
- voided?: VoidedStatusDetails;
5283
+ originMetaSiteId?: string | null;
5316
5284
  }
5317
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5318
- /** Credit card details. */
5319
- creditCardDetails?: CreditCardPaymentMethodDetails;
5285
+ interface ServiceRemoved {
5320
5286
  /**
5321
- * Wix Payments order ID.
5322
- * @maxLength 100
5287
+ * Either UUID or EmbeddedServiceType.
5288
+ * @maxLength 36
5323
5289
  */
5324
- paymentOrderId?: string | null;
5290
+ appDefId?: string;
5325
5291
  /**
5326
- * Payment gateway's transaction ID.
5327
- * This field is only returned when the value of `offline_payment` is `false`.
5328
- * @maxLength 100
5292
+ * Not only UUID. Something here could be something weird.
5293
+ * @maxLength 36
5329
5294
  */
5330
- gatewayTransactionId?: string | null;
5295
+ instanceId?: string;
5331
5296
  /**
5332
- * Payment method.
5333
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5334
- * Non-exhaustive list of supported values:
5335
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5336
- * @maxLength 150
5337
- * @deprecated Payment method.
5338
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5339
- * Non-exhaustive list of supported values:
5340
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5341
- * @replacedBy payment_method_name
5342
- * @targetRemovalDate 2026-07-01
5297
+ * A version.
5298
+ * @maxLength 500
5343
5299
  */
5344
- paymentMethod?: string | null;
5300
+ version?: string | null;
5301
+ }
5302
+ /** Rename of the site. Meaning, free public url has been changed as well. */
5303
+ interface SiteRenamed {
5345
5304
  /**
5346
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5347
- * @maxLength 100
5305
+ * A new meta site name (URL slug).
5306
+ * @maxLength 20
5348
5307
  */
5349
- providerTransactionId?: string | null;
5350
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5351
- offlinePayment?: boolean;
5308
+ newSiteName?: string;
5352
5309
  /**
5353
- * Payment status.
5354
- * @deprecated Payment status.
5355
- * @replacedBy payment.status
5356
- * @targetRemovalDate 2026-11-01
5310
+ * A previous meta site name (URL slug).
5311
+ * @maxLength 255
5357
5312
  */
5358
- status?: TransactionStatusWithLiterals;
5359
- /** Whether there is a payment agreement that allows for future charges. */
5360
- savedPaymentMethod?: boolean;
5361
- /** Authorization details. */
5362
- authorizationDetails?: AuthorizationDetails;
5313
+ oldSiteName?: string;
5314
+ }
5315
+ /**
5316
+ * Hard deletion of the meta site.
5317
+ *
5318
+ * Could not be restored. Therefore it's desirable to cleanup data.
5319
+ */
5320
+ interface SiteHardDeleted {
5321
+ /** A deletion context. */
5322
+ deleteContext?: DeleteContext;
5323
+ }
5324
+ interface NamespaceChanged {
5325
+ /** A previous namespace. */
5326
+ oldNamespace?: NamespaceWithLiterals;
5327
+ /** A new namespace. */
5328
+ newNamespace?: NamespaceWithLiterals;
5329
+ }
5330
+ /** Assigned Studio editor */
5331
+ interface StudioAssigned {
5332
+ }
5333
+ /** Unassigned Studio editor */
5334
+ interface StudioUnassigned {
5335
+ }
5336
+ /**
5337
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5338
+ *
5339
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5340
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
5341
+ *
5342
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5343
+ */
5344
+ interface SiteUrlChanged {
5345
+ }
5346
+ /**
5347
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5348
+ * Consumed by other teams to remove relevant data.
5349
+ */
5350
+ interface SitePurgedExternally {
5363
5351
  /**
5364
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5365
- * @internal
5366
- * @maxLength 300
5352
+ * @maxLength 2048
5353
+ * @maxSize 100
5354
+ * @deprecated
5355
+ * @targetRemovalDate 2025-04-15
5367
5356
  */
5368
- paymentProvider?: string | null;
5357
+ appDefId?: string[];
5358
+ }
5359
+ /** Assigned Odeditor */
5360
+ interface OdeditorAssigned {
5361
+ }
5362
+ /** Unassigned Odeditor */
5363
+ interface OdeditorUnassigned {
5364
+ }
5365
+ /** Assigned Picasso editor */
5366
+ interface PicassoAssigned {
5367
+ }
5368
+ /** Unassigned Picasso */
5369
+ interface PicassoUnassigned {
5370
+ }
5371
+ /** Assigned Wixel */
5372
+ interface WixelAssigned {
5373
+ }
5374
+ /** Unassigned Wixel */
5375
+ interface WixelUnassigned {
5376
+ }
5377
+ /** Assigned StudioTwo */
5378
+ interface StudioTwoAssigned {
5379
+ }
5380
+ /** Unassigned StudioTwo */
5381
+ interface StudioTwoUnassigned {
5382
+ }
5383
+ /** Media from user domain is enabled. */
5384
+ interface UserDomainMediaEnabled {
5385
+ }
5386
+ /** Media from user domain is disabled. */
5387
+ interface UserDomainMediaDisabled {
5388
+ }
5389
+ /** Assigned Editorless */
5390
+ interface EditorlessAssigned {
5391
+ }
5392
+ /** Unassigned Editorless */
5393
+ interface EditorlessUnassigned {
5394
+ }
5395
+ interface HasCustomEmailConfigurationsRequest {
5396
+ }
5397
+ interface HasCustomEmailConfigurationsResponse {
5398
+ hasCustomConfigurations?: boolean;
5399
+ }
5400
+ interface AddToAutomationMigrationPopulationRequest {
5401
+ /** When true, sends custom email configurations to automation system via email */
5402
+ sendCustomEmailConfigs?: boolean;
5403
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5404
+ origin?: OriginWithLiterals;
5405
+ }
5406
+ declare enum Origin {
5407
+ OPT_IN = "OPT_IN",
5408
+ MIGRATION = "MIGRATION"
5409
+ }
5410
+ /** @enumType */
5411
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5412
+ interface AddToAutomationMigrationPopulationResponse {
5413
+ success?: boolean;
5414
+ }
5415
+ interface IsInAutomationMigrationPopulationRequest {
5416
+ }
5417
+ interface IsInAutomationMigrationPopulationResponse {
5418
+ inPopulation?: boolean;
5419
+ }
5420
+ interface PreparePaymentCollectionRequest {
5369
5421
  /**
5370
- * Record of chargebacks made by the buyer.
5371
- * @maxSize 6
5422
+ * Ecom order ID.
5423
+ * @minLength 1
5424
+ * @maxLength 100
5372
5425
  */
5373
- chargebacks?: Chargeback[];
5426
+ ecomOrderId: string;
5427
+ /** Amount to collect */
5428
+ amount: Price;
5374
5429
  /**
5375
- * Payment method ID.
5376
- * @internal
5377
- * @maxLength 36
5430
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5431
+ * Existing payment gateway order will be updated with a new amount.
5432
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
5378
5433
  */
5379
- paymentMethodId?: string | null;
5380
- /** Platform fee amount associated with this payment. */
5381
- platformFee?: Price;
5434
+ paymentGatewayOrderId?: string | null;
5382
5435
  /**
5383
- * Payment method with buyer and optional owner translations.
5384
- * Non-exhaustive list of supported values:
5385
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5436
+ * Whether to delay capture of the payment.
5437
+ * Default: false
5438
+ * @deprecated Whether to delay capture of the payment.
5439
+ * Default: false
5440
+ * @replacedBy delayed_capture_settings.scheduled_action
5441
+ * @targetRemovalDate 2024-09-30
5386
5442
  */
5387
- paymentMethodName?: PaymentMethodName;
5388
- }
5389
- /** @oneof */
5390
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5391
- /** Credit card details. */
5392
- creditCardDetails?: CreditCardPaymentMethodDetails;
5393
- }
5394
- declare enum TransactionStatus {
5395
- UNDEFINED = "UNDEFINED",
5396
- APPROVED = "APPROVED",
5397
- PENDING = "PENDING",
5398
- PENDING_MERCHANT = "PENDING_MERCHANT",
5399
- CANCELED = "CANCELED",
5400
- DECLINED = "DECLINED",
5401
- REFUNDED = "REFUNDED",
5402
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5403
- AUTHORIZED = "AUTHORIZED",
5404
- VOIDED = "VOIDED"
5405
- }
5406
- /** @enumType */
5407
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5408
- interface CreditCardPaymentMethodDetails {
5443
+ delayedCapture?: boolean;
5409
5444
  /**
5410
- * The last 4 digits of the card number.
5411
- * @maxLength 4
5445
+ * Specifies whether payment collection is initiated by Merchant or User of User
5446
+ * Default: `true`
5447
+ * @internal
5412
5448
  */
5413
- lastFourDigits?: string | null;
5449
+ merchantInitiated?: boolean | null;
5414
5450
  /**
5415
- * Card issuer's brand.
5416
- * @maxLength 100
5451
+ * Redirect urls which are used to return buyer to third party system.
5452
+ * @internal
5417
5453
  */
5418
- brand?: string | null;
5454
+ redirectUrls?: RedirectUrls;
5455
+ /** Delayed capture payment settings */
5456
+ delayedCaptureSettings?: DelayedCaptureSettings;
5419
5457
  }
5420
- interface AuthorizationDetails {
5458
+ interface RedirectUrls {
5421
5459
  /**
5422
- * Whether the authorized payment is of a delayed capture.
5423
- * @readonly
5460
+ * URL to redirect buyer in case of approved (successful) transaction
5461
+ * @format WEB_URL
5424
5462
  */
5425
- delayedCapture?: boolean;
5426
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5427
- authorizedDate?: Date | null;
5463
+ successUrl?: string | null;
5428
5464
  /**
5429
- * List of captures associated with payment
5430
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5431
- * @maxSize 1
5465
+ * URL to redirect buyer in case of buyer canceled the transaction
5466
+ * @format WEB_URL
5432
5467
  */
5433
- captures?: AuthorizationCapture[];
5434
- /** Void associated with payment */
5435
- void?: AuthorizationVoid;
5436
- /** Scheduled action for this transaction */
5437
- scheduledAction?: V1ScheduledAction;
5438
- }
5439
- interface AuthorizationCapture {
5468
+ cancelUrl?: string | null;
5440
5469
  /**
5441
- * Capture ID.
5442
- * @format GUID
5443
- * @readonly
5470
+ * URL to redirect buyer in case of failed/rejected transaction
5471
+ * @format WEB_URL
5444
5472
  */
5445
- id?: string | null;
5446
- /** Status of this capture action */
5447
- status?: AuthorizationCaptureStatusWithLiterals;
5473
+ errorUrl?: string | null;
5448
5474
  /**
5449
- * Amount of this capture
5450
- * @immutable
5475
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
5476
+ * @format WEB_URL
5451
5477
  */
5452
- amount?: Price;
5453
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5454
- createdDate?: Date | null;
5455
- /** In case of status is FAILED may contain failure details */
5456
- failureDetails?: AuthorizationActionFailureDetails;
5457
- }
5458
- declare enum AuthorizationCaptureStatus {
5459
- /** Capture operation still in progress. */
5460
- PENDING = "PENDING",
5461
- /** Capture operation succeeded. */
5462
- SUCCEEDED = "SUCCEEDED",
5463
- /** Capture operation failed. */
5464
- FAILED = "FAILED"
5465
- }
5466
- /** @enumType */
5467
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5468
- interface AuthorizationActionFailureDetails {
5469
- /** @maxLength 100 */
5470
- failureCode?: string;
5471
- }
5472
- interface AuthorizationVoid {
5473
- /** Status of this void action */
5474
- status?: AuthorizationVoidStatusWithLiterals;
5475
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5476
- voidedDate?: Date | null;
5477
- /** In case of status is FAILED may contain failure details */
5478
- failureDetails?: AuthorizationActionFailureDetails;
5479
- /** Reason of void action */
5480
- reason?: ReasonWithLiterals;
5481
- }
5482
- declare enum AuthorizationVoidStatus {
5483
- /** Void operation still in progress. */
5484
- PENDING = "PENDING",
5485
- /** Void operation succeeded. */
5486
- SUCCEEDED = "SUCCEEDED",
5487
- /** Void operation failed. */
5488
- FAILED = "FAILED"
5489
- }
5490
- /** @enumType */
5491
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5492
- /** Reason the authorization was voided. */
5493
- declare enum Reason {
5494
- /** Authorization was voided by user. */
5495
- MANUAL = "MANUAL",
5496
- /** Authorization passed execution date. */
5497
- SCHEDULED = "SCHEDULED"
5478
+ pendingUrl?: string | null;
5498
5479
  }
5499
- /** @enumType */
5500
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5501
- interface V1ScheduledAction {
5502
- /** Type of the action. */
5503
- actionType?: ActionTypeWithLiterals;
5504
- /** The date and time of the action. */
5505
- executionDate?: Date | null;
5480
+ interface DelayedCaptureSettings {
5481
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5482
+ scheduledAction?: ScheduledActionWithLiterals;
5483
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
5484
+ delayDuration?: Duration;
5506
5485
  }
5507
- declare enum ActionType {
5486
+ declare enum ScheduledAction {
5487
+ /** Whether payment will be auto-voided when duration passes */
5508
5488
  VOID = "VOID",
5489
+ /** Whether payment will be auto-captured when duration passes */
5509
5490
  CAPTURE = "CAPTURE"
5510
5491
  }
5511
5492
  /** @enumType */
5512
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5513
- interface Chargeback {
5514
- /**
5515
- * Chargeback ID.
5516
- * @format GUID
5517
- * @readonly
5518
- * @immutable
5519
- */
5520
- id?: string;
5521
- /**
5522
- * Date and time the chargeback was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
5523
- * @readonly
5524
- * @immutable
5525
- */
5526
- createdDate?: Date | null;
5493
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5494
+ interface Duration {
5527
5495
  /**
5528
- * Date and time the chargeback was updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
5529
- * @readonly
5496
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5497
+ * @min 1
5530
5498
  */
5531
- updatedDate?: Date | null;
5499
+ count?: number;
5500
+ /** Duration unit: MINUTES, HOURS and DAYS */
5501
+ unit?: DurationUnitWithLiterals;
5502
+ }
5503
+ declare enum DurationUnit {
5504
+ MINUTES = "MINUTES",
5505
+ HOURS = "HOURS",
5506
+ DAYS = "DAYS"
5507
+ }
5508
+ /** @enumType */
5509
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5510
+ interface PreparePaymentCollectionResponse {
5511
+ /** Payment gateway order id which is associated with given payment */
5512
+ paymentGatewayOrderId?: string;
5513
+ }
5514
+ interface GetPaymentCollectabilityStatusRequest {
5532
5515
  /**
5533
- * Amount.
5534
- * @readonly
5535
- * @immutable
5516
+ * Ecom order ID.
5517
+ * @minLength 1
5518
+ * @maxLength 100
5536
5519
  */
5520
+ ecomOrderId: string;
5521
+ }
5522
+ interface GetPaymentCollectabilityStatusResponse {
5523
+ /** Payment collectability status */
5524
+ status?: PaymentCollectabilityStatusWithLiterals;
5525
+ /** Collectable order amount */
5537
5526
  amount?: Price;
5538
5527
  /**
5539
- * Reversal amount. Present only when status is REVERSED.
5540
- * @readonly
5541
- */
5542
- reversalAmount?: Price;
5543
- /**
5544
- * Status.
5545
- *
5546
- * Default: `"APPROVED"`.
5528
+ * Whether authorization supported
5529
+ * @internal
5547
5530
  */
5548
- status?: ChargebackStatusWithLiterals;
5531
+ authorizationSupported?: boolean;
5549
5532
  /**
5550
- * External chargeback ID.
5551
- * @format GUID
5552
- * @readonly
5553
- * @immutable
5533
+ * Whether custom amount is supported for payment collection
5534
+ * @internal
5554
5535
  */
5555
- externalId?: string | null;
5536
+ customAmountSupported?: boolean;
5556
5537
  }
5557
- declare enum ChargebackStatus {
5558
- /** Chargeback was approved. */
5559
- APPROVED = "APPROVED",
5560
- /** Chargeback was reversed. */
5561
- REVERSED = "REVERSED"
5538
+ declare enum PaymentCollectabilityStatus {
5539
+ UNKNOWN = "UNKNOWN",
5540
+ COLLECTABLE = "COLLECTABLE",
5541
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5542
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5543
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5544
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5545
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5546
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5547
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5548
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5549
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5550
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5551
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5562
5552
  }
5563
5553
  /** @enumType */
5564
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5565
- interface PaymentMethodName {
5554
+ type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
5555
+ interface RecordManuallyCollectedPaymentRequest {
5556
+ /**
5557
+ * Order ID.
5558
+ * @minLength 1
5559
+ * @maxLength 100
5560
+ */
5561
+ orderId: string;
5562
+ /** Amount to be recorded as approved manual payment for given order */
5563
+ amount: Price;
5566
5564
  /**
5567
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5568
- * @maxLength 150
5565
+ * Payment method name provided by user.
5566
+ *
5567
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5568
+ * @internal
5569
5569
  */
5570
- buyerLanguageName?: string | null;
5570
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5571
+ }
5572
+ /**
5573
+ * User-defined payment method name.
5574
+ * Allows specifying either a predefined type or a custom name.
5575
+ */
5576
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5577
+ /** Predefined payment method. */
5578
+ predefined?: PredefinedPaymentMethodWithLiterals;
5571
5579
  /**
5572
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5580
+ * Custom payment method name provided by user.
5573
5581
  *
5574
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5582
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5583
+ * @minLength 1
5575
5584
  * @maxLength 150
5576
5585
  */
5577
- siteLanguageName?: string | null;
5586
+ custom?: string | null;
5587
+ }
5588
+ /** @oneof */
5589
+ interface UserDefinedPaymentMethodNameKindOneOf {
5590
+ /** Predefined payment method. */
5591
+ predefined?: PredefinedPaymentMethodWithLiterals;
5578
5592
  /**
5579
- * User-provided payment method name.
5593
+ * Custom payment method name provided by user.
5580
5594
  *
5581
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5595
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5596
+ * @minLength 1
5597
+ * @maxLength 150
5582
5598
  */
5583
- userDefinedName?: UserDefinedPaymentMethodName;
5599
+ custom?: string | null;
5584
5600
  }
5585
- interface GiftCardPaymentDetails {
5601
+ /** Predefined payment method types for offline/manual payments. */
5602
+ declare enum PredefinedPaymentMethod {
5603
+ /** Cash payment. */
5604
+ CASH = "CASH",
5605
+ /** Bank transfer. */
5606
+ BANK_TRANSFER = "BANK_TRANSFER",
5607
+ /** Payment by check. */
5608
+ CHECK = "CHECK"
5609
+ }
5610
+ /** @enumType */
5611
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5612
+ interface RecordManuallyCollectedPaymentResponse {
5613
+ }
5614
+ interface MarkOrderAsPaidRequest {
5586
5615
  /**
5587
- * Gift card payment ID.
5616
+ * Ecom order ID.
5617
+ * @minLength 1
5588
5618
  * @maxLength 100
5589
5619
  */
5590
- giftCardPaymentId?: string;
5620
+ ecomOrderId: string;
5591
5621
  /**
5592
- * Gift card ID.
5622
+ * Payment method name provided by user.
5623
+ *
5624
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5593
5625
  * @internal
5594
- * @deprecated
5595
- */
5596
- giftCardId?: string;
5597
- /**
5598
- * ID of the app that created the gift card.
5599
- * @format GUID
5600
- */
5601
- appId?: string;
5602
- /**
5603
- * Whether the gift card is voided.
5604
- * @readonly
5605
- * @deprecated Whether the gift card is voided.
5606
- * @replacedBy payment.status
5607
- * @targetRemovalDate 2026-11-01
5608
- */
5609
- voided?: boolean;
5610
- /**
5611
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5612
- * @maxLength 30
5613
- * @immutable
5614
5626
  */
5615
- obfuscatedCode?: string | null;
5627
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5616
5628
  }
5617
- interface MembershipPaymentDetails {
5618
- /**
5619
- * Membership ID.
5620
- * @maxLength 200
5621
- */
5622
- membershipId?: string;
5629
+ interface MarkOrderAsPaidResponse {
5630
+ /** Updated order. */
5631
+ order?: Order;
5632
+ }
5633
+ interface BulkMarkOrdersAsPaidRequest {
5623
5634
  /**
5624
- * ID of the line item this membership applies to.
5635
+ * IDs of orders to mark as paid.
5636
+ * @minSize 1
5637
+ * @maxSize 100
5625
5638
  * @minLength 1
5626
5639
  * @maxLength 100
5627
5640
  */
5628
- lineItemId?: string;
5641
+ ecomOrderIds: string[];
5642
+ }
5643
+ interface BulkMarkOrdersAsPaidResponse {
5629
5644
  /**
5630
- * Payment status.
5631
- * @deprecated Payment status.
5632
- * @replacedBy payment.status
5633
- * @targetRemovalDate 2026-11-01
5645
+ * Items updated by the bulk action.
5646
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5634
5647
  */
5635
- status?: MembershipPaymentStatusWithLiterals;
5636
- /** Membership name. */
5637
- name?: MembershipName;
5648
+ results?: BulkOrderResult[];
5649
+ /** Bulk action metadata. */
5650
+ bulkActionMetadata?: BulkActionMetadata;
5651
+ }
5652
+ interface BulkOrderResult {
5653
+ /** Item metadata. */
5654
+ itemMetadata?: ItemMetadata;
5638
5655
  /**
5639
- * The transaction ID in the membership system. Can be used to void the transaction.
5656
+ * Updated order.
5657
+ *
5658
+ * Returned when `returnFullEntity = true`.
5659
+ */
5660
+ item?: Order;
5661
+ }
5662
+ interface ItemMetadata {
5663
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5664
+ id?: string | null;
5665
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5666
+ originalIndex?: number;
5667
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5668
+ success?: boolean;
5669
+ /** Details about the error in case of failure. */
5670
+ error?: ApplicationError;
5671
+ }
5672
+ interface ApplicationError {
5673
+ /** Error code. */
5674
+ code?: string;
5675
+ /** Description of the error. */
5676
+ description?: string;
5677
+ /** Data related to the error. */
5678
+ data?: Record<string, any> | null;
5679
+ }
5680
+ interface BulkActionMetadata {
5681
+ /** Number of items that were successfully processed. */
5682
+ totalSuccesses?: number;
5683
+ /** Number of items that couldn't be processed. */
5684
+ totalFailures?: number;
5685
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5686
+ undetailedFailures?: number;
5687
+ }
5688
+ interface GetRefundabilityStatusRequest {
5689
+ /**
5690
+ * Order ID.
5640
5691
  * @minLength 1
5641
5692
  * @maxLength 100
5642
5693
  */
5643
- externalTransactionId?: string | null;
5694
+ ecomOrderId: string;
5695
+ }
5696
+ interface GetRefundabilityStatusResponse {
5644
5697
  /**
5645
- * Whether the membership is voided.
5646
- * @readonly
5647
- * @deprecated Whether the membership is voided.
5648
- * @replacedBy payment.status
5649
- * @targetRemovalDate 2026-11-01
5698
+ * Refundability details.
5699
+ * @maxSize 300
5650
5700
  */
5651
- voided?: boolean;
5701
+ refundabilities?: Refundability[];
5652
5702
  /**
5653
- * ID of the application providing this payment option.
5654
- * @format GUID
5703
+ * Whether the order supports refunding per item.
5704
+ * @deprecated
5655
5705
  */
5656
- providerAppId?: string;
5657
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5658
- futureMembership?: FutureMembershipDetails;
5706
+ refundablePerItem?: boolean;
5659
5707
  }
5660
- declare enum MembershipPaymentStatus {
5661
- /** Payment was charged. */
5662
- CHARGED = "CHARGED",
5663
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5664
- CHARGE_FAILED = "CHARGE_FAILED",
5665
- /** Payment is pending. */
5666
- CHARGE_PENDING = "CHARGE_PENDING",
5667
- /** Payment was voided. */
5668
- VOIDED = "VOIDED"
5708
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5709
+ /** Reason why payment is not refundable. */
5710
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5711
+ /** Reason why payment is only refundable manually. */
5712
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5713
+ /** Payment ID. */
5714
+ paymentId?: string;
5715
+ /** Payment refundability status. */
5716
+ refundabilityStatus?: RefundableStatusWithLiterals;
5717
+ /** Link to payment provider dashboard. */
5718
+ providerLink?: string | null;
5719
+ }
5720
+ /** @oneof */
5721
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5722
+ /** Reason why payment is not refundable. */
5723
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5724
+ /** Reason why payment is only refundable manually. */
5725
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5726
+ }
5727
+ declare enum RefundableStatus {
5728
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5729
+ MANUAL = "MANUAL",
5730
+ REFUNDABLE = "REFUNDABLE"
5669
5731
  }
5670
5732
  /** @enumType */
5671
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5672
- interface FutureMembershipDetails {
5673
- /**
5674
- * ID of the plan line item in the order from which the membership will be created.
5675
- * @format GUID
5676
- */
5677
- lineItemId?: string;
5678
- /**
5679
- * ID of the benefit the future membership will grant.
5680
- * @maxLength 200
5681
- */
5682
- benefitId?: string;
5733
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5734
+ declare enum NonRefundableReason {
5735
+ NONE = "NONE",
5736
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5737
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5738
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5739
+ NOT_PAID = "NOT_PAID",
5740
+ ACCESS_DENIED = "ACCESS_DENIED",
5741
+ ZERO_PRICE = "ZERO_PRICE",
5742
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5743
+ PENDING_REFUND = "PENDING_REFUND",
5744
+ FORBIDDEN = "FORBIDDEN",
5745
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5746
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5747
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5683
5748
  }
5684
- interface WixReceiptInfo {
5685
- /**
5686
- * Receipt ID
5687
- * @format GUID
5688
- */
5689
- receiptId?: string;
5749
+ /** @enumType */
5750
+ type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
5751
+ declare enum ManuallyRefundableReason {
5752
+ EXPIRED = "EXPIRED",
5753
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5754
+ OFFLINE = "OFFLINE",
5755
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5756
+ }
5757
+ /** @enumType */
5758
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5759
+ interface CreatePaymentGatewayOrderRequest {
5690
5760
  /**
5691
- * Display number of receipt
5761
+ * Ecom order ID.
5692
5762
  * @minLength 1
5693
- * @maxLength 40
5763
+ * @maxLength 100
5694
5764
  */
5695
- displayNumber?: string | null;
5696
- }
5697
- interface ExternalReceiptInfo {
5765
+ ecomOrderId: string;
5766
+ /** Information about the user who initiated the payment. */
5767
+ chargedBy?: ChargedBy;
5698
5768
  /**
5699
- * External receipt ID
5700
- * @maxLength 100
5769
+ * Whether to delay capture of the payment.
5770
+ *
5771
+ * Default: false
5772
+ * @internal
5701
5773
  */
5702
- receiptId?: string | null;
5774
+ delayedCapture?: boolean;
5775
+ }
5776
+ interface ChargedBy {
5703
5777
  /**
5704
- * ID of the app providing the receipt
5778
+ * ID - id of the user who initiated the payment
5705
5779
  * @format GUID
5706
5780
  */
5707
- appId?: string | null;
5781
+ id?: string;
5708
5782
  /**
5709
- * Display number of receipt
5783
+ * Full name - name of the user who initiated the payment
5710
5784
  * @minLength 1
5711
- * @maxLength 40
5785
+ * @maxLength 200
5712
5786
  */
5713
- displayNumber?: string | null;
5787
+ fullName?: string | null;
5714
5788
  }
5715
- interface CashRoundingDetails {
5789
+ interface CreatePaymentGatewayOrderResponse {
5790
+ /** ID of the order created in the payment gateway */
5791
+ paymentGatewayOrderId?: string;
5792
+ }
5793
+ interface ChargeMembershipsRequest {
5716
5794
  /**
5717
- * Payment amount before cash rounding was applied.
5718
- * When provided, balance and status calculations use this value instead of `amount`
5719
- * to prevent false overpayment or underpayment due to rounding.
5795
+ * Order ID.
5796
+ * @minLength 1
5797
+ * @maxLength 100
5720
5798
  */
5721
- unroundedAmount?: Price;
5799
+ ecomOrderId: string;
5722
5800
  /**
5723
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5724
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5725
- * @readonly
5801
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5802
+ * but a user which is using the membership on behalf of the a member
5803
+ * @format GUID
5726
5804
  */
5727
- roundingAdjustment?: CashRounding;
5728
- }
5729
- declare enum PaymentStatus {
5730
- /** Payment was charged successfully. */
5731
- APPROVED = "APPROVED",
5732
- /** Payment is being processed and hasn't been confirmed yet. */
5733
- PENDING = "PENDING",
5734
- /** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
5735
- PENDING_MERCHANT = "PENDING_MERCHANT",
5736
- /** Payment was canceled before it was charged. */
5737
- CANCELED = "CANCELED",
5738
- /** Payment was declined by the payment provider. */
5739
- DECLINED = "DECLINED",
5740
- /** Payment was fully refunded. */
5741
- REFUNDED = "REFUNDED",
5742
- /** Part of the payment amount was refunded. */
5743
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5744
- /** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
5745
- AUTHORIZED = "AUTHORIZED",
5805
+ memberId: string;
5746
5806
  /**
5747
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5748
- *
5749
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5807
+ * List of items to be paid by memberships
5808
+ * @minSize 1
5809
+ * @maxSize 300
5750
5810
  */
5751
- VOIDED = "VOIDED"
5752
- }
5753
- /** @enumType */
5754
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5755
- interface CanceledStatusDetails {
5756
- reason?: CanceledReasonWithLiterals;
5757
- }
5758
- declare enum CanceledReason {
5759
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5760
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5761
- /** Payment was not completed by user and expired. */
5762
- EXPIRED = "EXPIRED"
5763
- }
5764
- /** @enumType */
5765
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5766
- interface DeclinedStatusDetails {
5767
- reason?: DeclinedReasonWithLiterals;
5768
- }
5769
- declare enum DeclinedReason {
5770
- /** Corresponding charge failed. */
5771
- CHARGE_FAILED = "CHARGE_FAILED",
5772
- /** Payment details expired. */
5773
- EXPIRED = "EXPIRED",
5774
- /** Insufficient funds. */
5775
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5776
- /** Gift card was disabled before charge was attempted. */
5777
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5778
- }
5779
- /** @enumType */
5780
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5781
- interface VoidedStatusDetails {
5782
- reason?: VoidedReasonWithLiterals;
5783
- }
5784
- declare enum VoidedReason {
5785
- /** Payment was voided by merchant request. */
5786
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5787
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5788
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5811
+ membershipCharges?: MembershipChargeItem[];
5789
5812
  }
5790
- /** @enumType */
5791
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5792
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5793
- /** @internal */
5794
- canceled?: CanceledStatusDetails;
5795
- /** @internal */
5796
- declined?: DeclinedStatusDetails;
5797
- /** @internal */
5798
- voided?: VoidedStatusDetails;
5813
+ interface MembershipChargeItem {
5799
5814
  /**
5800
- * Reason code from the payment gateway.
5801
- * @internal
5815
+ * The id of used membership
5802
5816
  * @minLength 1
5803
- * @maxLength 10
5817
+ * @maxLength 100
5804
5818
  */
5805
- paymentGatewayReasonCode?: string | null;
5806
- }
5807
- /** @oneof */
5808
- interface PaymentStatusDetailsStatusDetailsOneOf {
5809
- /** @internal */
5810
- canceled?: CanceledStatusDetails;
5811
- /** @internal */
5812
- declined?: DeclinedStatusDetails;
5813
- /** @internal */
5814
- voided?: VoidedStatusDetails;
5815
- }
5816
- interface Refund {
5819
+ membershipId?: string;
5817
5820
  /**
5818
- * Refund ID.
5821
+ * ID of the application providing this payment option
5819
5822
  * @format GUID
5820
- * @readonly
5821
- */
5822
- id?: string;
5823
- /**
5824
- * List of transactions.
5825
- * @maxSize 50
5826
- */
5827
- transactions?: RefundTransaction[];
5828
- /** Refund business details. */
5829
- details?: RefundDetails;
5830
- /**
5831
- * Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
5832
- * @readonly
5833
- * @immutable
5834
5823
  */
5835
- createdDate?: Date | null;
5824
+ appId?: string;
5825
+ /** The name of used membership */
5826
+ membershipName?: MembershipName;
5827
+ /** Additional data about this membership */
5828
+ membershipAdditionalData?: Record<string, any> | null;
5829
+ /** Catalog and item reference info. */
5830
+ catalogReference?: CatalogReference;
5831
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5832
+ serviceProperties?: ServiceProperties;
5836
5833
  /**
5837
- * Aggregated refund summary.
5838
- * @readonly
5834
+ * Usually would be the same as catalogReference.catalogItemId
5835
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5836
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5837
+ * @minLength 1
5838
+ * @maxLength 36
5839
5839
  */
5840
- summary?: AggregatedRefundSummary;
5840
+ rootCatalogItemId?: string | null;
5841
5841
  /**
5842
- * ID of the app that initiated this refund.
5843
- * @format GUID
5844
- * @readonly
5845
- * @immutable
5842
+ * line item id of Checkout/Order line item
5843
+ * @minLength 1
5844
+ * @maxLength 100
5846
5845
  */
5847
- requestingServiceAppId?: string | null;
5846
+ lineItemId?: string;
5848
5847
  }
5849
- interface RefundTransaction {
5848
+ interface MembershipName {
5850
5849
  /**
5851
- * ID of the payment associated with this refund.
5852
- * @format GUID
5853
- * @immutable
5850
+ * Membership name in the site's original language.
5851
+ * @maxLength 100
5854
5852
  */
5855
- paymentId?: string;
5853
+ original?: string;
5856
5854
  /**
5857
- * Refund amount.
5858
- * @immutable
5855
+ * Membership name translated into the buyer's language.
5856
+ *
5857
+ * Default: The value of `original`
5858
+ * @maxLength 100
5859
5859
  */
5860
- amount?: Price;
5861
- /** Refund status. */
5862
- refundStatus?: RefundStatusWithLiterals;
5863
- /** Optional details of current refund status. */
5864
- refundStatusInfo?: RefundStatusInfo;
5860
+ translated?: string | null;
5861
+ }
5862
+ interface ChargeMembershipsResponse {
5863
+ }
5864
+ interface TriggerRefundRequest {
5865
5865
  /**
5866
- * Payment gateway's refund ID.
5867
- * This field is only returned when the value of `external_refund` is `false`.
5868
- * @format GUID
5866
+ * The order this refund related to
5867
+ * @minLength 1
5868
+ * @maxLength 100
5869
5869
  */
5870
- gatewayRefundId?: string | null;
5871
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5872
- providerRefundId?: string | null;
5870
+ ecomOrderId: string;
5873
5871
  /**
5874
- * Whether refund was made externally and manually on the payment provider's side.
5875
- * @immutable
5872
+ * Refund operations information
5873
+ * @minSize 1
5874
+ * @maxSize 1
5876
5875
  */
5877
- externalRefund?: boolean;
5876
+ payments: PaymentRefund[];
5877
+ /** Business model of a refund */
5878
+ details?: RefundDetails;
5879
+ /** Side effect details related to refund */
5880
+ sideEffects?: RefundSideEffects;
5881
+ }
5882
+ interface PaymentRefund {
5878
5883
  /**
5879
- * Location where the refund was processed.
5880
- * @internal
5884
+ * Specific payment within the order to refund
5881
5885
  * @format GUID
5882
- * @immutable
5883
- */
5884
- locationId?: string | null;
5885
- }
5886
- /** Refund transaction status. */
5887
- declare enum RefundStatus {
5888
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5889
- PENDING = "PENDING",
5890
- /** Refund transaction succeeded. */
5891
- SUCCEEDED = "SUCCEEDED",
5892
- /** Refund transaction failed. */
5893
- FAILED = "FAILED",
5894
- /** Refund request acknowledged, and will be executed soon. */
5895
- SCHEDULED = "SCHEDULED",
5896
- /** Refund was initiated on payment provider side. */
5897
- STARTED = "STARTED"
5898
- }
5899
- /** @enumType */
5900
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5901
- interface RefundStatusInfo {
5886
+ */
5887
+ paymentId?: string;
5888
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5889
+ amount?: Price;
5902
5890
  /**
5903
- * Reason code for the refund's current status.
5904
- *
5905
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5891
+ * Whether refund is made externally and manually (on the payment provider's side)
5892
+ * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
5893
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5894
+ */
5895
+ externalRefund?: boolean;
5896
+ /**
5897
+ * Gateway refund id. When param is present, new refund is not created.
5898
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5899
+ * and all side effects from request will be executed.
5900
+ * @internal
5906
5901
  * @minLength 1
5907
- * @maxLength 10
5902
+ * @maxLength 100
5908
5903
  */
5909
- paymentGatewayReasonCode?: string | null;
5904
+ gatewayRefundId?: string | null;
5905
+ }
5906
+ interface RefundSideEffects {
5907
+ /** Inventory restock details as part of this refund. */
5908
+ restockInfo?: RestockInfo;
5909
+ /** Whether to send a refund confirmation email to the customer. */
5910
+ sendOrderRefundedEmail?: boolean;
5910
5911
  /**
5911
- * Free text explanation of current refund status.
5912
+ * Custom message added to the refund confirmation email.
5912
5913
  * @minLength 1
5913
5914
  * @maxLength 1000
5914
5915
  */
5915
- description?: string | null;
5916
- }
5917
- interface AggregatedRefundSummary {
5918
- /** Total amount requested for refund. */
5919
- requestedRefund?: Price;
5920
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5921
- pendingRefund?: Price;
5922
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5923
- refunded?: Price;
5924
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5925
- failedRefundAmount?: Price;
5926
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5927
- pending?: boolean;
5928
- /** Breakdown of refunded items. Available only after refund is complete. */
5929
- breakdown?: RefundItemsBreakdown;
5916
+ customMessage?: string | null;
5930
5917
  }
5931
- interface RefundItemsBreakdown {
5918
+ interface RestockInfo {
5919
+ /** Restock type. */
5920
+ type?: RestockTypeWithLiterals;
5932
5921
  /**
5933
- * Refunded line items and the amount refunded for each.
5922
+ * Deprecated, use items instead
5923
+ * @internal
5934
5924
  * @maxSize 300
5925
+ * @deprecated
5935
5926
  */
5936
- lineItems?: LineItemRefundSummary[];
5927
+ lineItemIds?: string[];
5928
+ /**
5929
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5930
+ * @maxSize 300
5931
+ */
5932
+ items?: RestockItem[];
5937
5933
  }
5938
- interface LineItemRefundSummary {
5934
+ declare enum RestockType {
5935
+ NO_ITEMS = "NO_ITEMS",
5936
+ ALL_ITEMS = "ALL_ITEMS",
5937
+ SOME_ITEMS = "SOME_ITEMS"
5938
+ }
5939
+ /** @enumType */
5940
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5941
+ interface RestockItem {
5939
5942
  /**
5940
- * ID of the refunded line item.
5943
+ * ID of the line item being restocked.
5941
5944
  * @format GUID
5942
5945
  */
5943
5946
  lineItemId?: string;
5944
- /** Total refunded amount for the line item. */
5945
- totalRefundedAmount?: Price;
5946
- }
5947
- interface CalculateRefundRequest {
5948
5947
  /**
5949
- * Order ID
5950
- * @minLength 1
5951
- * @maxLength 100
5948
+ * Line item quantity being restocked.
5949
+ * @min 1
5950
+ * @max 100000
5952
5951
  */
5953
- ecomOrderId?: string;
5952
+ quantity?: number;
5954
5953
  /**
5955
- * Refunded line items and quantity
5956
- * @maxSize 300
5954
+ * Per-location breakdown of restock quantities.
5955
+ * @internal
5956
+ * @maxSize 5
5957
5957
  */
5958
- refundItems?: CalculateRefundItemRequest[];
5959
- /** Should include shipping in refund calculation */
5960
- refundShipping?: boolean;
5958
+ restockLocations?: RestockLocation[];
5961
5959
  }
5962
- interface CalculateRefundItemRequest {
5960
+ interface TriggerRefundResponse {
5961
+ /** All order's transactions after the refunds were added */
5962
+ orderTransactions?: OrderTransactions;
5963
+ /** Created refund ID */
5964
+ refundId?: string | null;
5965
+ /** Payment ID's that the refund execution had failed for */
5966
+ failedPaymentIds?: ItemMetadata[];
5967
+ }
5968
+ /**
5969
+ * A record of all payments and refunds associated with an order.
5970
+ *
5971
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5972
+ */
5973
+ interface OrderTransactions {
5963
5974
  /**
5964
- * ID of the line item being refunded
5975
+ * Order ID.
5965
5976
  * @format GUID
5966
5977
  */
5967
- id?: string;
5978
+ orderId?: string;
5968
5979
  /**
5969
- * How much of that line item is being refunded
5970
- * @min 1
5971
- * @max 100000
5980
+ * Record of payments made to the merchant.
5981
+ * @maxSize 100
5972
5982
  */
5973
- quantity?: number;
5974
- }
5975
- interface CalculateRefundResponse {
5976
- /** Total refundable amount */
5977
- total?: Price;
5978
- /** Tax cost of the order */
5979
- tax?: Price;
5980
- /** Discount given for this order */
5981
- discount?: Price;
5982
- /** Total cost of the order (without tax) */
5983
- subtotal?: Price;
5984
- /** Total shipping cost for order */
5985
- shipping?: Price;
5986
- /** Previous refund given on that order */
5987
- previouslyRefundedAmount?: Price;
5983
+ payments?: Payment[];
5988
5984
  /**
5989
- * The refundable items of that order
5985
+ * Record of refunds made to the buyer.
5990
5986
  * @maxSize 300
5991
5987
  */
5992
- items?: CalculateRefundItemResponse[];
5988
+ refunds?: Refund[];
5993
5989
  }
5994
- interface CalculateRefundItemResponse {
5990
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5991
+ /** Regular payment details. */
5992
+ regularPaymentDetails?: RegularPaymentDetails;
5993
+ /** Gift card payment details. */
5994
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5995
+ /** Membership payment details. */
5996
+ membershipPaymentDetails?: MembershipPaymentDetails;
5995
5997
  /**
5996
- * Line item ID
5998
+ * Receipt created by Wix
5999
+ * @internal
6000
+ */
6001
+ wixReceipt?: WixReceiptInfo;
6002
+ /**
6003
+ * Receipt created by an external system.
6004
+ * @internal
6005
+ */
6006
+ externalReceipt?: ExternalReceiptInfo;
6007
+ /** @internal */
6008
+ canceled?: CanceledStatusDetails;
6009
+ /** @internal */
6010
+ declined?: DeclinedStatusDetails;
6011
+ /** @internal */
6012
+ voided?: VoidedStatusDetails;
6013
+ /**
6014
+ * Payment ID.
5997
6015
  * @format GUID
6016
+ * @readonly
5998
6017
  */
5999
- id?: string;
6000
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6001
- price?: Price;
6002
- }
6003
- interface VoidAuthorizedPaymentsRequest {
6018
+ id?: string | null;
6019
+ /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
6020
+ createdDate?: Date | null;
6004
6021
  /**
6005
- * Wix eCommerce order ID
6006
- * @minLength 1
6007
- * @maxLength 100
6022
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
6023
+ * @readonly
6008
6024
  */
6009
- ecomOrderId: string;
6025
+ updatedDate?: Date | null;
6026
+ /** Payment amount. */
6027
+ amount?: Price;
6010
6028
  /**
6011
- * Payment IDs
6012
- * @minSize 1
6013
- * @maxSize 100
6029
+ * Whether refunds for this payment are disabled.
6030
+ * + `true`: This payment is not refundable.
6031
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
6032
+ */
6033
+ refundDisabled?: boolean;
6034
+ /**
6035
+ * Whether receipt generation is allowed for this payment.
6036
+ * + `true`: This payment supports receipt generation.
6037
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
6038
+ * @readonly
6039
+ */
6040
+ supportReceiptGeneration?: boolean;
6041
+ /** Details about cash rounding applied to this payment, when relevant. */
6042
+ cashRounding?: CashRoundingDetails;
6043
+ /**
6044
+ * Overall payment status.
6045
+ *
6046
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
6047
+ */
6048
+ status?: PaymentStatusWithLiterals;
6049
+ /**
6050
+ * Detailed payment status information including gateway reason codes and status-specific details.
6051
+ * @internal
6052
+ */
6053
+ paymentStatusDetails?: PaymentStatusDetails;
6054
+ /**
6055
+ * Location where the payment was processed.
6056
+ * @internal
6014
6057
  * @format GUID
6058
+ * @immutable
6015
6059
  */
6016
- paymentIds: string[];
6060
+ locationId?: string | null;
6061
+ /**
6062
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
6063
+ * @format GUID
6064
+ */
6065
+ chargeCorrelationId?: string | null;
6017
6066
  }
6018
- interface VoidAuthorizedPaymentsResponse {
6019
- /** All order's transactions after the void was triggered */
6020
- orderTransactions?: OrderTransactions;
6067
+ /** @oneof */
6068
+ interface PaymentPaymentDetailsOneOf {
6069
+ /** Regular payment details. */
6070
+ regularPaymentDetails?: RegularPaymentDetails;
6071
+ /** Gift card payment details. */
6072
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6073
+ /** Membership payment details. */
6074
+ membershipPaymentDetails?: MembershipPaymentDetails;
6021
6075
  }
6022
- interface CaptureAuthorizedPaymentsRequest {
6076
+ /** @oneof */
6077
+ interface PaymentReceiptInfoOneOf {
6023
6078
  /**
6024
- * Wix eCommerce order ID
6025
- * @minLength 1
6026
- * @maxLength 100
6079
+ * Receipt created by Wix
6080
+ * @internal
6027
6081
  */
6028
- ecomOrderId: string;
6082
+ wixReceipt?: WixReceiptInfo;
6083
+ /**
6084
+ * Receipt created by an external system.
6085
+ * @internal
6086
+ */
6087
+ externalReceipt?: ExternalReceiptInfo;
6088
+ }
6089
+ /** @oneof */
6090
+ interface PaymentStatusDetailsOneOf {
6091
+ /** @internal */
6092
+ canceled?: CanceledStatusDetails;
6093
+ /** @internal */
6094
+ declined?: DeclinedStatusDetails;
6095
+ /** @internal */
6096
+ voided?: VoidedStatusDetails;
6097
+ }
6098
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6099
+ /** Credit card details. */
6100
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6029
6101
  /**
6030
- * Capture payments information
6031
- * @minSize 1
6032
- * @maxSize 100
6102
+ * Wix Payments order ID.
6103
+ * @maxLength 100
6033
6104
  */
6034
- payments: PaymentCapture[];
6035
- }
6036
- interface PaymentCapture {
6105
+ paymentOrderId?: string | null;
6037
6106
  /**
6038
- * Payment ID
6039
- * @format GUID
6107
+ * Payment gateway's transaction ID.
6108
+ * This field is only returned when the value of `offline_payment` is `false`.
6109
+ * @maxLength 100
6040
6110
  */
6041
- paymentId?: string | null;
6111
+ gatewayTransactionId?: string | null;
6042
6112
  /**
6043
- * Capture amount.
6044
- * If not provided - full authorized amount will be captured.
6113
+ * Payment method.
6114
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6115
+ * Non-exhaustive list of supported values:
6116
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
6117
+ * @maxLength 150
6118
+ * @deprecated Payment method.
6119
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6120
+ * Non-exhaustive list of supported values:
6121
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
6122
+ * @replacedBy payment_method_name
6123
+ * @targetRemovalDate 2026-07-01
6045
6124
  */
6046
- amount?: Price;
6047
- }
6048
- interface CaptureAuthorizedPaymentsResponse {
6049
- /** All order's transactions after the capture was triggered */
6050
- orderTransactions?: OrderTransactions;
6051
- }
6052
- interface ChargeSavedPaymentMethodRequest {
6125
+ paymentMethod?: string | null;
6053
6126
  /**
6054
- * Ecom Order ID.
6055
- * @minLength 1
6127
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6056
6128
  * @maxLength 100
6057
6129
  */
6058
- ecomOrderId?: string;
6059
- /** Amount to be charged */
6060
- amount?: Price;
6061
- }
6062
- interface ChargeSavedPaymentMethodResponse {
6063
- /** Payment gateway's order ID (e.g Wix Payments) */
6064
- paymentGatewayOrderId?: string;
6065
- }
6066
- interface SendBuyerConfirmationEmailRequest {
6067
- /** @format GUID */
6068
- orderId?: string;
6069
- }
6070
- interface SendBuyerConfirmationEmailResponse {
6071
- }
6072
- interface SendBuyerPaymentsReceivedEmailRequest {
6130
+ providerTransactionId?: string | null;
6131
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6132
+ offlinePayment?: boolean;
6073
6133
  /**
6074
- * @minLength 1
6075
- * @maxLength 100
6134
+ * Payment status.
6135
+ * @deprecated Payment status.
6136
+ * @replacedBy payment.status
6137
+ * @targetRemovalDate 2026-11-01
6076
6138
  */
6077
- orderId?: string;
6078
- }
6079
- interface SendBuyerPaymentsReceivedEmailResponse {
6080
- }
6081
- interface SendBuyerPickupConfirmationEmailRequest {
6139
+ status?: TransactionStatusWithLiterals;
6140
+ /** Whether there is a payment agreement that allows for future charges. */
6141
+ savedPaymentMethod?: boolean;
6142
+ /** Authorization details. */
6143
+ authorizationDetails?: AuthorizationDetails;
6082
6144
  /**
6083
- * @minLength 1
6084
- * @maxLength 100
6145
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6146
+ * @internal
6147
+ * @maxLength 300
6085
6148
  */
6086
- orderId?: string;
6087
- }
6088
- interface SendBuyerPickupConfirmationEmailResponse {
6089
- }
6090
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
6149
+ paymentProvider?: string | null;
6091
6150
  /**
6092
- * IDs of orders to send pickup emails for.
6093
- * @minSize 1
6094
- * @maxSize 300
6151
+ * Record of chargebacks made by the buyer.
6152
+ * @maxSize 6
6095
6153
  */
6096
- orderIds?: string[];
6097
- }
6098
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
6099
- }
6100
- interface SendBuyerShippingConfirmationEmailRequest {
6154
+ chargebacks?: Chargeback[];
6101
6155
  /**
6102
- * @minLength 1
6103
- * @maxLength 100
6156
+ * Payment method ID.
6157
+ * @internal
6158
+ * @maxLength 36
6104
6159
  */
6105
- orderId?: string;
6106
- }
6107
- interface SendBuyerShippingConfirmationEmailResponse {
6108
- }
6109
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
6160
+ paymentMethodId?: string | null;
6161
+ /** Platform fee amount associated with this payment. */
6162
+ platformFee?: Price;
6110
6163
  /**
6111
- * IDs of orders to send pickup emails for.
6112
- * @minSize 1
6113
- * @maxSize 300
6164
+ * Payment method with buyer and optional owner translations.
6165
+ * Non-exhaustive list of supported values:
6166
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
6114
6167
  */
6115
- orderIds?: string[];
6168
+ paymentMethodName?: PaymentMethodName;
6116
6169
  }
6117
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
6170
+ /** @oneof */
6171
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6172
+ /** Credit card details. */
6173
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6118
6174
  }
6119
- interface SendMerchantOrderReceivedNotificationRequest {
6175
+ declare enum TransactionStatus {
6176
+ UNDEFINED = "UNDEFINED",
6177
+ APPROVED = "APPROVED",
6178
+ PENDING = "PENDING",
6179
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6180
+ CANCELED = "CANCELED",
6181
+ DECLINED = "DECLINED",
6182
+ REFUNDED = "REFUNDED",
6183
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6184
+ AUTHORIZED = "AUTHORIZED",
6185
+ VOIDED = "VOIDED"
6186
+ }
6187
+ /** @enumType */
6188
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6189
+ interface CreditCardPaymentMethodDetails {
6120
6190
  /**
6121
- * @minLength 1
6122
- * @maxLength 100
6191
+ * The last 4 digits of the card number.
6192
+ * @maxLength 4
6123
6193
  */
6124
- orderId?: string;
6125
- }
6126
- interface SendMerchantOrderReceivedNotificationResponse {
6127
- }
6128
- interface SendCancelRefundEmailRequest {
6194
+ lastFourDigits?: string | null;
6129
6195
  /**
6130
- * The ID of order that is canceled/refunded
6131
- * @minLength 1
6196
+ * Card issuer's brand.
6132
6197
  * @maxLength 100
6133
6198
  */
6134
- orderId?: string;
6199
+ brand?: string | null;
6200
+ }
6201
+ interface AuthorizationDetails {
6135
6202
  /**
6136
- * Personal note added to the email (optional)
6137
- * @minLength 1
6138
- * @maxLength 1000
6203
+ * Whether the authorized payment is of a delayed capture.
6204
+ * @readonly
6139
6205
  */
6140
- customMessage?: string | null;
6141
- /** Refund amount */
6142
- refundAmount?: Price;
6206
+ delayedCapture?: boolean;
6207
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6208
+ authorizedDate?: Date | null;
6143
6209
  /**
6144
- * Refund ID. (Optional)
6145
- * @format GUID
6210
+ * List of captures associated with payment
6211
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6212
+ * @maxSize 1
6146
6213
  */
6147
- refundId?: string | null;
6148
- }
6149
- interface SendCancelRefundEmailResponse {
6214
+ captures?: AuthorizationCapture[];
6215
+ /** Void associated with payment */
6216
+ void?: AuthorizationVoid;
6217
+ /** Scheduled action for this transaction */
6218
+ scheduledAction?: V1ScheduledAction;
6150
6219
  }
6151
- interface SendRefundEmailRequest {
6152
- /**
6153
- * The ID of order that is refunded
6154
- * @format GUID
6155
- */
6156
- orderId?: string;
6220
+ interface AuthorizationCapture {
6157
6221
  /**
6158
- * Refund ID
6222
+ * Capture ID.
6159
6223
  * @format GUID
6224
+ * @readonly
6160
6225
  */
6161
- refundId?: string;
6226
+ id?: string | null;
6227
+ /** Status of this capture action */
6228
+ status?: AuthorizationCaptureStatusWithLiterals;
6162
6229
  /**
6163
- * Personal note added to the email (optional)
6164
- * @minLength 1
6165
- * @maxLength 1000
6230
+ * Amount of this capture
6231
+ * @immutable
6166
6232
  */
6167
- customMessage?: string | null;
6233
+ amount?: Price;
6234
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6235
+ createdDate?: Date | null;
6236
+ /** In case of status is FAILED may contain failure details */
6237
+ failureDetails?: AuthorizationActionFailureDetails;
6168
6238
  }
6169
- interface SendRefundEmailResponse {
6239
+ declare enum AuthorizationCaptureStatus {
6240
+ /** Capture operation still in progress. */
6241
+ PENDING = "PENDING",
6242
+ /** Capture operation succeeded. */
6243
+ SUCCEEDED = "SUCCEEDED",
6244
+ /** Capture operation failed. */
6245
+ FAILED = "FAILED"
6170
6246
  }
6171
- interface SendFulfillmentEmailRequest {
6172
- /** @format GUID */
6173
- orderId?: string;
6174
- /** @format GUID */
6175
- fulfillerId?: string;
6247
+ /** @enumType */
6248
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6249
+ interface AuthorizationActionFailureDetails {
6250
+ /** @maxLength 100 */
6251
+ failureCode?: string;
6176
6252
  }
6177
- interface SendFulfillmentEmailResponse {
6253
+ interface AuthorizationVoid {
6254
+ /** Status of this void action */
6255
+ status?: AuthorizationVoidStatusWithLiterals;
6256
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6257
+ voidedDate?: Date | null;
6258
+ /** In case of status is FAILED may contain failure details */
6259
+ failureDetails?: AuthorizationActionFailureDetails;
6260
+ /** Reason of void action */
6261
+ reason?: ReasonWithLiterals;
6178
6262
  }
6179
- interface SendMerchantOrderReceivedPushRequest {
6180
- /**
6181
- * @minLength 1
6182
- * @maxLength 100
6183
- */
6184
- orderId?: string;
6263
+ declare enum AuthorizationVoidStatus {
6264
+ /** Void operation still in progress. */
6265
+ PENDING = "PENDING",
6266
+ /** Void operation succeeded. */
6267
+ SUCCEEDED = "SUCCEEDED",
6268
+ /** Void operation failed. */
6269
+ FAILED = "FAILED"
6185
6270
  }
6186
- interface SendMerchantOrderReceivedPushResponse {
6271
+ /** @enumType */
6272
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6273
+ /** Reason the authorization was voided. */
6274
+ declare enum Reason {
6275
+ /** Authorization was voided by user. */
6276
+ MANUAL = "MANUAL",
6277
+ /** Authorization passed execution date. */
6278
+ SCHEDULED = "SCHEDULED"
6187
6279
  }
6188
- interface PreviewEmailByTypeRequest {
6189
- emailType?: PreviewEmailTypeWithLiterals;
6280
+ /** @enumType */
6281
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6282
+ interface V1ScheduledAction {
6283
+ /** Type of the action. */
6284
+ actionType?: ActionTypeWithLiterals;
6285
+ /** The date and time of the action. */
6286
+ executionDate?: Date | null;
6190
6287
  }
6191
- declare enum PreviewEmailType {
6192
- ORDER_PLACED = "ORDER_PLACED",
6193
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6194
- ORDER_SHIPPED = "ORDER_SHIPPED",
6195
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6288
+ declare enum ActionType {
6289
+ VOID = "VOID",
6290
+ CAPTURE = "CAPTURE"
6196
6291
  }
6197
6292
  /** @enumType */
6198
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6199
- interface PreviewEmailByTypeResponse {
6200
- emailPreview?: string;
6201
- }
6202
- interface PreviewRefundEmailRequest {
6203
- /**
6204
- * @minLength 1
6205
- * @maxLength 100
6206
- */
6207
- orderId?: string;
6208
- /** Refund amount */
6209
- refundAmount?: Price;
6210
- /** Refund business details */
6211
- details?: RefundDetails;
6293
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6294
+ interface Chargeback {
6212
6295
  /**
6213
- * Personal note added to the email (optional)
6214
- * @minLength 1
6215
- * @maxLength 1000
6296
+ * Chargeback ID.
6297
+ * @format GUID
6298
+ * @readonly
6299
+ * @immutable
6216
6300
  */
6217
- customMessage?: string | null;
6301
+ id?: string;
6218
6302
  /**
6219
- * Refund ID. (Optional)
6220
- * @format GUID
6303
+ * Date and time the chargeback was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
6304
+ * @readonly
6305
+ * @immutable
6221
6306
  */
6222
- refundId?: string | null;
6223
- }
6224
- interface PreviewRefundEmailResponse {
6225
- emailPreview?: string;
6226
- }
6227
- interface PreviewCancelEmailRequest {
6307
+ createdDate?: Date | null;
6228
6308
  /**
6229
- * @minLength 1
6230
- * @maxLength 100
6309
+ * Date and time the chargeback was updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
6310
+ * @readonly
6231
6311
  */
6232
- orderId?: string;
6312
+ updatedDate?: Date | null;
6233
6313
  /**
6234
- * Personal note added to the email (optional)
6235
- * @minLength 1
6236
- * @maxLength 1000
6314
+ * Amount.
6315
+ * @readonly
6316
+ * @immutable
6237
6317
  */
6238
- customMessage?: string | null;
6239
- }
6240
- interface PreviewCancelEmailResponse {
6241
- emailPreview?: string;
6242
- }
6243
- interface PreviewCancelRefundEmailRequest {
6318
+ amount?: Price;
6244
6319
  /**
6245
- * @minLength 1
6246
- * @maxLength 100
6320
+ * Reversal amount. Present only when status is REVERSED.
6321
+ * @readonly
6247
6322
  */
6248
- orderId?: string;
6323
+ reversalAmount?: Price;
6249
6324
  /**
6250
- * Personal note added to the email (optional)
6251
- * @minLength 1
6252
- * @maxLength 1000
6325
+ * Status.
6326
+ *
6327
+ * Default: `"APPROVED"`.
6253
6328
  */
6254
- customMessage?: string | null;
6255
- /** Refund amount */
6256
- refundAmount?: Price;
6329
+ status?: ChargebackStatusWithLiterals;
6257
6330
  /**
6258
- * Refund ID. (Optional)
6331
+ * External chargeback ID.
6259
6332
  * @format GUID
6333
+ * @readonly
6334
+ * @immutable
6260
6335
  */
6261
- refundId?: string | null;
6262
- }
6263
- interface PreviewCancelRefundEmailResponse {
6264
- emailPreview?: string;
6265
- }
6266
- interface PreviewBuyerPaymentsReceivedEmailRequest {
6267
- }
6268
- interface PreviewBuyerPaymentsReceivedEmailResponse {
6269
- emailPreview?: string;
6270
- }
6271
- interface PreviewBuyerConfirmationEmailRequest {
6272
- }
6273
- interface PreviewBuyerConfirmationEmailResponse {
6274
- emailPreview?: string;
6275
- }
6276
- interface PreviewBuyerPickupConfirmationEmailRequest {
6277
- }
6278
- interface PreviewBuyerPickupConfirmationEmailResponse {
6279
- emailPreview?: string;
6280
- }
6281
- interface PreviewShippingConfirmationEmailRequest {
6282
- }
6283
- interface PreviewShippingConfirmationEmailResponse {
6284
- emailPreview?: string;
6285
- }
6286
- interface PreviewResendDownloadLinksEmailRequest {
6336
+ externalId?: string | null;
6287
6337
  }
6288
- interface PreviewResendDownloadLinksEmailResponse {
6289
- emailPreview?: string;
6338
+ declare enum ChargebackStatus {
6339
+ /** Chargeback was approved. */
6340
+ APPROVED = "APPROVED",
6341
+ /** Chargeback was reversed. */
6342
+ REVERSED = "REVERSED"
6290
6343
  }
6291
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6292
- /** Emitted on a meta site creation. */
6293
- siteCreated?: SiteCreated;
6294
- /** Emitted on a meta site transfer completion. */
6295
- siteTransferred?: SiteTransferred;
6296
- /** Emitted on a meta site deletion. */
6297
- siteDeleted?: SiteDeleted;
6298
- /** Emitted on a meta site restoration. */
6299
- siteUndeleted?: SiteUndeleted;
6300
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6301
- sitePublished?: SitePublished;
6302
- /** Emitted on a meta site unpublish. */
6303
- siteUnpublished?: SiteUnpublished;
6304
- /** Emitted when meta site is marked as template. */
6305
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6306
- /** Emitted when meta site is marked as a WixSite. */
6307
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6308
- /** Emitted when an application is provisioned (installed). */
6309
- serviceProvisioned?: ServiceProvisioned;
6310
- /** Emitted when an application is removed (uninstalled). */
6311
- serviceRemoved?: ServiceRemoved;
6312
- /** Emitted when meta site name (URL slug) is changed. */
6313
- siteRenamedPayload?: SiteRenamed;
6314
- /** Emitted when meta site was permanently deleted. */
6315
- hardDeleted?: SiteHardDeleted;
6316
- /** Emitted on a namespace change. */
6317
- namespaceChanged?: NamespaceChanged;
6318
- /** Emitted when Studio is attached. */
6319
- studioAssigned?: StudioAssigned;
6320
- /** Emitted when Studio is detached. */
6321
- studioUnassigned?: StudioUnassigned;
6344
+ /** @enumType */
6345
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6346
+ interface PaymentMethodName {
6322
6347
  /**
6323
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6324
- * the actual URL.
6325
- *
6326
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6327
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6348
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6349
+ * @maxLength 150
6328
6350
  */
6329
- urlChanged?: SiteUrlChanged;
6330
- /** Site is marked as PurgedExternally */
6331
- sitePurgedExternally?: SitePurgedExternally;
6332
- /** Emitted when Odeditor is attached. */
6333
- odeditorAssigned?: OdeditorAssigned;
6334
- /** Emitted when Odeditor is detached. */
6335
- odeditorUnassigned?: OdeditorUnassigned;
6336
- /** Emitted when Picasso is attached. */
6337
- picassoAssigned?: PicassoAssigned;
6338
- /** Emitted when Picasso is detached. */
6339
- picassoUnassigned?: PicassoUnassigned;
6340
- /** Emitted when Wixel is attached. */
6341
- wixelAssigned?: WixelAssigned;
6342
- /** Emitted when Wixel is detached. */
6343
- wixelUnassigned?: WixelUnassigned;
6344
- /** Emitted when StudioTwo is attached. */
6345
- studioTwoAssigned?: StudioTwoAssigned;
6346
- /** Emitted when StudioTwo is detached. */
6347
- studioTwoUnassigned?: StudioTwoUnassigned;
6348
- /** Emitted when media from user domain is enabled. */
6349
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6350
- /** Emitted when media from user domain is disabled. */
6351
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6352
- /** Emitted when Editorless is attached. */
6353
- editorlessAssigned?: EditorlessAssigned;
6354
- /** Emitted when Editorless is detached. */
6355
- editorlessUnassigned?: EditorlessUnassigned;
6351
+ buyerLanguageName?: string | null;
6356
6352
  /**
6357
- * A meta site id.
6358
- * @format GUID
6353
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6354
+ *
6355
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6356
+ * @maxLength 150
6359
6357
  */
6360
- metaSiteId?: string;
6361
- /** A meta site version. Monotonically increasing. */
6362
- version?: string;
6363
- /** A timestamp of the event. */
6364
- timestamp?: string;
6358
+ siteLanguageName?: string | null;
6365
6359
  /**
6366
- * TODO(meta-site): Change validation once validations are disabled for consumers
6367
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6368
- * @maxSize 4000
6360
+ * User-provided payment method name.
6361
+ *
6362
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6369
6363
  */
6370
- assets?: Asset[];
6364
+ userDefinedName?: UserDefinedPaymentMethodName;
6371
6365
  }
6372
- /** @oneof */
6373
- interface MetaSiteSpecialEventPayloadOneOf {
6374
- /** Emitted on a meta site creation. */
6375
- siteCreated?: SiteCreated;
6376
- /** Emitted on a meta site transfer completion. */
6377
- siteTransferred?: SiteTransferred;
6378
- /** Emitted on a meta site deletion. */
6379
- siteDeleted?: SiteDeleted;
6380
- /** Emitted on a meta site restoration. */
6381
- siteUndeleted?: SiteUndeleted;
6382
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6383
- sitePublished?: SitePublished;
6384
- /** Emitted on a meta site unpublish. */
6385
- siteUnpublished?: SiteUnpublished;
6386
- /** Emitted when meta site is marked as template. */
6387
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6388
- /** Emitted when meta site is marked as a WixSite. */
6389
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6390
- /** Emitted when an application is provisioned (installed). */
6391
- serviceProvisioned?: ServiceProvisioned;
6392
- /** Emitted when an application is removed (uninstalled). */
6393
- serviceRemoved?: ServiceRemoved;
6394
- /** Emitted when meta site name (URL slug) is changed. */
6395
- siteRenamedPayload?: SiteRenamed;
6396
- /** Emitted when meta site was permanently deleted. */
6397
- hardDeleted?: SiteHardDeleted;
6398
- /** Emitted on a namespace change. */
6399
- namespaceChanged?: NamespaceChanged;
6400
- /** Emitted when Studio is attached. */
6401
- studioAssigned?: StudioAssigned;
6402
- /** Emitted when Studio is detached. */
6403
- studioUnassigned?: StudioUnassigned;
6366
+ interface GiftCardPaymentDetails {
6367
+ /**
6368
+ * Gift card payment ID.
6369
+ * @maxLength 100
6370
+ */
6371
+ giftCardPaymentId?: string;
6372
+ /**
6373
+ * Gift card ID.
6374
+ * @internal
6375
+ * @deprecated
6376
+ */
6377
+ giftCardId?: string;
6404
6378
  /**
6405
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6406
- * the actual URL.
6407
- *
6408
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6409
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6379
+ * ID of the app that created the gift card.
6380
+ * @format GUID
6410
6381
  */
6411
- urlChanged?: SiteUrlChanged;
6412
- /** Site is marked as PurgedExternally */
6413
- sitePurgedExternally?: SitePurgedExternally;
6414
- /** Emitted when Odeditor is attached. */
6415
- odeditorAssigned?: OdeditorAssigned;
6416
- /** Emitted when Odeditor is detached. */
6417
- odeditorUnassigned?: OdeditorUnassigned;
6418
- /** Emitted when Picasso is attached. */
6419
- picassoAssigned?: PicassoAssigned;
6420
- /** Emitted when Picasso is detached. */
6421
- picassoUnassigned?: PicassoUnassigned;
6422
- /** Emitted when Wixel is attached. */
6423
- wixelAssigned?: WixelAssigned;
6424
- /** Emitted when Wixel is detached. */
6425
- wixelUnassigned?: WixelUnassigned;
6426
- /** Emitted when StudioTwo is attached. */
6427
- studioTwoAssigned?: StudioTwoAssigned;
6428
- /** Emitted when StudioTwo is detached. */
6429
- studioTwoUnassigned?: StudioTwoUnassigned;
6430
- /** Emitted when media from user domain is enabled. */
6431
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6432
- /** Emitted when media from user domain is disabled. */
6433
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6434
- /** Emitted when Editorless is attached. */
6435
- editorlessAssigned?: EditorlessAssigned;
6436
- /** Emitted when Editorless is detached. */
6437
- editorlessUnassigned?: EditorlessUnassigned;
6438
- }
6439
- interface Asset {
6382
+ appId?: string;
6440
6383
  /**
6441
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6442
- * @maxLength 36
6384
+ * Whether the gift card is voided.
6385
+ * @readonly
6386
+ * @deprecated Whether the gift card is voided.
6387
+ * @replacedBy payment.status
6388
+ * @targetRemovalDate 2026-11-01
6443
6389
  */
6444
- appDefId?: string;
6390
+ voided?: boolean;
6445
6391
  /**
6446
- * An instance id. For legacy reasons may be UUID or a string.
6392
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6393
+ * @maxLength 30
6394
+ * @immutable
6395
+ */
6396
+ obfuscatedCode?: string | null;
6397
+ }
6398
+ interface MembershipPaymentDetails {
6399
+ /**
6400
+ * Membership ID.
6447
6401
  * @maxLength 200
6448
6402
  */
6449
- instanceId?: string;
6450
- /** An application state. */
6451
- state?: StateWithLiterals;
6403
+ membershipId?: string;
6404
+ /**
6405
+ * ID of the line item this membership applies to.
6406
+ * @minLength 1
6407
+ * @maxLength 100
6408
+ */
6409
+ lineItemId?: string;
6410
+ /**
6411
+ * Payment status.
6412
+ * @deprecated Payment status.
6413
+ * @replacedBy payment.status
6414
+ * @targetRemovalDate 2026-11-01
6415
+ */
6416
+ status?: MembershipPaymentStatusWithLiterals;
6417
+ /** Membership name. */
6418
+ name?: MembershipName;
6419
+ /**
6420
+ * The transaction ID in the membership system. Can be used to void the transaction.
6421
+ * @minLength 1
6422
+ * @maxLength 100
6423
+ */
6424
+ externalTransactionId?: string | null;
6425
+ /**
6426
+ * Whether the membership is voided.
6427
+ * @readonly
6428
+ * @deprecated Whether the membership is voided.
6429
+ * @replacedBy payment.status
6430
+ * @targetRemovalDate 2026-11-01
6431
+ */
6432
+ voided?: boolean;
6433
+ /**
6434
+ * ID of the application providing this payment option.
6435
+ * @format GUID
6436
+ */
6437
+ providerAppId?: string;
6438
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6439
+ futureMembership?: FutureMembershipDetails;
6452
6440
  }
6453
- declare enum State {
6454
- UNKNOWN = "UNKNOWN",
6455
- ENABLED = "ENABLED",
6456
- DISABLED = "DISABLED",
6457
- PENDING = "PENDING",
6458
- DEMO = "DEMO"
6441
+ declare enum MembershipPaymentStatus {
6442
+ /** Payment was charged. */
6443
+ CHARGED = "CHARGED",
6444
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
6445
+ CHARGE_FAILED = "CHARGE_FAILED",
6446
+ /** Payment is pending. */
6447
+ CHARGE_PENDING = "CHARGE_PENDING",
6448
+ /** Payment was voided. */
6449
+ VOIDED = "VOIDED"
6459
6450
  }
6460
6451
  /** @enumType */
6461
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6462
- interface SiteCreated {
6452
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6453
+ interface FutureMembershipDetails {
6463
6454
  /**
6464
- * A template identifier (empty if not created from a template).
6465
- * @maxLength 36
6455
+ * ID of the plan line item in the order from which the membership will be created.
6456
+ * @format GUID
6466
6457
  */
6467
- originTemplateId?: string;
6458
+ lineItemId?: string;
6468
6459
  /**
6469
- * An account id of the owner.
6470
- * @format GUID
6460
+ * ID of the benefit the future membership will grant.
6461
+ * @maxLength 200
6471
6462
  */
6472
- ownerId?: string;
6473
- /** A context in which meta site was created. */
6474
- context?: SiteCreatedContextWithLiterals;
6463
+ benefitId?: string;
6464
+ }
6465
+ interface WixReceiptInfo {
6475
6466
  /**
6476
- * A meta site id from which this site was created.
6477
- *
6478
- * In case of a creation from a template it's a template id.
6479
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6467
+ * Receipt ID
6480
6468
  * @format GUID
6481
6469
  */
6482
- originMetaSiteId?: string | null;
6470
+ receiptId?: string;
6483
6471
  /**
6484
- * A meta site name (URL slug).
6485
- * @maxLength 20
6472
+ * Display number of receipt
6473
+ * @minLength 1
6474
+ * @maxLength 40
6486
6475
  */
6487
- siteName?: string;
6488
- /** A namespace. */
6489
- namespace?: NamespaceWithLiterals;
6490
- }
6491
- declare enum SiteCreatedContext {
6492
- /** A valid option, we don't expose all reasons why site might be created. */
6493
- OTHER = "OTHER",
6494
- /** A meta site was created from template. */
6495
- FROM_TEMPLATE = "FROM_TEMPLATE",
6496
- /** A meta site was created by copying of the transfferred meta site. */
6497
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6498
- /** A copy of existing meta site. */
6499
- DUPLICATE = "DUPLICATE",
6500
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6501
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6502
- /** deprecated A meta site was created for Flash editor. */
6503
- FLASH = "FLASH"
6476
+ displayNumber?: string | null;
6504
6477
  }
6505
- /** @enumType */
6506
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6507
- declare enum Namespace {
6508
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6509
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6510
- WIX = "WIX",
6511
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6512
- SHOUT_OUT = "SHOUT_OUT",
6513
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6514
- ALBUMS = "ALBUMS",
6515
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6516
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6517
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6518
- HOTELS = "HOTELS",
6519
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6520
- CLUBS = "CLUBS",
6521
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6522
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6478
+ interface ExternalReceiptInfo {
6523
6479
  /**
6524
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6525
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6480
+ * External receipt ID
6481
+ * @maxLength 100
6526
6482
  */
6527
- DEV_SITE = "DEV_SITE",
6528
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6529
- LOGOS = "LOGOS",
6530
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6531
- VIDEO_MAKER = "VIDEO_MAKER",
6532
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6533
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6534
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6535
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6483
+ receiptId?: string | null;
6536
6484
  /**
6537
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6538
- *
6539
- * Meta site with this namespace will *not* be shown in a user's site list by default.
6485
+ * ID of the app providing the receipt
6486
+ * @format GUID
6540
6487
  */
6541
- HTML_DRAFT = "HTML_DRAFT",
6488
+ appId?: string | null;
6542
6489
  /**
6543
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6544
- * Will be accessible from Site List and will not have a website app.
6545
- * Once the user attaches a site, the site will become a regular wixsite.
6490
+ * Display number of receipt
6491
+ * @minLength 1
6492
+ * @maxLength 40
6546
6493
  */
6547
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
6548
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6549
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
6550
- /** It is to be used in the Business First efforts. */
6551
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
6552
- /** Bookings business flow with no site. */
6553
- ANYWHERE = "ANYWHERE",
6554
- /** Namespace for Headless Backoffice with no editor */
6555
- HEADLESS = "HEADLESS",
6494
+ displayNumber?: string | null;
6495
+ }
6496
+ interface CashRoundingDetails {
6556
6497
  /**
6557
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6558
- * The site will be used for account level CSM feature for enterprise
6498
+ * Payment amount before cash rounding was applied.
6499
+ * When provided, balance and status calculations use this value instead of `amount`
6500
+ * to prevent false overpayment or underpayment due to rounding.
6559
6501
  */
6560
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6561
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6562
- RISE = "RISE",
6502
+ unroundedAmount?: Price;
6503
+ /**
6504
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6505
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6506
+ * @readonly
6507
+ */
6508
+ roundingAdjustment?: CashRounding;
6509
+ }
6510
+ declare enum PaymentStatus {
6511
+ /** Payment was charged successfully. */
6512
+ APPROVED = "APPROVED",
6513
+ /** Payment is being processed and hasn't been confirmed yet. */
6514
+ PENDING = "PENDING",
6515
+ /** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
6516
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6517
+ /** Payment was canceled before it was charged. */
6518
+ CANCELED = "CANCELED",
6519
+ /** Payment was declined by the payment provider. */
6520
+ DECLINED = "DECLINED",
6521
+ /** Payment was fully refunded. */
6522
+ REFUNDED = "REFUNDED",
6523
+ /** Part of the payment amount was refunded. */
6524
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6525
+ /** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
6526
+ AUTHORIZED = "AUTHORIZED",
6563
6527
  /**
6564
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6565
- * There's a blank site behind the scene but it's blank).
6566
- * The Mobile company will be the owner of this namespace.
6528
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6529
+ *
6530
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6567
6531
  */
6568
- BRANDED_FIRST = "BRANDED_FIRST",
6569
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6570
- NOWNIA = "NOWNIA",
6532
+ VOIDED = "VOIDED"
6533
+ }
6534
+ /** @enumType */
6535
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6536
+ interface CanceledStatusDetails {
6537
+ reason?: CanceledReasonWithLiterals;
6538
+ }
6539
+ declare enum CanceledReason {
6540
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
6541
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6542
+ /** Payment was not completed by user and expired. */
6543
+ EXPIRED = "EXPIRED"
6544
+ }
6545
+ /** @enumType */
6546
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6547
+ interface DeclinedStatusDetails {
6548
+ reason?: DeclinedReasonWithLiterals;
6549
+ }
6550
+ declare enum DeclinedReason {
6551
+ /** Corresponding charge failed. */
6552
+ CHARGE_FAILED = "CHARGE_FAILED",
6553
+ /** Payment details expired. */
6554
+ EXPIRED = "EXPIRED",
6555
+ /** Insufficient funds. */
6556
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6557
+ /** Gift card was disabled before charge was attempted. */
6558
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6559
+ }
6560
+ /** @enumType */
6561
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6562
+ interface VoidedStatusDetails {
6563
+ reason?: VoidedReasonWithLiterals;
6564
+ }
6565
+ declare enum VoidedReason {
6566
+ /** Payment was voided by merchant request. */
6567
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6568
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6569
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6570
+ }
6571
+ /** @enumType */
6572
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6573
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6574
+ /** @internal */
6575
+ canceled?: CanceledStatusDetails;
6576
+ /** @internal */
6577
+ declined?: DeclinedStatusDetails;
6578
+ /** @internal */
6579
+ voided?: VoidedStatusDetails;
6571
6580
  /**
6572
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
6573
- * The Partners company owns this namespace.
6581
+ * Reason code from the payment gateway.
6582
+ * @internal
6583
+ * @minLength 1
6584
+ * @maxLength 10
6574
6585
  */
6575
- UGC_TEMPLATE = "UGC_TEMPLATE",
6576
- /** Codux Headless Sites */
6577
- CODUX = "CODUX",
6578
- /** Bobb - AI Design Creator. */
6579
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6586
+ paymentGatewayReasonCode?: string | null;
6587
+ }
6588
+ /** @oneof */
6589
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6590
+ /** @internal */
6591
+ canceled?: CanceledStatusDetails;
6592
+ /** @internal */
6593
+ declined?: DeclinedStatusDetails;
6594
+ /** @internal */
6595
+ voided?: VoidedStatusDetails;
6596
+ }
6597
+ interface Refund {
6580
6598
  /**
6581
- * Shared Blog Site is a unique single site across Enterprise account,
6582
- * This site will hold all Blog posts related to the Marketing product.
6599
+ * Refund ID.
6600
+ * @format GUID
6601
+ * @readonly
6583
6602
  */
6584
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6585
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6586
- STANDALONE_FORMS = "STANDALONE_FORMS",
6587
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6588
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
6589
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6590
- MIMIR = "MIMIR",
6591
- /** Wix Twins platform. */
6592
- TWINS = "TWINS",
6593
- /** Wix Nano. */
6594
- NANO = "NANO",
6595
- /** Base44 headless sites. */
6596
- BASE44 = "BASE44",
6597
- /** Wix Channels Sites */
6598
- CHANNELS = "CHANNELS",
6599
- /** Nautilus platform. */
6600
- NAUTILUS = "NAUTILUS",
6603
+ id?: string;
6601
6604
  /**
6602
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6603
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6605
+ * List of transactions.
6606
+ * @maxSize 50
6604
6607
  */
6605
- SYMPHONY = "SYMPHONY",
6606
- /** Nautilus platform app. */
6607
- NAUTILUS_APPS = "NAUTILUS_APPS",
6608
+ transactions?: RefundTransaction[];
6609
+ /** Refund business details. */
6610
+ details?: RefundDetails;
6608
6611
  /**
6609
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6610
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6612
+ * Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
6613
+ * @readonly
6614
+ * @immutable
6611
6615
  */
6612
- VIBU = "VIBU",
6616
+ createdDate?: Date | null;
6613
6617
  /**
6614
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6615
- * (an Enterprise account may have several), holding that BrandKit's brand definition
6616
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6617
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
6618
+ * Aggregated refund summary.
6619
+ * @readonly
6618
6620
  */
6619
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6621
+ summary?: AggregatedRefundSummary;
6620
6622
  /**
6621
- * Dev-center development sites (com.wixpress.devcenter.dsm).
6622
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6623
+ * ID of the app that initiated this refund.
6624
+ * @format GUID
6625
+ * @readonly
6626
+ * @immutable
6623
6627
  */
6624
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6628
+ requestingServiceAppId?: string | null;
6625
6629
  }
6626
- /** @enumType */
6627
- type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
6628
- /** Site transferred to another user. */
6629
- interface SiteTransferred {
6630
+ interface RefundTransaction {
6630
6631
  /**
6631
- * A previous owner id (user that transfers meta site).
6632
+ * ID of the payment associated with this refund.
6632
6633
  * @format GUID
6634
+ * @immutable
6633
6635
  */
6634
- oldOwnerId?: string;
6636
+ paymentId?: string;
6635
6637
  /**
6636
- * A new owner id (user that accepts meta site).
6638
+ * Refund amount.
6639
+ * @immutable
6640
+ */
6641
+ amount?: Price;
6642
+ /** Refund status. */
6643
+ refundStatus?: RefundStatusWithLiterals;
6644
+ /** Optional details of current refund status. */
6645
+ refundStatusInfo?: RefundStatusInfo;
6646
+ /**
6647
+ * Payment gateway's refund ID.
6648
+ * This field is only returned when the value of `external_refund` is `false`.
6637
6649
  * @format GUID
6638
6650
  */
6639
- newOwnerId?: string;
6640
- }
6641
- /** Soft deletion of the meta site. Could be restored. */
6642
- interface SiteDeleted {
6643
- /** A deletion context. */
6644
- deleteContext?: DeleteContext;
6645
- }
6646
- interface DeleteContext {
6647
- /** When the meta site was deleted. */
6648
- dateDeleted?: Date | null;
6649
- /** A status. */
6650
- deleteStatus?: DeleteStatusWithLiterals;
6651
+ gatewayRefundId?: string | null;
6652
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6653
+ providerRefundId?: string | null;
6651
6654
  /**
6652
- * A reason (flow).
6653
- * @maxLength 255
6655
+ * Whether refund was made externally and manually on the payment provider's side.
6656
+ * @immutable
6654
6657
  */
6655
- deleteOrigin?: string;
6658
+ externalRefund?: boolean;
6656
6659
  /**
6657
- * A service that deleted it.
6658
- * @maxLength 255
6660
+ * Location where the refund was processed.
6661
+ * @internal
6662
+ * @format GUID
6663
+ * @immutable
6659
6664
  */
6660
- initiatorId?: string | null;
6665
+ locationId?: string | null;
6661
6666
  }
6662
- declare enum DeleteStatus {
6663
- UNKNOWN = "UNKNOWN",
6664
- TRASH = "TRASH",
6665
- DELETED = "DELETED",
6666
- PENDING_PURGE = "PENDING_PURGE",
6667
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6667
+ /** Refund transaction status. */
6668
+ declare enum RefundStatus {
6669
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6670
+ PENDING = "PENDING",
6671
+ /** Refund transaction succeeded. */
6672
+ SUCCEEDED = "SUCCEEDED",
6673
+ /** Refund transaction failed. */
6674
+ FAILED = "FAILED",
6675
+ /** Refund request acknowledged, and will be executed soon. */
6676
+ SCHEDULED = "SCHEDULED",
6677
+ /** Refund was initiated on payment provider side. */
6678
+ STARTED = "STARTED"
6668
6679
  }
6669
6680
  /** @enumType */
6670
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6671
- /** Restoration of the meta site. */
6672
- interface SiteUndeleted {
6673
- }
6674
- /** First publish of a meta site. Or subsequent publish after unpublish. */
6675
- interface SitePublished {
6676
- }
6677
- interface SiteUnpublished {
6681
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6682
+ interface RefundStatusInfo {
6678
6683
  /**
6679
- * A list of URLs previously associated with the meta site.
6680
- * @maxLength 4000
6681
- * @maxSize 10000
6684
+ * Reason code for the refund's current status.
6685
+ *
6686
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6687
+ * @minLength 1
6688
+ * @maxLength 10
6682
6689
  */
6683
- urls?: string[];
6684
- }
6685
- interface SiteMarkedAsTemplate {
6686
- }
6687
- interface SiteMarkedAsWixSite {
6690
+ paymentGatewayReasonCode?: string | null;
6691
+ /**
6692
+ * Free text explanation of current refund status.
6693
+ * @minLength 1
6694
+ * @maxLength 1000
6695
+ */
6696
+ description?: string | null;
6688
6697
  }
6689
- /**
6690
- * Represents a service provisioned a site.
6691
- *
6692
- * Note on `origin_instance_id`:
6693
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6694
- * This is because of the following scenario:
6695
- *
6696
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
6697
- * such as a product catalog. When you create a site from this template, you inherit this
6698
- * default product catalog. However, if the template's product catalog is modified,
6699
- * your site will retain the catalog as it was at the time of site creation. This ensures that
6700
- * your site remains consistent with what you initially received and does not include any
6701
- * changes made to the original template afterward.
6702
- * To ensure this, the TPA on the template gets a new instance_id.
6703
- */
6704
- interface ServiceProvisioned {
6698
+ interface AggregatedRefundSummary {
6699
+ /** Total amount requested for refund. */
6700
+ requestedRefund?: Price;
6701
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6702
+ pendingRefund?: Price;
6703
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6704
+ refunded?: Price;
6705
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6706
+ failedRefundAmount?: Price;
6707
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6708
+ pending?: boolean;
6709
+ /** Breakdown of refunded items. Available only after refund is complete. */
6710
+ breakdown?: RefundItemsBreakdown;
6711
+ }
6712
+ interface RefundItemsBreakdown {
6705
6713
  /**
6706
- * Either UUID or EmbeddedServiceType.
6707
- * @maxLength 36
6714
+ * Refunded line items and the amount refunded for each.
6715
+ * @maxSize 300
6708
6716
  */
6709
- appDefId?: string;
6717
+ lineItems?: LineItemRefundSummary[];
6718
+ }
6719
+ interface LineItemRefundSummary {
6710
6720
  /**
6711
- * Not only UUID. Something here could be something weird.
6712
- * @maxLength 36
6721
+ * ID of the refunded line item.
6722
+ * @format GUID
6713
6723
  */
6714
- instanceId?: string;
6724
+ lineItemId?: string;
6725
+ /** Total refunded amount for the line item. */
6726
+ totalRefundedAmount?: Price;
6727
+ }
6728
+ interface CalculateRefundRequest {
6715
6729
  /**
6716
- * An instance id from which this instance is originated.
6717
- * @maxLength 36
6730
+ * Order ID
6731
+ * @minLength 1
6732
+ * @maxLength 100
6718
6733
  */
6719
- originInstanceId?: string;
6734
+ ecomOrderId?: string;
6720
6735
  /**
6721
- * A version.
6722
- * @maxLength 500
6736
+ * Refunded line items and quantity
6737
+ * @maxSize 300
6723
6738
  */
6724
- version?: string | null;
6739
+ refundItems?: CalculateRefundItemRequest[];
6740
+ /** Should include shipping in refund calculation */
6741
+ refundShipping?: boolean;
6742
+ }
6743
+ interface CalculateRefundItemRequest {
6725
6744
  /**
6726
- * The origin meta site id
6745
+ * ID of the line item being refunded
6727
6746
  * @format GUID
6728
6747
  */
6729
- originMetaSiteId?: string | null;
6730
- }
6731
- interface ServiceRemoved {
6748
+ id?: string;
6732
6749
  /**
6733
- * Either UUID or EmbeddedServiceType.
6734
- * @maxLength 36
6750
+ * How much of that line item is being refunded
6751
+ * @min 1
6752
+ * @max 100000
6735
6753
  */
6736
- appDefId?: string;
6754
+ quantity?: number;
6755
+ }
6756
+ interface CalculateRefundResponse {
6757
+ /** Total refundable amount */
6758
+ total?: Price;
6759
+ /** Tax cost of the order */
6760
+ tax?: Price;
6761
+ /** Discount given for this order */
6762
+ discount?: Price;
6763
+ /** Total cost of the order (without tax) */
6764
+ subtotal?: Price;
6765
+ /** Total shipping cost for order */
6766
+ shipping?: Price;
6767
+ /** Previous refund given on that order */
6768
+ previouslyRefundedAmount?: Price;
6737
6769
  /**
6738
- * Not only UUID. Something here could be something weird.
6739
- * @maxLength 36
6770
+ * The refundable items of that order
6771
+ * @maxSize 300
6740
6772
  */
6741
- instanceId?: string;
6773
+ items?: CalculateRefundItemResponse[];
6774
+ }
6775
+ interface CalculateRefundItemResponse {
6742
6776
  /**
6743
- * A version.
6744
- * @maxLength 500
6777
+ * Line item ID
6778
+ * @format GUID
6745
6779
  */
6746
- version?: string | null;
6780
+ id?: string;
6781
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6782
+ price?: Price;
6747
6783
  }
6748
- /** Rename of the site. Meaning, free public url has been changed as well. */
6749
- interface SiteRenamed {
6784
+ interface VoidAuthorizedPaymentsRequest {
6750
6785
  /**
6751
- * A new meta site name (URL slug).
6752
- * @maxLength 20
6786
+ * Wix eCommerce order ID
6787
+ * @minLength 1
6788
+ * @maxLength 100
6753
6789
  */
6754
- newSiteName?: string;
6790
+ ecomOrderId: string;
6755
6791
  /**
6756
- * A previous meta site name (URL slug).
6757
- * @maxLength 255
6792
+ * Payment IDs
6793
+ * @minSize 1
6794
+ * @maxSize 100
6795
+ * @format GUID
6758
6796
  */
6759
- oldSiteName?: string;
6760
- }
6761
- /**
6762
- * Hard deletion of the meta site.
6763
- *
6764
- * Could not be restored. Therefore it's desirable to cleanup data.
6765
- */
6766
- interface SiteHardDeleted {
6767
- /** A deletion context. */
6768
- deleteContext?: DeleteContext;
6769
- }
6770
- interface NamespaceChanged {
6771
- /** A previous namespace. */
6772
- oldNamespace?: NamespaceWithLiterals;
6773
- /** A new namespace. */
6774
- newNamespace?: NamespaceWithLiterals;
6775
- }
6776
- /** Assigned Studio editor */
6777
- interface StudioAssigned {
6778
- }
6779
- /** Unassigned Studio editor */
6780
- interface StudioUnassigned {
6797
+ paymentIds: string[];
6781
6798
  }
6782
- /**
6783
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6784
- *
6785
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6786
- * with sites and its urls, you need to listen to another topic/event. Read about it:
6787
- *
6788
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6789
- */
6790
- interface SiteUrlChanged {
6799
+ interface VoidAuthorizedPaymentsResponse {
6800
+ /** All order's transactions after the void was triggered */
6801
+ orderTransactions?: OrderTransactions;
6791
6802
  }
6792
- /**
6793
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6794
- * Consumed by other teams to remove relevant data.
6795
- */
6796
- interface SitePurgedExternally {
6803
+ interface CaptureAuthorizedPaymentsRequest {
6797
6804
  /**
6798
- * @maxLength 2048
6805
+ * Wix eCommerce order ID
6806
+ * @minLength 1
6807
+ * @maxLength 100
6808
+ */
6809
+ ecomOrderId: string;
6810
+ /**
6811
+ * Capture payments information
6812
+ * @minSize 1
6799
6813
  * @maxSize 100
6800
- * @deprecated
6801
- * @targetRemovalDate 2025-04-15
6802
6814
  */
6803
- appDefId?: string[];
6804
- }
6805
- /** Assigned Odeditor */
6806
- interface OdeditorAssigned {
6807
- }
6808
- /** Unassigned Odeditor */
6809
- interface OdeditorUnassigned {
6810
- }
6811
- /** Assigned Picasso editor */
6812
- interface PicassoAssigned {
6813
- }
6814
- /** Unassigned Picasso */
6815
- interface PicassoUnassigned {
6816
- }
6817
- /** Assigned Wixel */
6818
- interface WixelAssigned {
6819
- }
6820
- /** Unassigned Wixel */
6821
- interface WixelUnassigned {
6822
- }
6823
- /** Assigned StudioTwo */
6824
- interface StudioTwoAssigned {
6825
- }
6826
- /** Unassigned StudioTwo */
6827
- interface StudioTwoUnassigned {
6828
- }
6829
- /** Media from user domain is enabled. */
6830
- interface UserDomainMediaEnabled {
6831
- }
6832
- /** Media from user domain is disabled. */
6833
- interface UserDomainMediaDisabled {
6834
- }
6835
- /** Assigned Editorless */
6836
- interface EditorlessAssigned {
6837
- }
6838
- /** Unassigned Editorless */
6839
- interface EditorlessUnassigned {
6815
+ payments: PaymentCapture[];
6840
6816
  }
6841
- interface HasCustomEmailConfigurationsRequest {
6817
+ interface PaymentCapture {
6818
+ /**
6819
+ * Payment ID
6820
+ * @format GUID
6821
+ */
6822
+ paymentId?: string | null;
6823
+ /**
6824
+ * Capture amount.
6825
+ * If not provided - full authorized amount will be captured.
6826
+ */
6827
+ amount?: Price;
6842
6828
  }
6843
- interface HasCustomEmailConfigurationsResponse {
6844
- hasCustomConfigurations?: boolean;
6829
+ interface CaptureAuthorizedPaymentsResponse {
6830
+ /** All order's transactions after the capture was triggered */
6831
+ orderTransactions?: OrderTransactions;
6845
6832
  }
6846
- interface AddToAutomationMigrationPopulationRequest {
6847
- /** When true, sends custom email configurations to automation system via email */
6848
- sendCustomEmailConfigs?: boolean;
6849
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6850
- origin?: OriginWithLiterals;
6833
+ interface ChargeSavedPaymentMethodRequest {
6834
+ /**
6835
+ * Ecom Order ID.
6836
+ * @minLength 1
6837
+ * @maxLength 100
6838
+ */
6839
+ ecomOrderId?: string;
6840
+ /** Amount to be charged */
6841
+ amount?: Price;
6851
6842
  }
6852
- declare enum Origin {
6853
- OPT_IN = "OPT_IN",
6854
- MIGRATION = "MIGRATION"
6843
+ interface ChargeSavedPaymentMethodResponse {
6844
+ /** Payment gateway's order ID (e.g Wix Payments) */
6845
+ paymentGatewayOrderId?: string;
6855
6846
  }
6856
- /** @enumType */
6857
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6858
- interface AddToAutomationMigrationPopulationResponse {
6859
- success?: boolean;
6847
+ interface V1TriggerReindexRequest {
6848
+ /** @format GUID */
6849
+ metasiteId?: string;
6850
+ /**
6851
+ * @minLength 1
6852
+ * @maxLength 100
6853
+ * @maxSize 100
6854
+ */
6855
+ orderIds?: string[];
6860
6856
  }
6861
- interface IsInAutomationMigrationPopulationRequest {
6857
+ interface V1TriggerReindexResponse {
6862
6858
  }
6863
- interface IsInAutomationMigrationPopulationResponse {
6864
- inPopulation?: boolean;
6859
+ interface V1TriggerReindexOrderRequest {
6860
+ /** @format GUID */
6861
+ metasiteId?: string;
6862
+ /**
6863
+ * @minLength 1
6864
+ * @maxLength 100
6865
+ */
6866
+ orderId?: string;
6865
6867
  }
6866
6868
  interface DiffmatokyPayload {
6867
6869
  left?: string;