@wix/auto_sdk_ecom_orders 1.0.326 → 1.0.328

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-CioVnQwu.d.ts → ecom-v1-order-orders.universal-BmHEmYb8.d.ts} +1689 -1678
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +80 -82
  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 -82
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1689 -1678
  9. package/build/cjs/meta.js +80 -82
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-CioVnQwu.d.mts → ecom-v1-order-orders.universal-BmHEmYb8.d.mts} +1689 -1678
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +80 -82
  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 -82
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1689 -1678
  19. package/build/es/meta.mjs +80 -82
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-aVj7Mb1n.d.ts → ecom-v1-order-orders.universal-BAracj8P.d.ts} +1833 -1837
  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 +1828 -1841
  25. package/build/internal/es/{ecom-v1-order-orders.universal-aVj7Mb1n.d.mts → ecom-v1-order-orders.universal-BAracj8P.d.mts} +1833 -1837
  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 +1828 -1841
  29. package/package.json +4 -4
@@ -1,4 +1,4 @@
1
- import { eB as ImportOrderRequest$1, I as ImportOrderResponse$1, eC as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, eD as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, eH as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, eL as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, eM as RecordManuallyCollectedPaymentRequest$1, eP as RecordManuallyCollectedPaymentResponse$1, eQ as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, eR as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, eW as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, eZ as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, e$ as ChargeMembershipsRequest$1, f2 as ChargeMembershipsResponse$1, f3 as TriggerRefundRequest$1, p as TriggerRefundResponse$1, fM as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fN as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, h5 as GetOrderRequest$1, h6 as GetOrderResponse$1, hi as SearchOrdersRequest$1, x as SearchOrdersResponse$1, hm as CreateOrderRequest$1, hq as CreateOrderResponse$1, hr as UpdateOrderRequest$1, hs as UpdateOrderResponse$1, ht as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hY as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ip as AddActivityRequest$1, N as AddActivityResponse$1, ir as AddActivitiesRequest$1, W as AddActivitiesResponse$1, is as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, it as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, iz as CancelOrderRequest$1, a0 as CancelOrderResponse$1, iA as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iY as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, j0 as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-aVj7Mb1n.mjs';
1
+ import { eB as ImportOrderRequest$1, I as ImportOrderResponse$1, eC as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, eD as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, fY as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, g0 as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, g1 as RecordManuallyCollectedPaymentRequest$1, g4 as RecordManuallyCollectedPaymentResponse$1, g5 as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, g6 as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, gb as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, ge as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, gg as ChargeMembershipsRequest$1, gj as ChargeMembershipsResponse$1, gk as TriggerRefundRequest$1, p as TriggerRefundResponse$1, gY as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gZ as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, h5 as GetOrderRequest$1, h6 as GetOrderResponse$1, hi as SearchOrdersRequest$1, x as SearchOrdersResponse$1, hm as CreateOrderRequest$1, hq as CreateOrderResponse$1, hr as UpdateOrderRequest$1, hs as UpdateOrderResponse$1, ht as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hY as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ip as AddActivityRequest$1, N as AddActivityResponse$1, ir as AddActivitiesRequest$1, W as AddActivitiesResponse$1, is as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, it as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, iz as CancelOrderRequest$1, a0 as CancelOrderResponse$1, iA as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iY as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, j0 as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-BAracj8P.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -353,6 +353,15 @@ interface OrderLineItem {
353
353
  * @readonly
354
354
  */
355
355
  priceBeforeDiscountsAndTax?: Price;
356
+ /**
357
+ * Catalog price of a single item, with modifiers, before any discounts.
358
+ * When the item is on sale in the catalog, this is the price before the sale.
359
+ *
360
+ * For the price after the sale but before other discounts, see `priceBeforeDiscounts`.
361
+ * @internal
362
+ * @readonly
363
+ */
364
+ fullPrice?: Price;
356
365
  /**
357
366
  * Total price after discounts, and before tax.
358
367
  * @readonly
@@ -869,10 +878,7 @@ interface LineItemTaxInfo {
869
878
  * @maxSize 7
870
879
  */
871
880
  taxBreakdown?: LineItemTaxBreakdown[];
872
- /**
873
- * Amount of the line item price that was exempt from tax.
874
- * @internal
875
- */
881
+ /** Amount of the line item price that was exempt from tax. */
876
882
  exemptAmount?: Price;
877
883
  }
878
884
  /**
@@ -910,10 +916,7 @@ interface LineItemTaxBreakdown {
910
916
  nonTaxableAmount?: Price;
911
917
  /** Taxable amount of the line item price. */
912
918
  taxableAmount?: Price;
913
- /**
914
- * Amount of the line item price that was exempt from this authority.
915
- * @internal
916
- */
919
+ /** Amount of the line item price that was exempt from this authority. */
917
920
  exemptAmount?: Price;
918
921
  }
919
922
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
@@ -1963,8 +1966,7 @@ interface OrderTaxInfo {
1963
1966
  */
1964
1967
  taxExempt?: boolean | null;
1965
1968
  /**
1966
- * The total amount that was exempt from tax calculations.
1967
- * @internal
1969
+ * Total amount exempt from tax calculations.
1968
1970
  * @readonly
1969
1971
  */
1970
1972
  totalExempt?: Price;
@@ -2010,10 +2012,7 @@ interface OrderTaxBreakdown {
2010
2012
  * @internal
2011
2013
  */
2012
2014
  aggregatedTaxableAmount?: Price;
2013
- /**
2014
- * The aggregated exempt amount from all line items for tax identifiers.
2015
- * @internal
2016
- */
2015
+ /** Total amount exempt from this tax, summed across all line items. */
2017
2016
  aggregatedExemptAmount?: Price;
2018
2017
  }
2019
2018
  /** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
@@ -2193,19 +2192,7 @@ declare enum DiscountValueType {
2193
2192
  * @documentationMaturity preview
2194
2193
  * @internal
2195
2194
  */
2196
- FIXED_AMOUNT = "FIXED_AMOUNT",
2197
- /**
2198
- * The discount sets the price it applies to a fixed amount.
2199
- * @documentationMaturity preview
2200
- * @internal
2201
- */
2202
- FIXED_PRICE = "FIXED_PRICE",
2203
- /**
2204
- * The discount depends on the number of units bought. For example, 3 for $10, or buy 2 get 1 free.
2205
- * @documentationMaturity preview
2206
- * @internal
2207
- */
2208
- QUANTITY_BASED = "QUANTITY_BASED"
2195
+ FIXED_AMOUNT = "FIXED_AMOUNT"
2209
2196
  }
2210
2197
  /** @enumType */
2211
2198
  type DiscountValueTypeWithLiterals = DiscountValueType;
@@ -4904,2328 +4891,2328 @@ interface BulkDeleteImportedOrdersResponse {
4904
4891
  */
4905
4892
  jobId?: string;
4906
4893
  }
4907
- interface V1TriggerReindexRequest {
4894
+ interface SendBuyerConfirmationEmailRequest {
4908
4895
  /** @format GUID */
4909
- metasiteId?: string;
4896
+ orderId?: string;
4897
+ }
4898
+ interface SendBuyerConfirmationEmailResponse {
4899
+ }
4900
+ interface SendBuyerPaymentsReceivedEmailRequest {
4910
4901
  /**
4911
4902
  * @minLength 1
4912
4903
  * @maxLength 100
4913
- * @maxSize 100
4914
4904
  */
4915
- orderIds?: string[];
4905
+ orderId?: string;
4916
4906
  }
4917
- interface V1TriggerReindexResponse {
4907
+ interface SendBuyerPaymentsReceivedEmailResponse {
4918
4908
  }
4919
- interface V1TriggerReindexOrderRequest {
4920
- /** @format GUID */
4921
- metasiteId?: string;
4909
+ interface SendBuyerPickupConfirmationEmailRequest {
4922
4910
  /**
4923
4911
  * @minLength 1
4924
4912
  * @maxLength 100
4925
4913
  */
4926
4914
  orderId?: string;
4927
4915
  }
4928
- interface PreparePaymentCollectionRequest {
4916
+ interface SendBuyerPickupConfirmationEmailResponse {
4917
+ }
4918
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
4919
+ /**
4920
+ * IDs of orders to send pickup emails for.
4921
+ * @minSize 1
4922
+ * @maxSize 300
4923
+ */
4924
+ orderIds?: string[];
4925
+ }
4926
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4927
+ }
4928
+ interface SendBuyerShippingConfirmationEmailRequest {
4929
4929
  /**
4930
- * Ecom order ID.
4931
4930
  * @minLength 1
4932
4931
  * @maxLength 100
4933
4932
  */
4934
- ecomOrderId: string;
4935
- /** Amount to collect */
4936
- amount: Price;
4933
+ orderId?: string;
4934
+ }
4935
+ interface SendBuyerShippingConfirmationEmailResponse {
4936
+ }
4937
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
4937
4938
  /**
4938
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4939
- * Existing payment gateway order will be updated with a new amount.
4940
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4939
+ * IDs of orders to send pickup emails for.
4940
+ * @minSize 1
4941
+ * @maxSize 300
4941
4942
  */
4942
- paymentGatewayOrderId?: string | null;
4943
+ orderIds?: string[];
4944
+ }
4945
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4946
+ }
4947
+ interface SendMerchantOrderReceivedNotificationRequest {
4943
4948
  /**
4944
- * Whether to delay capture of the payment.
4945
- * Default: false
4946
- * @deprecated Whether to delay capture of the payment.
4947
- * Default: false
4948
- * @replacedBy delayed_capture_settings.scheduled_action
4949
- * @targetRemovalDate 2024-09-30
4949
+ * @minLength 1
4950
+ * @maxLength 100
4950
4951
  */
4951
- delayedCapture?: boolean;
4952
+ orderId?: string;
4953
+ }
4954
+ interface SendMerchantOrderReceivedNotificationResponse {
4955
+ }
4956
+ interface SendCancelRefundEmailRequest {
4952
4957
  /**
4953
- * Specifies whether payment collection is initiated by Merchant or User of User
4954
- * Default: `true`
4955
- * @internal
4958
+ * The ID of order that is canceled/refunded
4959
+ * @minLength 1
4960
+ * @maxLength 100
4956
4961
  */
4957
- merchantInitiated?: boolean | null;
4962
+ orderId?: string;
4958
4963
  /**
4959
- * Redirect urls which are used to return buyer to third party system.
4960
- * @internal
4964
+ * Personal note added to the email (optional)
4965
+ * @minLength 1
4966
+ * @maxLength 1000
4961
4967
  */
4962
- redirectUrls?: RedirectUrls;
4963
- /** Delayed capture payment settings */
4964
- delayedCaptureSettings?: DelayedCaptureSettings;
4965
- }
4966
- interface RedirectUrls {
4968
+ customMessage?: string | null;
4969
+ /** Refund amount */
4970
+ refundAmount?: Price;
4967
4971
  /**
4968
- * URL to redirect buyer in case of approved (successful) transaction
4969
- * @format WEB_URL
4972
+ * Refund ID. (Optional)
4973
+ * @format GUID
4970
4974
  */
4971
- successUrl?: string | null;
4975
+ refundId?: string | null;
4976
+ }
4977
+ interface SendCancelRefundEmailResponse {
4978
+ }
4979
+ interface SendRefundEmailRequest {
4972
4980
  /**
4973
- * URL to redirect buyer in case of buyer canceled the transaction
4974
- * @format WEB_URL
4981
+ * The ID of order that is refunded
4982
+ * @format GUID
4975
4983
  */
4976
- cancelUrl?: string | null;
4984
+ orderId?: string;
4977
4985
  /**
4978
- * URL to redirect buyer in case of failed/rejected transaction
4979
- * @format WEB_URL
4986
+ * Refund ID
4987
+ * @format GUID
4980
4988
  */
4981
- errorUrl?: string | null;
4989
+ refundId?: string;
4982
4990
  /**
4983
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4984
- * @format WEB_URL
4991
+ * Personal note added to the email (optional)
4992
+ * @minLength 1
4993
+ * @maxLength 1000
4985
4994
  */
4986
- pendingUrl?: string | null;
4995
+ customMessage?: string | null;
4987
4996
  }
4988
- interface DelayedCaptureSettings {
4989
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4990
- scheduledAction?: ScheduledActionWithLiterals;
4991
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4992
- delayDuration?: Duration;
4997
+ interface SendRefundEmailResponse {
4993
4998
  }
4994
- declare enum ScheduledAction {
4995
- /** Whether payment will be auto-voided when duration passes */
4996
- VOID = "VOID",
4997
- /** Whether payment will be auto-captured when duration passes */
4998
- CAPTURE = "CAPTURE"
4999
+ interface SendFulfillmentEmailRequest {
5000
+ /** @format GUID */
5001
+ orderId?: string;
5002
+ /** @format GUID */
5003
+ fulfillerId?: string;
4999
5004
  }
5000
- /** @enumType */
5001
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5002
- interface Duration {
5005
+ interface SendFulfillmentEmailResponse {
5006
+ }
5007
+ interface SendMerchantOrderReceivedPushRequest {
5003
5008
  /**
5004
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5005
- * @min 1
5009
+ * @minLength 1
5010
+ * @maxLength 100
5006
5011
  */
5007
- count?: number;
5008
- /** Duration unit: MINUTES, HOURS and DAYS */
5009
- unit?: DurationUnitWithLiterals;
5012
+ orderId?: string;
5010
5013
  }
5011
- declare enum DurationUnit {
5012
- MINUTES = "MINUTES",
5013
- HOURS = "HOURS",
5014
- DAYS = "DAYS"
5014
+ interface SendMerchantOrderReceivedPushResponse {
5015
+ }
5016
+ interface PreviewEmailByTypeRequest {
5017
+ emailType?: PreviewEmailTypeWithLiterals;
5018
+ }
5019
+ declare enum PreviewEmailType {
5020
+ ORDER_PLACED = "ORDER_PLACED",
5021
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
5022
+ ORDER_SHIPPED = "ORDER_SHIPPED",
5023
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5015
5024
  }
5016
5025
  /** @enumType */
5017
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5018
- interface PreparePaymentCollectionResponse {
5019
- /** Payment gateway order id which is associated with given payment */
5020
- paymentGatewayOrderId?: string;
5026
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
5027
+ interface PreviewEmailByTypeResponse {
5028
+ emailPreview?: string;
5021
5029
  }
5022
- interface GetPaymentCollectabilityStatusRequest {
5030
+ interface PreviewRefundEmailRequest {
5023
5031
  /**
5024
- * Ecom order ID.
5025
5032
  * @minLength 1
5026
5033
  * @maxLength 100
5027
5034
  */
5028
- ecomOrderId: string;
5029
- }
5030
- interface GetPaymentCollectabilityStatusResponse {
5031
- /** Payment collectability status */
5032
- status?: PaymentCollectabilityStatusWithLiterals;
5033
- /** Collectable order amount */
5034
- amount?: Price;
5035
+ orderId?: string;
5036
+ /** Refund amount */
5037
+ refundAmount?: Price;
5038
+ /** Refund business details */
5039
+ details?: RefundDetails;
5035
5040
  /**
5036
- * Whether authorization supported
5037
- * @internal
5041
+ * Personal note added to the email (optional)
5042
+ * @minLength 1
5043
+ * @maxLength 1000
5038
5044
  */
5039
- authorizationSupported?: boolean;
5045
+ customMessage?: string | null;
5040
5046
  /**
5041
- * Whether custom amount is supported for payment collection
5042
- * @internal
5047
+ * Refund ID. (Optional)
5048
+ * @format GUID
5043
5049
  */
5044
- customAmountSupported?: boolean;
5045
- }
5046
- declare enum PaymentCollectabilityStatus {
5047
- UNKNOWN = "UNKNOWN",
5048
- COLLECTABLE = "COLLECTABLE",
5049
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5050
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5051
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5052
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5053
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5054
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5055
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5056
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5057
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5058
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5059
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5050
+ refundId?: string | null;
5060
5051
  }
5061
- /** @enumType */
5062
- 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';
5063
- interface RecordManuallyCollectedPaymentRequest {
5052
+ /** Business model of a refund request */
5053
+ interface RefundDetails {
5064
5054
  /**
5065
- * Order ID.
5066
- * @minLength 1
5067
- * @maxLength 100
5055
+ * Order line item IDs and quantities that were refunded.
5056
+ * @maxSize 300
5068
5057
  */
5069
- orderId: string;
5070
- /** Amount to be recorded as approved manual payment for given order */
5071
- amount: Price;
5058
+ items?: RefundItem[];
5059
+ /** Whether the shipping fee was also refunded. */
5060
+ shippingIncluded?: boolean;
5072
5061
  /**
5073
- * Payment method name provided by user.
5074
- *
5075
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5076
- * @internal
5062
+ * Reason for the refund, provided by customer (optional).
5063
+ * @maxLength 200
5077
5064
  */
5078
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5079
- }
5080
- /**
5081
- * User-defined payment method name.
5082
- * Allows specifying either a predefined type or a custom name.
5083
- */
5084
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5085
- /** Predefined payment method. */
5086
- predefined?: PredefinedPaymentMethodWithLiterals;
5065
+ reason?: string | null;
5087
5066
  /**
5088
- * Custom payment method name provided by user.
5089
- *
5090
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5091
- * @minLength 1
5092
- * @maxLength 150
5067
+ * Line items that were refunded.
5068
+ * @maxSize 300
5093
5069
  */
5094
- custom?: string | null;
5095
- }
5096
- /** @oneof */
5097
- interface UserDefinedPaymentMethodNameKindOneOf {
5098
- /** Predefined payment method. */
5099
- predefined?: PredefinedPaymentMethodWithLiterals;
5070
+ lineItems?: LineItemRefund[];
5100
5071
  /**
5101
- * Custom payment method name provided by user.
5102
- *
5103
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5104
- * @minLength 1
5105
- * @maxLength 150
5072
+ * Additional fees that were refunded.
5073
+ * @maxSize 100
5106
5074
  */
5107
- custom?: string | null;
5108
- }
5109
- /** Predefined payment method types for offline/manual payments. */
5110
- declare enum PredefinedPaymentMethod {
5111
- /** Cash payment. */
5112
- CASH = "CASH",
5113
- /** Bank transfer. */
5114
- BANK_TRANSFER = "BANK_TRANSFER",
5115
- /** Payment by check. */
5116
- CHECK = "CHECK"
5117
- }
5118
- /** @enumType */
5119
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5120
- interface RecordManuallyCollectedPaymentResponse {
5075
+ additionalFees?: AdditionalFeeRefund[];
5076
+ /** Shipping amount that was refunded. */
5077
+ shipping?: ShippingRefund;
5121
5078
  }
5122
- interface MarkOrderAsPaidRequest {
5079
+ interface RefundItem {
5123
5080
  /**
5124
- * Ecom order ID.
5125
- * @minLength 1
5126
- * @maxLength 100
5081
+ * Line item ID the refunded line item.
5082
+ * @format GUID
5127
5083
  */
5128
- ecomOrderId: string;
5084
+ lineItemId?: string;
5129
5085
  /**
5130
- * Payment method name provided by user.
5131
- *
5132
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5133
- * @internal
5086
+ * Line item quantity refunded.
5087
+ * @min 1
5088
+ * @max 100000
5134
5089
  */
5135
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5136
- }
5137
- interface MarkOrderAsPaidResponse {
5138
- /** Updated order. */
5139
- order?: Order;
5090
+ quantity?: number;
5140
5091
  }
5141
- interface BulkMarkOrdersAsPaidRequest {
5092
+ interface LineItemRefund {
5142
5093
  /**
5143
- * IDs of orders to mark as paid.
5144
- * @minSize 1
5145
- * @maxSize 100
5146
- * @minLength 1
5147
- * @maxLength 100
5094
+ * Line item ID.
5095
+ * @format GUID
5096
+ * @immutable
5148
5097
  */
5149
- ecomOrderIds: string[];
5150
- }
5151
- interface BulkMarkOrdersAsPaidResponse {
5098
+ lineItemId?: string;
5152
5099
  /**
5153
- * Items updated by the bulk action.
5154
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5100
+ * Refund quantity.
5101
+ * @min 1
5102
+ * @max 100000
5103
+ * @immutable
5155
5104
  */
5156
- results?: BulkOrderResult[];
5157
- /** Bulk action metadata. */
5158
- bulkActionMetadata?: BulkActionMetadata;
5105
+ quantity?: number;
5159
5106
  }
5160
- interface BulkOrderResult {
5161
- /** Item metadata. */
5162
- itemMetadata?: ItemMetadata;
5107
+ interface AdditionalFeeRefund {
5163
5108
  /**
5164
- * Updated order.
5165
- *
5166
- * Returned when `returnFullEntity = true`.
5109
+ * Additional fee ID.
5110
+ * @format GUID
5111
+ * @immutable
5167
5112
  */
5168
- item?: Order;
5169
- }
5170
- interface ItemMetadata {
5171
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5172
- id?: string | null;
5173
- /** Index of the item within the request array. Allows for correlation between request and response items. */
5174
- originalIndex?: number;
5175
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5176
- success?: boolean;
5177
- /** Details about the error in case of failure. */
5178
- error?: ApplicationError;
5179
- }
5180
- interface ApplicationError {
5181
- /** Error code. */
5182
- code?: string;
5183
- /** Description of the error. */
5184
- description?: string;
5185
- /** Data related to the error. */
5186
- data?: Record<string, any> | null;
5187
- }
5188
- interface BulkActionMetadata {
5189
- /** Number of items that were successfully processed. */
5190
- totalSuccesses?: number;
5191
- /** Number of items that couldn't be processed. */
5192
- totalFailures?: number;
5193
- /** Number of failures without details because detailed failure threshold was exceeded. */
5194
- undetailedFailures?: number;
5195
- }
5196
- interface GetRefundabilityStatusRequest {
5113
+ additionalFeeId?: string;
5197
5114
  /**
5198
- * Order ID.
5199
- * @minLength 1
5200
- * @maxLength 100
5115
+ * Refund amount.
5116
+ * @immutable
5201
5117
  */
5202
- ecomOrderId: string;
5118
+ amount?: Price;
5203
5119
  }
5204
- interface GetRefundabilityStatusResponse {
5205
- /**
5206
- * Refundability details.
5207
- * @maxSize 300
5208
- */
5209
- refundabilities?: Refundability[];
5120
+ interface ShippingRefund {
5210
5121
  /**
5211
- * Whether the order supports refunding per item.
5212
- * @deprecated
5122
+ * Refund amount.
5123
+ * @immutable
5213
5124
  */
5214
- refundablePerItem?: boolean;
5215
- }
5216
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5217
- /** Reason why payment is not refundable. */
5218
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5219
- /** Reason why payment is only refundable manually. */
5220
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5221
- /** Payment ID. */
5222
- paymentId?: string;
5223
- /** Payment refundability status. */
5224
- refundabilityStatus?: RefundableStatusWithLiterals;
5225
- /** Link to payment provider dashboard. */
5226
- providerLink?: string | null;
5227
- }
5228
- /** @oneof */
5229
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
5230
- /** Reason why payment is not refundable. */
5231
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5232
- /** Reason why payment is only refundable manually. */
5233
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5234
- }
5235
- declare enum RefundableStatus {
5236
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
5237
- MANUAL = "MANUAL",
5238
- REFUNDABLE = "REFUNDABLE"
5239
- }
5240
- /** @enumType */
5241
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5242
- declare enum NonRefundableReason {
5243
- NONE = "NONE",
5244
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
5245
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5246
- INTERNAL_ERROR = "INTERNAL_ERROR",
5247
- NOT_PAID = "NOT_PAID",
5248
- ACCESS_DENIED = "ACCESS_DENIED",
5249
- ZERO_PRICE = "ZERO_PRICE",
5250
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5251
- PENDING_REFUND = "PENDING_REFUND",
5252
- FORBIDDEN = "FORBIDDEN",
5253
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5254
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
5255
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5125
+ amount?: Price;
5256
5126
  }
5257
- /** @enumType */
5258
- 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';
5259
- declare enum ManuallyRefundableReason {
5260
- EXPIRED = "EXPIRED",
5261
- NOT_SUPPORTED = "NOT_SUPPORTED",
5262
- OFFLINE = "OFFLINE",
5263
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5127
+ interface PreviewRefundEmailResponse {
5128
+ emailPreview?: string;
5264
5129
  }
5265
- /** @enumType */
5266
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5267
- interface CreatePaymentGatewayOrderRequest {
5130
+ interface PreviewCancelEmailRequest {
5268
5131
  /**
5269
- * Ecom order ID.
5270
5132
  * @minLength 1
5271
5133
  * @maxLength 100
5272
5134
  */
5273
- ecomOrderId: string;
5274
- /** Information about the user who initiated the payment. */
5275
- chargedBy?: ChargedBy;
5276
- /**
5277
- * Whether to delay capture of the payment.
5278
- *
5279
- * Default: false
5280
- * @internal
5281
- */
5282
- delayedCapture?: boolean;
5283
- }
5284
- interface ChargedBy {
5285
- /**
5286
- * ID - id of the user who initiated the payment
5287
- * @format GUID
5288
- */
5289
- id?: string;
5135
+ orderId?: string;
5290
5136
  /**
5291
- * Full name - name of the user who initiated the payment
5137
+ * Personal note added to the email (optional)
5292
5138
  * @minLength 1
5293
- * @maxLength 200
5139
+ * @maxLength 1000
5294
5140
  */
5295
- fullName?: string | null;
5141
+ customMessage?: string | null;
5296
5142
  }
5297
- interface CreatePaymentGatewayOrderResponse {
5298
- /** ID of the order created in the payment gateway */
5299
- paymentGatewayOrderId?: string;
5143
+ interface PreviewCancelEmailResponse {
5144
+ emailPreview?: string;
5300
5145
  }
5301
- interface ChargeMembershipsRequest {
5146
+ interface PreviewCancelRefundEmailRequest {
5302
5147
  /**
5303
- * Order ID.
5304
5148
  * @minLength 1
5305
5149
  * @maxLength 100
5306
5150
  */
5307
- ecomOrderId: string;
5151
+ orderId?: string;
5308
5152
  /**
5309
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5310
- * but a user which is using the membership on behalf of the a member
5311
- * @format GUID
5153
+ * Personal note added to the email (optional)
5154
+ * @minLength 1
5155
+ * @maxLength 1000
5312
5156
  */
5313
- memberId: string;
5157
+ customMessage?: string | null;
5158
+ /** Refund amount */
5159
+ refundAmount?: Price;
5314
5160
  /**
5315
- * List of items to be paid by memberships
5316
- * @minSize 1
5317
- * @maxSize 300
5318
- */
5319
- membershipCharges?: MembershipChargeItem[];
5320
- }
5321
- interface MembershipChargeItem {
5322
- /**
5323
- * The id of used membership
5324
- * @minLength 1
5325
- * @maxLength 100
5326
- */
5327
- membershipId?: string;
5328
- /**
5329
- * ID of the application providing this payment option
5161
+ * Refund ID. (Optional)
5330
5162
  * @format GUID
5331
5163
  */
5332
- appId?: string;
5333
- /** The name of used membership */
5334
- membershipName?: MembershipName;
5335
- /** Additional data about this membership */
5336
- membershipAdditionalData?: Record<string, any> | null;
5337
- /** Catalog and item reference info. */
5338
- catalogReference?: CatalogReference;
5339
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
5340
- serviceProperties?: ServiceProperties;
5341
- /**
5342
- * Usually would be the same as catalogReference.catalogItemId
5343
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
5344
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5345
- * @minLength 1
5346
- * @maxLength 36
5347
- */
5348
- rootCatalogItemId?: string | null;
5349
- /**
5350
- * line item id of Checkout/Order line item
5351
- * @minLength 1
5352
- * @maxLength 100
5353
- */
5354
- lineItemId?: string;
5164
+ refundId?: string | null;
5355
5165
  }
5356
- interface MembershipName {
5357
- /**
5358
- * Membership name in the site's original language.
5359
- * @maxLength 100
5360
- */
5361
- original?: string;
5362
- /**
5363
- * Membership name translated into the buyer's language.
5364
- *
5365
- * Default: The value of `original`
5366
- * @maxLength 100
5367
- */
5368
- translated?: string | null;
5166
+ interface PreviewCancelRefundEmailResponse {
5167
+ emailPreview?: string;
5369
5168
  }
5370
- interface ChargeMembershipsResponse {
5169
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
5371
5170
  }
5372
- interface TriggerRefundRequest {
5373
- /**
5374
- * The order this refund related to
5375
- * @minLength 1
5376
- * @maxLength 100
5377
- */
5378
- ecomOrderId: string;
5379
- /**
5380
- * Refund operations information
5381
- * @minSize 1
5382
- * @maxSize 1
5383
- */
5384
- payments: PaymentRefund[];
5385
- /** Business model of a refund */
5386
- details?: RefundDetails;
5387
- /** Side effect details related to refund */
5388
- sideEffects?: RefundSideEffects;
5171
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
5172
+ emailPreview?: string;
5389
5173
  }
5390
- interface PaymentRefund {
5391
- /**
5392
- * Specific payment within the order to refund
5393
- * @format GUID
5394
- */
5395
- paymentId?: string;
5396
- /** Refund amount. Not relevant for membership and gift card refunds. */
5397
- amount?: Price;
5398
- /**
5399
- * Whether refund is made externally and manually (on the payment provider's side)
5400
- * 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.
5401
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5402
- */
5403
- externalRefund?: boolean;
5404
- /**
5405
- * Gateway refund id. When param is present, new refund is not created.
5406
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5407
- * and all side effects from request will be executed.
5408
- * @internal
5409
- * @minLength 1
5410
- * @maxLength 100
5411
- */
5412
- gatewayRefundId?: string | null;
5174
+ interface PreviewBuyerConfirmationEmailRequest {
5413
5175
  }
5414
- /** Business model of a refund request */
5415
- interface RefundDetails {
5416
- /**
5417
- * Order line item IDs and quantities that were refunded.
5418
- * @maxSize 300
5419
- */
5420
- items?: RefundItem[];
5421
- /** Whether the shipping fee was also refunded. */
5422
- shippingIncluded?: boolean;
5423
- /**
5424
- * Reason for the refund, provided by customer (optional).
5425
- * @maxLength 200
5426
- */
5427
- reason?: string | null;
5428
- /**
5429
- * Line items that were refunded.
5430
- * @maxSize 300
5431
- */
5432
- lineItems?: LineItemRefund[];
5433
- /**
5434
- * Additional fees that were refunded.
5435
- * @maxSize 100
5436
- */
5437
- additionalFees?: AdditionalFeeRefund[];
5438
- /** Shipping amount that was refunded. */
5439
- shipping?: ShippingRefund;
5176
+ interface PreviewBuyerConfirmationEmailResponse {
5177
+ emailPreview?: string;
5440
5178
  }
5441
- interface RefundItem {
5442
- /**
5443
- * Line item ID the refunded line item.
5444
- * @format GUID
5445
- */
5446
- lineItemId?: string;
5447
- /**
5448
- * Line item quantity refunded.
5449
- * @min 1
5450
- * @max 100000
5451
- */
5452
- quantity?: number;
5179
+ interface PreviewBuyerPickupConfirmationEmailRequest {
5453
5180
  }
5454
- interface LineItemRefund {
5455
- /**
5456
- * Line item ID.
5457
- * @format GUID
5458
- * @immutable
5459
- */
5460
- lineItemId?: string;
5461
- /**
5462
- * Refund quantity.
5463
- * @min 1
5464
- * @max 100000
5465
- * @immutable
5466
- */
5467
- quantity?: number;
5181
+ interface PreviewBuyerPickupConfirmationEmailResponse {
5182
+ emailPreview?: string;
5468
5183
  }
5469
- interface AdditionalFeeRefund {
5184
+ interface PreviewShippingConfirmationEmailRequest {
5185
+ }
5186
+ interface PreviewShippingConfirmationEmailResponse {
5187
+ emailPreview?: string;
5188
+ }
5189
+ interface PreviewResendDownloadLinksEmailRequest {
5190
+ }
5191
+ interface PreviewResendDownloadLinksEmailResponse {
5192
+ emailPreview?: string;
5193
+ }
5194
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5195
+ /** Emitted on a meta site creation. */
5196
+ siteCreated?: SiteCreated;
5197
+ /** Emitted on a meta site transfer completion. */
5198
+ siteTransferred?: SiteTransferred;
5199
+ /** Emitted on a meta site deletion. */
5200
+ siteDeleted?: SiteDeleted;
5201
+ /** Emitted on a meta site restoration. */
5202
+ siteUndeleted?: SiteUndeleted;
5203
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5204
+ sitePublished?: SitePublished;
5205
+ /** Emitted on a meta site unpublish. */
5206
+ siteUnpublished?: SiteUnpublished;
5207
+ /** Emitted when meta site is marked as template. */
5208
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5209
+ /** Emitted when meta site is marked as a WixSite. */
5210
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5211
+ /** Emitted when an application is provisioned (installed). */
5212
+ serviceProvisioned?: ServiceProvisioned;
5213
+ /** Emitted when an application is removed (uninstalled). */
5214
+ serviceRemoved?: ServiceRemoved;
5215
+ /** Emitted when meta site name (URL slug) is changed. */
5216
+ siteRenamedPayload?: SiteRenamed;
5217
+ /** Emitted when meta site was permanently deleted. */
5218
+ hardDeleted?: SiteHardDeleted;
5219
+ /** Emitted on a namespace change. */
5220
+ namespaceChanged?: NamespaceChanged;
5221
+ /** Emitted when Studio is attached. */
5222
+ studioAssigned?: StudioAssigned;
5223
+ /** Emitted when Studio is detached. */
5224
+ studioUnassigned?: StudioUnassigned;
5470
5225
  /**
5471
- * Additional fee ID.
5472
- * @format GUID
5473
- * @immutable
5226
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5227
+ * the actual URL.
5228
+ *
5229
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5230
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5474
5231
  */
5475
- additionalFeeId?: string;
5232
+ urlChanged?: SiteUrlChanged;
5233
+ /** Site is marked as PurgedExternally */
5234
+ sitePurgedExternally?: SitePurgedExternally;
5235
+ /** Emitted when Odeditor is attached. */
5236
+ odeditorAssigned?: OdeditorAssigned;
5237
+ /** Emitted when Odeditor is detached. */
5238
+ odeditorUnassigned?: OdeditorUnassigned;
5239
+ /** Emitted when Picasso is attached. */
5240
+ picassoAssigned?: PicassoAssigned;
5241
+ /** Emitted when Picasso is detached. */
5242
+ picassoUnassigned?: PicassoUnassigned;
5243
+ /** Emitted when Wixel is attached. */
5244
+ wixelAssigned?: WixelAssigned;
5245
+ /** Emitted when Wixel is detached. */
5246
+ wixelUnassigned?: WixelUnassigned;
5247
+ /** Emitted when StudioTwo is attached. */
5248
+ studioTwoAssigned?: StudioTwoAssigned;
5249
+ /** Emitted when StudioTwo is detached. */
5250
+ studioTwoUnassigned?: StudioTwoUnassigned;
5251
+ /** Emitted when media from user domain is enabled. */
5252
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5253
+ /** Emitted when media from user domain is disabled. */
5254
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5255
+ /** Emitted when Editorless is attached. */
5256
+ editorlessAssigned?: EditorlessAssigned;
5257
+ /** Emitted when Editorless is detached. */
5258
+ editorlessUnassigned?: EditorlessUnassigned;
5476
5259
  /**
5477
- * Refund amount.
5478
- * @immutable
5260
+ * A meta site id.
5261
+ * @format GUID
5479
5262
  */
5480
- amount?: Price;
5481
- }
5482
- interface ShippingRefund {
5263
+ metaSiteId?: string;
5264
+ /** A meta site version. Monotonically increasing. */
5265
+ version?: string;
5266
+ /** A timestamp of the event. */
5267
+ timestamp?: string;
5483
5268
  /**
5484
- * Refund amount.
5485
- * @immutable
5269
+ * TODO(meta-site): Change validation once validations are disabled for consumers
5270
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5271
+ * @maxSize 4000
5486
5272
  */
5487
- amount?: Price;
5273
+ assets?: Asset[];
5488
5274
  }
5489
- interface RefundSideEffects {
5490
- /** Inventory restock details as part of this refund. */
5491
- restockInfo?: RestockInfo;
5492
- /** Whether to send a refund confirmation email to the customer. */
5493
- sendOrderRefundedEmail?: boolean;
5275
+ /** @oneof */
5276
+ interface MetaSiteSpecialEventPayloadOneOf {
5277
+ /** Emitted on a meta site creation. */
5278
+ siteCreated?: SiteCreated;
5279
+ /** Emitted on a meta site transfer completion. */
5280
+ siteTransferred?: SiteTransferred;
5281
+ /** Emitted on a meta site deletion. */
5282
+ siteDeleted?: SiteDeleted;
5283
+ /** Emitted on a meta site restoration. */
5284
+ siteUndeleted?: SiteUndeleted;
5285
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5286
+ sitePublished?: SitePublished;
5287
+ /** Emitted on a meta site unpublish. */
5288
+ siteUnpublished?: SiteUnpublished;
5289
+ /** Emitted when meta site is marked as template. */
5290
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5291
+ /** Emitted when meta site is marked as a WixSite. */
5292
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5293
+ /** Emitted when an application is provisioned (installed). */
5294
+ serviceProvisioned?: ServiceProvisioned;
5295
+ /** Emitted when an application is removed (uninstalled). */
5296
+ serviceRemoved?: ServiceRemoved;
5297
+ /** Emitted when meta site name (URL slug) is changed. */
5298
+ siteRenamedPayload?: SiteRenamed;
5299
+ /** Emitted when meta site was permanently deleted. */
5300
+ hardDeleted?: SiteHardDeleted;
5301
+ /** Emitted on a namespace change. */
5302
+ namespaceChanged?: NamespaceChanged;
5303
+ /** Emitted when Studio is attached. */
5304
+ studioAssigned?: StudioAssigned;
5305
+ /** Emitted when Studio is detached. */
5306
+ studioUnassigned?: StudioUnassigned;
5494
5307
  /**
5495
- * Custom message added to the refund confirmation email.
5496
- * @minLength 1
5497
- * @maxLength 1000
5308
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5309
+ * the actual URL.
5310
+ *
5311
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5312
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5498
5313
  */
5499
- customMessage?: string | null;
5314
+ urlChanged?: SiteUrlChanged;
5315
+ /** Site is marked as PurgedExternally */
5316
+ sitePurgedExternally?: SitePurgedExternally;
5317
+ /** Emitted when Odeditor is attached. */
5318
+ odeditorAssigned?: OdeditorAssigned;
5319
+ /** Emitted when Odeditor is detached. */
5320
+ odeditorUnassigned?: OdeditorUnassigned;
5321
+ /** Emitted when Picasso is attached. */
5322
+ picassoAssigned?: PicassoAssigned;
5323
+ /** Emitted when Picasso is detached. */
5324
+ picassoUnassigned?: PicassoUnassigned;
5325
+ /** Emitted when Wixel is attached. */
5326
+ wixelAssigned?: WixelAssigned;
5327
+ /** Emitted when Wixel is detached. */
5328
+ wixelUnassigned?: WixelUnassigned;
5329
+ /** Emitted when StudioTwo is attached. */
5330
+ studioTwoAssigned?: StudioTwoAssigned;
5331
+ /** Emitted when StudioTwo is detached. */
5332
+ studioTwoUnassigned?: StudioTwoUnassigned;
5333
+ /** Emitted when media from user domain is enabled. */
5334
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5335
+ /** Emitted when media from user domain is disabled. */
5336
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5337
+ /** Emitted when Editorless is attached. */
5338
+ editorlessAssigned?: EditorlessAssigned;
5339
+ /** Emitted when Editorless is detached. */
5340
+ editorlessUnassigned?: EditorlessUnassigned;
5500
5341
  }
5501
- interface RestockInfo {
5502
- /** Restock type. */
5503
- type?: RestockTypeWithLiterals;
5342
+ interface Asset {
5504
5343
  /**
5505
- * Deprecated, use items instead
5506
- * @internal
5507
- * @maxSize 300
5508
- * @deprecated
5344
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5345
+ * @maxLength 36
5509
5346
  */
5510
- lineItemIds?: string[];
5347
+ appDefId?: string;
5511
5348
  /**
5512
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5513
- * @maxSize 300
5349
+ * An instance id. For legacy reasons may be UUID or a string.
5350
+ * @maxLength 200
5514
5351
  */
5515
- items?: RestockItem[];
5352
+ instanceId?: string;
5353
+ /** An application state. */
5354
+ state?: StateWithLiterals;
5516
5355
  }
5517
- declare enum RestockType {
5518
- NO_ITEMS = "NO_ITEMS",
5519
- ALL_ITEMS = "ALL_ITEMS",
5520
- SOME_ITEMS = "SOME_ITEMS"
5356
+ declare enum State {
5357
+ UNKNOWN = "UNKNOWN",
5358
+ ENABLED = "ENABLED",
5359
+ DISABLED = "DISABLED",
5360
+ PENDING = "PENDING",
5361
+ DEMO = "DEMO"
5521
5362
  }
5522
5363
  /** @enumType */
5523
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5524
- interface RestockItem {
5364
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5365
+ interface SiteCreated {
5525
5366
  /**
5526
- * ID of the line item being restocked.
5367
+ * A template identifier (empty if not created from a template).
5368
+ * @maxLength 36
5369
+ */
5370
+ originTemplateId?: string;
5371
+ /**
5372
+ * An account id of the owner.
5527
5373
  * @format GUID
5528
5374
  */
5529
- lineItemId?: string;
5375
+ ownerId?: string;
5376
+ /** A context in which meta site was created. */
5377
+ context?: SiteCreatedContextWithLiterals;
5530
5378
  /**
5531
- * Line item quantity being restocked.
5532
- * @min 1
5533
- * @max 100000
5379
+ * A meta site id from which this site was created.
5380
+ *
5381
+ * In case of a creation from a template it's a template id.
5382
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5383
+ * @format GUID
5534
5384
  */
5535
- quantity?: number;
5385
+ originMetaSiteId?: string | null;
5536
5386
  /**
5537
- * Per-location breakdown of restock quantities.
5538
- * @internal
5539
- * @maxSize 5
5387
+ * A meta site name (URL slug).
5388
+ * @maxLength 20
5540
5389
  */
5541
- restockLocations?: RestockLocation[];
5390
+ siteName?: string;
5391
+ /** A namespace. */
5392
+ namespace?: NamespaceWithLiterals;
5542
5393
  }
5543
- interface TriggerRefundResponse {
5544
- /** All order's transactions after the refunds were added */
5545
- orderTransactions?: OrderTransactions;
5546
- /** Created refund ID */
5547
- refundId?: string | null;
5548
- /** Payment ID's that the refund execution had failed for */
5549
- failedPaymentIds?: ItemMetadata[];
5394
+ declare enum SiteCreatedContext {
5395
+ /** A valid option, we don't expose all reasons why site might be created. */
5396
+ OTHER = "OTHER",
5397
+ /** A meta site was created from template. */
5398
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5399
+ /** A meta site was created by copying of the transfferred meta site. */
5400
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5401
+ /** A copy of existing meta site. */
5402
+ DUPLICATE = "DUPLICATE",
5403
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5404
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5405
+ /** deprecated A meta site was created for Flash editor. */
5406
+ FLASH = "FLASH"
5550
5407
  }
5551
- /**
5552
- * A record of all payments and refunds associated with an order.
5553
- *
5554
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5555
- */
5556
- interface OrderTransactions {
5408
+ /** @enumType */
5409
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5410
+ declare enum Namespace {
5411
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5412
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5413
+ WIX = "WIX",
5414
+ /** 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. */
5415
+ SHOUT_OUT = "SHOUT_OUT",
5416
+ /** 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. */
5417
+ ALBUMS = "ALBUMS",
5418
+ /** 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. */
5419
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5420
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5421
+ HOTELS = "HOTELS",
5422
+ /** 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. */
5423
+ CLUBS = "CLUBS",
5424
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5425
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5557
5426
  /**
5558
- * Order ID.
5559
- * @format GUID
5427
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5428
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5560
5429
  */
5561
- orderId?: string;
5430
+ DEV_SITE = "DEV_SITE",
5431
+ /** 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. */
5432
+ LOGOS = "LOGOS",
5433
+ /** 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. */
5434
+ VIDEO_MAKER = "VIDEO_MAKER",
5435
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5436
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5437
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5438
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5562
5439
  /**
5563
- * Record of payments made to the merchant.
5564
- * @maxSize 100
5440
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5441
+ *
5442
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
5565
5443
  */
5566
- payments?: Payment[];
5444
+ HTML_DRAFT = "HTML_DRAFT",
5567
5445
  /**
5568
- * Record of refunds made to the buyer.
5569
- * @maxSize 300
5446
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5447
+ * Will be accessible from Site List and will not have a website app.
5448
+ * Once the user attaches a site, the site will become a regular wixsite.
5570
5449
  */
5571
- refunds?: Refund[];
5572
- }
5573
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5574
- /** Regular payment details. */
5575
- regularPaymentDetails?: RegularPaymentDetails;
5576
- /** Gift card payment details. */
5577
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5578
- /** Membership payment details. */
5579
- membershipPaymentDetails?: MembershipPaymentDetails;
5450
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5451
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5452
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5453
+ /** It is to be used in the Business First efforts. */
5454
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5455
+ /** Bookings business flow with no site. */
5456
+ ANYWHERE = "ANYWHERE",
5457
+ /** Namespace for Headless Backoffice with no editor */
5458
+ HEADLESS = "HEADLESS",
5580
5459
  /**
5581
- * Receipt created by Wix
5582
- * @internal
5460
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5461
+ * The site will be used for account level CSM feature for enterprise
5583
5462
  */
5584
- wixReceipt?: WixReceiptInfo;
5463
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5464
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5465
+ RISE = "RISE",
5585
5466
  /**
5586
- * Receipt created by an external system.
5587
- * @internal
5467
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5468
+ * There's a blank site behind the scene but it's blank).
5469
+ * The Mobile company will be the owner of this namespace.
5588
5470
  */
5589
- externalReceipt?: ExternalReceiptInfo;
5590
- /** @internal */
5591
- canceled?: CanceledStatusDetails;
5592
- /** @internal */
5593
- declined?: DeclinedStatusDetails;
5594
- /** @internal */
5595
- voided?: VoidedStatusDetails;
5471
+ BRANDED_FIRST = "BRANDED_FIRST",
5472
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5473
+ NOWNIA = "NOWNIA",
5596
5474
  /**
5597
- * Payment ID.
5598
- * @format GUID
5599
- * @readonly
5475
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5476
+ * The Partners company owns this namespace.
5600
5477
  */
5601
- id?: string | null;
5602
- /** 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. */
5603
- createdDate?: Date | null;
5478
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5479
+ /** Codux Headless Sites */
5480
+ CODUX = "CODUX",
5481
+ /** Bobb - AI Design Creator. */
5482
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5604
5483
  /**
5605
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5606
- * @readonly
5484
+ * Shared Blog Site is a unique single site across Enterprise account,
5485
+ * This site will hold all Blog posts related to the Marketing product.
5607
5486
  */
5608
- updatedDate?: Date | null;
5609
- /** Payment amount. */
5610
- amount?: Price;
5487
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5488
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5489
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5490
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5491
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5492
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5493
+ MIMIR = "MIMIR",
5494
+ /** Wix Twins platform. */
5495
+ TWINS = "TWINS",
5496
+ /** Wix Nano. */
5497
+ NANO = "NANO",
5498
+ /** Base44 headless sites. */
5499
+ BASE44 = "BASE44",
5500
+ /** Wix Channels Sites */
5501
+ CHANNELS = "CHANNELS",
5502
+ /** Nautilus platform. */
5503
+ NAUTILUS = "NAUTILUS",
5611
5504
  /**
5612
- * Whether refunds for this payment are disabled.
5613
- * + `true`: This payment is not refundable.
5614
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5505
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5506
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5615
5507
  */
5616
- refundDisabled?: boolean;
5508
+ SYMPHONY = "SYMPHONY",
5509
+ /** Nautilus platform app. */
5510
+ NAUTILUS_APPS = "NAUTILUS_APPS",
5617
5511
  /**
5618
- * Whether receipt generation is allowed for this payment.
5619
- * + `true`: This payment supports receipt generation.
5620
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5621
- * @readonly
5512
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5513
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5622
5514
  */
5623
- supportReceiptGeneration?: boolean;
5624
- /** Details about cash rounding applied to this payment, when relevant. */
5625
- cashRounding?: CashRoundingDetails;
5515
+ VIBU = "VIBU",
5626
5516
  /**
5627
- * Overall payment status.
5628
- *
5629
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5517
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5518
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
5519
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5520
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
5630
5521
  */
5631
- status?: PaymentStatusWithLiterals;
5522
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5632
5523
  /**
5633
- * Detailed payment status information including gateway reason codes and status-specific details.
5634
- * @internal
5524
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
5525
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5635
5526
  */
5636
- paymentStatusDetails?: PaymentStatusDetails;
5527
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5528
+ }
5529
+ /** @enumType */
5530
+ 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';
5531
+ /** Site transferred to another user. */
5532
+ interface SiteTransferred {
5637
5533
  /**
5638
- * Location where the payment was processed.
5639
- * @internal
5534
+ * A previous owner id (user that transfers meta site).
5640
5535
  * @format GUID
5641
- * @immutable
5642
5536
  */
5643
- locationId?: string | null;
5537
+ oldOwnerId?: string;
5644
5538
  /**
5645
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5539
+ * A new owner id (user that accepts meta site).
5646
5540
  * @format GUID
5647
5541
  */
5648
- chargeCorrelationId?: string | null;
5542
+ newOwnerId?: string;
5649
5543
  }
5650
- /** @oneof */
5651
- interface PaymentPaymentDetailsOneOf {
5652
- /** Regular payment details. */
5653
- regularPaymentDetails?: RegularPaymentDetails;
5654
- /** Gift card payment details. */
5655
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5656
- /** Membership payment details. */
5657
- membershipPaymentDetails?: MembershipPaymentDetails;
5544
+ /** Soft deletion of the meta site. Could be restored. */
5545
+ interface SiteDeleted {
5546
+ /** A deletion context. */
5547
+ deleteContext?: DeleteContext;
5658
5548
  }
5659
- /** @oneof */
5660
- interface PaymentReceiptInfoOneOf {
5549
+ interface DeleteContext {
5550
+ /** When the meta site was deleted. */
5551
+ dateDeleted?: Date | null;
5552
+ /** A status. */
5553
+ deleteStatus?: DeleteStatusWithLiterals;
5661
5554
  /**
5662
- * Receipt created by Wix
5663
- * @internal
5555
+ * A reason (flow).
5556
+ * @maxLength 255
5664
5557
  */
5665
- wixReceipt?: WixReceiptInfo;
5558
+ deleteOrigin?: string;
5666
5559
  /**
5667
- * Receipt created by an external system.
5668
- * @internal
5560
+ * A service that deleted it.
5561
+ * @maxLength 255
5669
5562
  */
5670
- externalReceipt?: ExternalReceiptInfo;
5563
+ initiatorId?: string | null;
5671
5564
  }
5672
- /** @oneof */
5673
- interface PaymentStatusDetailsOneOf {
5674
- /** @internal */
5675
- canceled?: CanceledStatusDetails;
5676
- /** @internal */
5677
- declined?: DeclinedStatusDetails;
5678
- /** @internal */
5679
- voided?: VoidedStatusDetails;
5565
+ declare enum DeleteStatus {
5566
+ UNKNOWN = "UNKNOWN",
5567
+ TRASH = "TRASH",
5568
+ DELETED = "DELETED",
5569
+ PENDING_PURGE = "PENDING_PURGE",
5570
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5680
5571
  }
5681
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5682
- /** Credit card details. */
5683
- creditCardDetails?: CreditCardPaymentMethodDetails;
5572
+ /** @enumType */
5573
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5574
+ /** Restoration of the meta site. */
5575
+ interface SiteUndeleted {
5576
+ }
5577
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
5578
+ interface SitePublished {
5579
+ }
5580
+ interface SiteUnpublished {
5684
5581
  /**
5685
- * Wix Payments order ID.
5686
- * @maxLength 100
5582
+ * A list of URLs previously associated with the meta site.
5583
+ * @maxLength 4000
5584
+ * @maxSize 10000
5687
5585
  */
5688
- paymentOrderId?: string | null;
5586
+ urls?: string[];
5587
+ }
5588
+ interface SiteMarkedAsTemplate {
5589
+ }
5590
+ interface SiteMarkedAsWixSite {
5591
+ }
5592
+ /**
5593
+ * Represents a service provisioned a site.
5594
+ *
5595
+ * Note on `origin_instance_id`:
5596
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5597
+ * This is because of the following scenario:
5598
+ *
5599
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
5600
+ * such as a product catalog. When you create a site from this template, you inherit this
5601
+ * default product catalog. However, if the template's product catalog is modified,
5602
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
5603
+ * your site remains consistent with what you initially received and does not include any
5604
+ * changes made to the original template afterward.
5605
+ * To ensure this, the TPA on the template gets a new instance_id.
5606
+ */
5607
+ interface ServiceProvisioned {
5689
5608
  /**
5690
- * Payment gateway's transaction ID.
5691
- * This field is only returned when the value of `offline_payment` is `false`.
5692
- * @maxLength 100
5609
+ * Either UUID or EmbeddedServiceType.
5610
+ * @maxLength 36
5693
5611
  */
5694
- gatewayTransactionId?: string | null;
5612
+ appDefId?: string;
5695
5613
  /**
5696
- * Payment method.
5697
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5698
- * Non-exhaustive list of supported values:
5699
- * + `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`
5700
- * @maxLength 150
5701
- * @deprecated Payment method.
5702
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5703
- * Non-exhaustive list of supported values:
5704
- * + `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`
5705
- * @replacedBy payment_method_name
5706
- * @targetRemovalDate 2026-07-01
5614
+ * Not only UUID. Something here could be something weird.
5615
+ * @maxLength 36
5707
5616
  */
5708
- paymentMethod?: string | null;
5617
+ instanceId?: string;
5709
5618
  /**
5710
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5711
- * @maxLength 100
5619
+ * An instance id from which this instance is originated.
5620
+ * @maxLength 36
5712
5621
  */
5713
- providerTransactionId?: string | null;
5714
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5715
- offlinePayment?: boolean;
5622
+ originInstanceId?: string;
5716
5623
  /**
5717
- * Payment status.
5718
- * @deprecated Payment status.
5719
- * @replacedBy payment.status
5720
- * @targetRemovalDate 2026-11-01
5624
+ * A version.
5625
+ * @maxLength 500
5721
5626
  */
5722
- status?: TransactionStatusWithLiterals;
5723
- /** Whether there is a payment agreement that allows for future charges. */
5724
- savedPaymentMethod?: boolean;
5725
- /** Authorization details. */
5726
- authorizationDetails?: AuthorizationDetails;
5627
+ version?: string | null;
5727
5628
  /**
5728
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5729
- * @internal
5730
- * @maxLength 300
5629
+ * The origin meta site id
5630
+ * @format GUID
5731
5631
  */
5732
- paymentProvider?: string | null;
5632
+ originMetaSiteId?: string | null;
5633
+ }
5634
+ interface ServiceRemoved {
5733
5635
  /**
5734
- * Record of chargebacks made by the buyer.
5735
- * @maxSize 6
5636
+ * Either UUID or EmbeddedServiceType.
5637
+ * @maxLength 36
5736
5638
  */
5737
- chargebacks?: Chargeback[];
5639
+ appDefId?: string;
5738
5640
  /**
5739
- * Payment method ID.
5740
- * @internal
5641
+ * Not only UUID. Something here could be something weird.
5741
5642
  * @maxLength 36
5742
5643
  */
5743
- paymentMethodId?: string | null;
5744
- /** Platform fee amount associated with this payment. */
5745
- platformFee?: Price;
5644
+ instanceId?: string;
5746
5645
  /**
5747
- * Payment method with buyer and optional owner translations.
5748
- * Non-exhaustive list of supported values:
5749
- * + `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`
5646
+ * A version.
5647
+ * @maxLength 500
5750
5648
  */
5751
- paymentMethodName?: PaymentMethodName;
5752
- }
5753
- /** @oneof */
5754
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5755
- /** Credit card details. */
5756
- creditCardDetails?: CreditCardPaymentMethodDetails;
5757
- }
5758
- declare enum TransactionStatus {
5759
- UNDEFINED = "UNDEFINED",
5760
- APPROVED = "APPROVED",
5761
- PENDING = "PENDING",
5762
- PENDING_MERCHANT = "PENDING_MERCHANT",
5763
- CANCELED = "CANCELED",
5764
- DECLINED = "DECLINED",
5765
- REFUNDED = "REFUNDED",
5766
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5767
- AUTHORIZED = "AUTHORIZED",
5768
- VOIDED = "VOIDED"
5649
+ version?: string | null;
5769
5650
  }
5770
- /** @enumType */
5771
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5772
- interface CreditCardPaymentMethodDetails {
5651
+ /** Rename of the site. Meaning, free public url has been changed as well. */
5652
+ interface SiteRenamed {
5773
5653
  /**
5774
- * The last 4 digits of the card number.
5775
- * @maxLength 4
5654
+ * A new meta site name (URL slug).
5655
+ * @maxLength 20
5776
5656
  */
5777
- lastFourDigits?: string | null;
5657
+ newSiteName?: string;
5778
5658
  /**
5779
- * Card issuer's brand.
5780
- * @maxLength 100
5659
+ * A previous meta site name (URL slug).
5660
+ * @maxLength 255
5781
5661
  */
5782
- brand?: string | null;
5662
+ oldSiteName?: string;
5783
5663
  }
5784
- interface AuthorizationDetails {
5785
- /**
5786
- * Whether the authorized payment is of a delayed capture.
5787
- * @readonly
5788
- */
5789
- delayedCapture?: boolean;
5790
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5791
- authorizedDate?: Date | null;
5792
- /**
5793
- * List of captures associated with payment
5794
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5795
- * @maxSize 1
5796
- */
5797
- captures?: AuthorizationCapture[];
5798
- /** Void associated with payment */
5799
- void?: AuthorizationVoid;
5800
- /** Scheduled action for this transaction */
5801
- scheduledAction?: V1ScheduledAction;
5664
+ /**
5665
+ * Hard deletion of the meta site.
5666
+ *
5667
+ * Could not be restored. Therefore it's desirable to cleanup data.
5668
+ */
5669
+ interface SiteHardDeleted {
5670
+ /** A deletion context. */
5671
+ deleteContext?: DeleteContext;
5802
5672
  }
5803
- interface AuthorizationCapture {
5804
- /**
5805
- * Capture ID.
5806
- * @format GUID
5807
- * @readonly
5808
- */
5809
- id?: string | null;
5810
- /** Status of this capture action */
5811
- status?: AuthorizationCaptureStatusWithLiterals;
5673
+ interface NamespaceChanged {
5674
+ /** A previous namespace. */
5675
+ oldNamespace?: NamespaceWithLiterals;
5676
+ /** A new namespace. */
5677
+ newNamespace?: NamespaceWithLiterals;
5678
+ }
5679
+ /** Assigned Studio editor */
5680
+ interface StudioAssigned {
5681
+ }
5682
+ /** Unassigned Studio editor */
5683
+ interface StudioUnassigned {
5684
+ }
5685
+ /**
5686
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5687
+ *
5688
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5689
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
5690
+ *
5691
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5692
+ */
5693
+ interface SiteUrlChanged {
5694
+ }
5695
+ /**
5696
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5697
+ * Consumed by other teams to remove relevant data.
5698
+ */
5699
+ interface SitePurgedExternally {
5812
5700
  /**
5813
- * Amount of this capture
5814
- * @immutable
5701
+ * @maxLength 2048
5702
+ * @maxSize 100
5703
+ * @deprecated
5704
+ * @targetRemovalDate 2025-04-15
5815
5705
  */
5816
- amount?: Price;
5817
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5818
- createdDate?: Date | null;
5819
- /** In case of status is FAILED may contain failure details */
5820
- failureDetails?: AuthorizationActionFailureDetails;
5706
+ appDefId?: string[];
5821
5707
  }
5822
- declare enum AuthorizationCaptureStatus {
5823
- /** Capture operation still in progress. */
5824
- PENDING = "PENDING",
5825
- /** Capture operation succeeded. */
5826
- SUCCEEDED = "SUCCEEDED",
5827
- /** Capture operation failed. */
5828
- FAILED = "FAILED"
5708
+ /** Assigned Odeditor */
5709
+ interface OdeditorAssigned {
5829
5710
  }
5830
- /** @enumType */
5831
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5832
- interface AuthorizationActionFailureDetails {
5833
- /** @maxLength 100 */
5834
- failureCode?: string;
5711
+ /** Unassigned Odeditor */
5712
+ interface OdeditorUnassigned {
5835
5713
  }
5836
- interface AuthorizationVoid {
5837
- /** Status of this void action */
5838
- status?: AuthorizationVoidStatusWithLiterals;
5839
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5840
- voidedDate?: Date | null;
5841
- /** In case of status is FAILED may contain failure details */
5842
- failureDetails?: AuthorizationActionFailureDetails;
5843
- /** Reason of void action */
5844
- reason?: ReasonWithLiterals;
5714
+ /** Assigned Picasso editor */
5715
+ interface PicassoAssigned {
5845
5716
  }
5846
- declare enum AuthorizationVoidStatus {
5847
- /** Void operation still in progress. */
5848
- PENDING = "PENDING",
5849
- /** Void operation succeeded. */
5850
- SUCCEEDED = "SUCCEEDED",
5851
- /** Void operation failed. */
5852
- FAILED = "FAILED"
5717
+ /** Unassigned Picasso */
5718
+ interface PicassoUnassigned {
5853
5719
  }
5854
- /** @enumType */
5855
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5856
- /** Reason the authorization was voided. */
5857
- declare enum Reason {
5858
- /** Authorization was voided by user. */
5859
- MANUAL = "MANUAL",
5860
- /** Authorization passed execution date. */
5861
- SCHEDULED = "SCHEDULED"
5720
+ /** Assigned Wixel */
5721
+ interface WixelAssigned {
5862
5722
  }
5863
- /** @enumType */
5864
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5865
- interface V1ScheduledAction {
5866
- /** Type of the action. */
5867
- actionType?: ActionTypeWithLiterals;
5868
- /** The date and time of the action. */
5869
- executionDate?: Date | null;
5723
+ /** Unassigned Wixel */
5724
+ interface WixelUnassigned {
5870
5725
  }
5871
- declare enum ActionType {
5872
- VOID = "VOID",
5873
- CAPTURE = "CAPTURE"
5726
+ /** Assigned StudioTwo */
5727
+ interface StudioTwoAssigned {
5728
+ }
5729
+ /** Unassigned StudioTwo */
5730
+ interface StudioTwoUnassigned {
5731
+ }
5732
+ /** Media from user domain is enabled. */
5733
+ interface UserDomainMediaEnabled {
5734
+ }
5735
+ /** Media from user domain is disabled. */
5736
+ interface UserDomainMediaDisabled {
5737
+ }
5738
+ /** Assigned Editorless */
5739
+ interface EditorlessAssigned {
5740
+ }
5741
+ /** Unassigned Editorless */
5742
+ interface EditorlessUnassigned {
5743
+ }
5744
+ interface HasCustomEmailConfigurationsRequest {
5745
+ }
5746
+ interface HasCustomEmailConfigurationsResponse {
5747
+ hasCustomConfigurations?: boolean;
5748
+ }
5749
+ interface AddToAutomationMigrationPopulationRequest {
5750
+ /** When true, sends custom email configurations to automation system via email */
5751
+ sendCustomEmailConfigs?: boolean;
5752
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5753
+ origin?: OriginWithLiterals;
5754
+ }
5755
+ declare enum Origin {
5756
+ OPT_IN = "OPT_IN",
5757
+ MIGRATION = "MIGRATION"
5874
5758
  }
5875
5759
  /** @enumType */
5876
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5877
- interface Chargeback {
5878
- /**
5879
- * Chargeback ID.
5880
- * @format GUID
5881
- * @readonly
5882
- * @immutable
5883
- */
5884
- id?: string;
5885
- /**
5886
- * 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.
5887
- * @readonly
5888
- * @immutable
5889
- */
5890
- createdDate?: Date | null;
5760
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5761
+ interface AddToAutomationMigrationPopulationResponse {
5762
+ success?: boolean;
5763
+ }
5764
+ interface IsInAutomationMigrationPopulationRequest {
5765
+ }
5766
+ interface IsInAutomationMigrationPopulationResponse {
5767
+ inPopulation?: boolean;
5768
+ }
5769
+ interface PreparePaymentCollectionRequest {
5891
5770
  /**
5892
- * 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.
5893
- * @readonly
5771
+ * Ecom order ID.
5772
+ * @minLength 1
5773
+ * @maxLength 100
5894
5774
  */
5895
- updatedDate?: Date | null;
5775
+ ecomOrderId: string;
5776
+ /** Amount to collect */
5777
+ amount: Price;
5896
5778
  /**
5897
- * Amount.
5898
- * @readonly
5899
- * @immutable
5779
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5780
+ * Existing payment gateway order will be updated with a new amount.
5781
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
5900
5782
  */
5901
- amount?: Price;
5783
+ paymentGatewayOrderId?: string | null;
5902
5784
  /**
5903
- * Reversal amount. Present only when status is REVERSED.
5904
- * @readonly
5785
+ * Whether to delay capture of the payment.
5786
+ * Default: false
5787
+ * @deprecated Whether to delay capture of the payment.
5788
+ * Default: false
5789
+ * @replacedBy delayed_capture_settings.scheduled_action
5790
+ * @targetRemovalDate 2024-09-30
5905
5791
  */
5906
- reversalAmount?: Price;
5792
+ delayedCapture?: boolean;
5907
5793
  /**
5908
- * Status.
5909
- *
5910
- * Default: `"APPROVED"`.
5794
+ * Specifies whether payment collection is initiated by Merchant or User of User
5795
+ * Default: `true`
5796
+ * @internal
5911
5797
  */
5912
- status?: ChargebackStatusWithLiterals;
5798
+ merchantInitiated?: boolean | null;
5913
5799
  /**
5914
- * External chargeback ID.
5915
- * @format GUID
5916
- * @readonly
5917
- * @immutable
5800
+ * Redirect urls which are used to return buyer to third party system.
5801
+ * @internal
5918
5802
  */
5919
- externalId?: string | null;
5920
- }
5921
- declare enum ChargebackStatus {
5922
- /** Chargeback was approved. */
5923
- APPROVED = "APPROVED",
5924
- /** Chargeback was reversed. */
5925
- REVERSED = "REVERSED"
5803
+ redirectUrls?: RedirectUrls;
5804
+ /** Delayed capture payment settings */
5805
+ delayedCaptureSettings?: DelayedCaptureSettings;
5926
5806
  }
5927
- /** @enumType */
5928
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5929
- interface PaymentMethodName {
5807
+ interface RedirectUrls {
5930
5808
  /**
5931
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5932
- * @maxLength 150
5809
+ * URL to redirect buyer in case of approved (successful) transaction
5810
+ * @format WEB_URL
5933
5811
  */
5934
- buyerLanguageName?: string | null;
5812
+ successUrl?: string | null;
5935
5813
  /**
5936
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5937
- *
5938
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5939
- * @maxLength 150
5814
+ * URL to redirect buyer in case of buyer canceled the transaction
5815
+ * @format WEB_URL
5940
5816
  */
5941
- siteLanguageName?: string | null;
5817
+ cancelUrl?: string | null;
5942
5818
  /**
5943
- * User-provided payment method name.
5944
- *
5945
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5819
+ * URL to redirect buyer in case of failed/rejected transaction
5820
+ * @format WEB_URL
5946
5821
  */
5947
- userDefinedName?: UserDefinedPaymentMethodName;
5948
- }
5949
- interface GiftCardPaymentDetails {
5822
+ errorUrl?: string | null;
5950
5823
  /**
5951
- * Gift card payment ID.
5952
- * @maxLength 100
5824
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
5825
+ * @format WEB_URL
5953
5826
  */
5954
- giftCardPaymentId?: string;
5827
+ pendingUrl?: string | null;
5828
+ }
5829
+ interface DelayedCaptureSettings {
5830
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5831
+ scheduledAction?: ScheduledActionWithLiterals;
5832
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
5833
+ delayDuration?: Duration;
5834
+ }
5835
+ declare enum ScheduledAction {
5836
+ /** Whether payment will be auto-voided when duration passes */
5837
+ VOID = "VOID",
5838
+ /** Whether payment will be auto-captured when duration passes */
5839
+ CAPTURE = "CAPTURE"
5840
+ }
5841
+ /** @enumType */
5842
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5843
+ interface Duration {
5955
5844
  /**
5956
- * Gift card ID.
5957
- * @internal
5958
- * @deprecated
5845
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5846
+ * @min 1
5959
5847
  */
5960
- giftCardId?: string;
5848
+ count?: number;
5849
+ /** Duration unit: MINUTES, HOURS and DAYS */
5850
+ unit?: DurationUnitWithLiterals;
5851
+ }
5852
+ declare enum DurationUnit {
5853
+ MINUTES = "MINUTES",
5854
+ HOURS = "HOURS",
5855
+ DAYS = "DAYS"
5856
+ }
5857
+ /** @enumType */
5858
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5859
+ interface PreparePaymentCollectionResponse {
5860
+ /** Payment gateway order id which is associated with given payment */
5861
+ paymentGatewayOrderId?: string;
5862
+ }
5863
+ interface GetPaymentCollectabilityStatusRequest {
5961
5864
  /**
5962
- * ID of the app that created the gift card.
5963
- * @format GUID
5865
+ * Ecom order ID.
5866
+ * @minLength 1
5867
+ * @maxLength 100
5964
5868
  */
5965
- appId?: string;
5869
+ ecomOrderId: string;
5870
+ }
5871
+ interface GetPaymentCollectabilityStatusResponse {
5872
+ /** Payment collectability status */
5873
+ status?: PaymentCollectabilityStatusWithLiterals;
5874
+ /** Collectable order amount */
5875
+ amount?: Price;
5966
5876
  /**
5967
- * Whether the gift card is voided.
5968
- * @readonly
5969
- * @deprecated Whether the gift card is voided.
5970
- * @replacedBy payment.status
5971
- * @targetRemovalDate 2026-11-01
5877
+ * Whether authorization supported
5878
+ * @internal
5972
5879
  */
5973
- voided?: boolean;
5880
+ authorizationSupported?: boolean;
5974
5881
  /**
5975
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5976
- * @maxLength 30
5977
- * @immutable
5882
+ * Whether custom amount is supported for payment collection
5883
+ * @internal
5978
5884
  */
5979
- obfuscatedCode?: string | null;
5885
+ customAmountSupported?: boolean;
5980
5886
  }
5981
- interface MembershipPaymentDetails {
5982
- /**
5983
- * Membership ID.
5984
- * @maxLength 200
5985
- */
5986
- membershipId?: string;
5887
+ declare enum PaymentCollectabilityStatus {
5888
+ UNKNOWN = "UNKNOWN",
5889
+ COLLECTABLE = "COLLECTABLE",
5890
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5891
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5892
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5893
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5894
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5895
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5896
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5897
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5898
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5899
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5900
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5901
+ }
5902
+ /** @enumType */
5903
+ 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';
5904
+ interface RecordManuallyCollectedPaymentRequest {
5987
5905
  /**
5988
- * ID of the line item this membership applies to.
5906
+ * Order ID.
5989
5907
  * @minLength 1
5990
5908
  * @maxLength 100
5991
5909
  */
5992
- lineItemId?: string;
5910
+ orderId: string;
5911
+ /** Amount to be recorded as approved manual payment for given order */
5912
+ amount: Price;
5993
5913
  /**
5994
- * Payment status.
5995
- * @deprecated Payment status.
5996
- * @replacedBy payment.status
5997
- * @targetRemovalDate 2026-11-01
5914
+ * Payment method name provided by user.
5915
+ *
5916
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5917
+ * @internal
5998
5918
  */
5999
- status?: MembershipPaymentStatusWithLiterals;
6000
- /** Membership name. */
6001
- name?: MembershipName;
5919
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5920
+ }
5921
+ /**
5922
+ * User-defined payment method name.
5923
+ * Allows specifying either a predefined type or a custom name.
5924
+ */
5925
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5926
+ /** Predefined payment method. */
5927
+ predefined?: PredefinedPaymentMethodWithLiterals;
6002
5928
  /**
6003
- * The transaction ID in the membership system. Can be used to void the transaction.
5929
+ * Custom payment method name provided by user.
5930
+ *
5931
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
6004
5932
  * @minLength 1
6005
- * @maxLength 100
6006
- */
6007
- externalTransactionId?: string | null;
6008
- /**
6009
- * Whether the membership is voided.
6010
- * @readonly
6011
- * @deprecated Whether the membership is voided.
6012
- * @replacedBy payment.status
6013
- * @targetRemovalDate 2026-11-01
5933
+ * @maxLength 150
6014
5934
  */
6015
- voided?: boolean;
5935
+ custom?: string | null;
5936
+ }
5937
+ /** @oneof */
5938
+ interface UserDefinedPaymentMethodNameKindOneOf {
5939
+ /** Predefined payment method. */
5940
+ predefined?: PredefinedPaymentMethodWithLiterals;
6016
5941
  /**
6017
- * ID of the application providing this payment option.
6018
- * @format GUID
5942
+ * Custom payment method name provided by user.
5943
+ *
5944
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5945
+ * @minLength 1
5946
+ * @maxLength 150
6019
5947
  */
6020
- providerAppId?: string;
6021
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6022
- futureMembership?: FutureMembershipDetails;
5948
+ custom?: string | null;
6023
5949
  }
6024
- declare enum MembershipPaymentStatus {
6025
- /** Payment was charged. */
6026
- CHARGED = "CHARGED",
6027
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
6028
- CHARGE_FAILED = "CHARGE_FAILED",
6029
- /** Payment is pending. */
6030
- CHARGE_PENDING = "CHARGE_PENDING",
6031
- /** Payment was voided. */
6032
- VOIDED = "VOIDED"
5950
+ /** Predefined payment method types for offline/manual payments. */
5951
+ declare enum PredefinedPaymentMethod {
5952
+ /** Cash payment. */
5953
+ CASH = "CASH",
5954
+ /** Bank transfer. */
5955
+ BANK_TRANSFER = "BANK_TRANSFER",
5956
+ /** Payment by check. */
5957
+ CHECK = "CHECK"
6033
5958
  }
6034
5959
  /** @enumType */
6035
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6036
- interface FutureMembershipDetails {
5960
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5961
+ interface RecordManuallyCollectedPaymentResponse {
5962
+ }
5963
+ interface MarkOrderAsPaidRequest {
6037
5964
  /**
6038
- * ID of the plan line item in the order from which the membership will be created.
6039
- * @format GUID
5965
+ * Ecom order ID.
5966
+ * @minLength 1
5967
+ * @maxLength 100
6040
5968
  */
6041
- lineItemId?: string;
5969
+ ecomOrderId: string;
6042
5970
  /**
6043
- * ID of the benefit the future membership will grant.
6044
- * @maxLength 200
5971
+ * Payment method name provided by user.
5972
+ *
5973
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5974
+ * @internal
6045
5975
  */
6046
- benefitId?: string;
5976
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
6047
5977
  }
6048
- interface WixReceiptInfo {
6049
- /**
6050
- * Receipt ID
6051
- * @format GUID
6052
- */
6053
- receiptId?: string;
5978
+ interface MarkOrderAsPaidResponse {
5979
+ /** Updated order. */
5980
+ order?: Order;
5981
+ }
5982
+ interface BulkMarkOrdersAsPaidRequest {
6054
5983
  /**
6055
- * Display number of receipt
5984
+ * IDs of orders to mark as paid.
5985
+ * @minSize 1
5986
+ * @maxSize 100
6056
5987
  * @minLength 1
6057
- * @maxLength 40
5988
+ * @maxLength 100
6058
5989
  */
6059
- displayNumber?: string | null;
5990
+ ecomOrderIds: string[];
6060
5991
  }
6061
- interface ExternalReceiptInfo {
5992
+ interface BulkMarkOrdersAsPaidResponse {
6062
5993
  /**
6063
- * External receipt ID
6064
- * @maxLength 100
5994
+ * Items updated by the bulk action.
5995
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
6065
5996
  */
6066
- receiptId?: string | null;
5997
+ results?: BulkOrderResult[];
5998
+ /** Bulk action metadata. */
5999
+ bulkActionMetadata?: BulkActionMetadata;
6000
+ }
6001
+ interface BulkOrderResult {
6002
+ /** Item metadata. */
6003
+ itemMetadata?: ItemMetadata;
6067
6004
  /**
6068
- * ID of the app providing the receipt
6069
- * @format GUID
6005
+ * Updated order.
6006
+ *
6007
+ * Returned when `returnFullEntity = true`.
6070
6008
  */
6071
- appId?: string | null;
6009
+ item?: Order;
6010
+ }
6011
+ interface ItemMetadata {
6012
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
6013
+ id?: string | null;
6014
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
6015
+ originalIndex?: number;
6016
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
6017
+ success?: boolean;
6018
+ /** Details about the error in case of failure. */
6019
+ error?: ApplicationError;
6020
+ }
6021
+ interface ApplicationError {
6022
+ /** Error code. */
6023
+ code?: string;
6024
+ /** Description of the error. */
6025
+ description?: string;
6026
+ /** Data related to the error. */
6027
+ data?: Record<string, any> | null;
6028
+ }
6029
+ interface BulkActionMetadata {
6030
+ /** Number of items that were successfully processed. */
6031
+ totalSuccesses?: number;
6032
+ /** Number of items that couldn't be processed. */
6033
+ totalFailures?: number;
6034
+ /** Number of failures without details because detailed failure threshold was exceeded. */
6035
+ undetailedFailures?: number;
6036
+ }
6037
+ interface GetRefundabilityStatusRequest {
6072
6038
  /**
6073
- * Display number of receipt
6039
+ * Order ID.
6074
6040
  * @minLength 1
6075
- * @maxLength 40
6041
+ * @maxLength 100
6076
6042
  */
6077
- displayNumber?: string | null;
6043
+ ecomOrderId: string;
6078
6044
  }
6079
- interface CashRoundingDetails {
6080
- /**
6081
- * Payment amount before cash rounding was applied.
6082
- * When provided, balance and status calculations use this value instead of `amount`
6083
- * to prevent false overpayment or underpayment due to rounding.
6084
- */
6085
- unroundedAmount?: Price;
6045
+ interface GetRefundabilityStatusResponse {
6086
6046
  /**
6087
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6088
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6089
- * @readonly
6047
+ * Refundability details.
6048
+ * @maxSize 300
6090
6049
  */
6091
- roundingAdjustment?: CashRounding;
6092
- }
6093
- declare enum PaymentStatus {
6094
- /** Payment was charged successfully. */
6095
- APPROVED = "APPROVED",
6096
- /** Payment is being processed and hasn't been confirmed yet. */
6097
- PENDING = "PENDING",
6098
- /** 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. */
6099
- PENDING_MERCHANT = "PENDING_MERCHANT",
6100
- /** Payment was canceled before it was charged. */
6101
- CANCELED = "CANCELED",
6102
- /** Payment was declined by the payment provider. */
6103
- DECLINED = "DECLINED",
6104
- /** Payment was fully refunded. */
6105
- REFUNDED = "REFUNDED",
6106
- /** Part of the payment amount was refunded. */
6107
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6108
- /** 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. */
6109
- AUTHORIZED = "AUTHORIZED",
6050
+ refundabilities?: Refundability[];
6110
6051
  /**
6111
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6112
- *
6113
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6052
+ * Whether the order supports refunding per item.
6053
+ * @deprecated
6114
6054
  */
6115
- VOIDED = "VOIDED"
6116
- }
6117
- /** @enumType */
6118
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6119
- interface CanceledStatusDetails {
6120
- reason?: CanceledReasonWithLiterals;
6055
+ refundablePerItem?: boolean;
6121
6056
  }
6122
- declare enum CanceledReason {
6123
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
6124
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6125
- /** Payment was not completed by user and expired. */
6126
- EXPIRED = "EXPIRED"
6057
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
6058
+ /** Reason why payment is not refundable. */
6059
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
6060
+ /** Reason why payment is only refundable manually. */
6061
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
6062
+ /** Payment ID. */
6063
+ paymentId?: string;
6064
+ /** Payment refundability status. */
6065
+ refundabilityStatus?: RefundableStatusWithLiterals;
6066
+ /** Link to payment provider dashboard. */
6067
+ providerLink?: string | null;
6127
6068
  }
6128
- /** @enumType */
6129
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6130
- interface DeclinedStatusDetails {
6131
- reason?: DeclinedReasonWithLiterals;
6069
+ /** @oneof */
6070
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
6071
+ /** Reason why payment is not refundable. */
6072
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
6073
+ /** Reason why payment is only refundable manually. */
6074
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
6132
6075
  }
6133
- declare enum DeclinedReason {
6134
- /** Corresponding charge failed. */
6135
- CHARGE_FAILED = "CHARGE_FAILED",
6136
- /** Payment details expired. */
6137
- EXPIRED = "EXPIRED",
6138
- /** Insufficient funds. */
6139
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6140
- /** Gift card was disabled before charge was attempted. */
6141
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6076
+ declare enum RefundableStatus {
6077
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
6078
+ MANUAL = "MANUAL",
6079
+ REFUNDABLE = "REFUNDABLE"
6142
6080
  }
6143
6081
  /** @enumType */
6144
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6145
- interface VoidedStatusDetails {
6146
- reason?: VoidedReasonWithLiterals;
6082
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
6083
+ declare enum NonRefundableReason {
6084
+ NONE = "NONE",
6085
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
6086
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
6087
+ INTERNAL_ERROR = "INTERNAL_ERROR",
6088
+ NOT_PAID = "NOT_PAID",
6089
+ ACCESS_DENIED = "ACCESS_DENIED",
6090
+ ZERO_PRICE = "ZERO_PRICE",
6091
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
6092
+ PENDING_REFUND = "PENDING_REFUND",
6093
+ FORBIDDEN = "FORBIDDEN",
6094
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
6095
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
6096
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
6147
6097
  }
6148
- declare enum VoidedReason {
6149
- /** Payment was voided by merchant request. */
6150
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
6151
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6152
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6098
+ /** @enumType */
6099
+ 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';
6100
+ declare enum ManuallyRefundableReason {
6101
+ EXPIRED = "EXPIRED",
6102
+ NOT_SUPPORTED = "NOT_SUPPORTED",
6103
+ OFFLINE = "OFFLINE",
6104
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
6153
6105
  }
6154
6106
  /** @enumType */
6155
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6156
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6157
- /** @internal */
6158
- canceled?: CanceledStatusDetails;
6159
- /** @internal */
6160
- declined?: DeclinedStatusDetails;
6161
- /** @internal */
6162
- voided?: VoidedStatusDetails;
6107
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
6108
+ interface CreatePaymentGatewayOrderRequest {
6163
6109
  /**
6164
- * Reason code from the payment gateway.
6165
- * @internal
6110
+ * Ecom order ID.
6166
6111
  * @minLength 1
6167
- * @maxLength 10
6112
+ * @maxLength 100
6168
6113
  */
6169
- paymentGatewayReasonCode?: string | null;
6170
- }
6171
- /** @oneof */
6172
- interface PaymentStatusDetailsStatusDetailsOneOf {
6173
- /** @internal */
6174
- canceled?: CanceledStatusDetails;
6175
- /** @internal */
6176
- declined?: DeclinedStatusDetails;
6177
- /** @internal */
6178
- voided?: VoidedStatusDetails;
6114
+ ecomOrderId: string;
6115
+ /** Information about the user who initiated the payment. */
6116
+ chargedBy?: ChargedBy;
6117
+ /**
6118
+ * Whether to delay capture of the payment.
6119
+ *
6120
+ * Default: false
6121
+ * @internal
6122
+ */
6123
+ delayedCapture?: boolean;
6179
6124
  }
6180
- interface Refund {
6125
+ interface ChargedBy {
6181
6126
  /**
6182
- * Refund ID.
6127
+ * ID - id of the user who initiated the payment
6183
6128
  * @format GUID
6184
- * @readonly
6185
6129
  */
6186
6130
  id?: string;
6187
6131
  /**
6188
- * List of transactions.
6189
- * @maxSize 50
6132
+ * Full name - name of the user who initiated the payment
6133
+ * @minLength 1
6134
+ * @maxLength 200
6190
6135
  */
6191
- transactions?: RefundTransaction[];
6192
- /** Refund business details. */
6193
- details?: RefundDetails;
6136
+ fullName?: string | null;
6137
+ }
6138
+ interface CreatePaymentGatewayOrderResponse {
6139
+ /** ID of the order created in the payment gateway */
6140
+ paymentGatewayOrderId?: string;
6141
+ }
6142
+ interface ChargeMembershipsRequest {
6194
6143
  /**
6195
- * 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.
6196
- * @readonly
6197
- * @immutable
6144
+ * Order ID.
6145
+ * @minLength 1
6146
+ * @maxLength 100
6198
6147
  */
6199
- createdDate?: Date | null;
6148
+ ecomOrderId: string;
6200
6149
  /**
6201
- * Aggregated refund summary.
6202
- * @readonly
6150
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
6151
+ * but a user which is using the membership on behalf of the a member
6152
+ * @format GUID
6203
6153
  */
6204
- summary?: AggregatedRefundSummary;
6154
+ memberId: string;
6205
6155
  /**
6206
- * ID of the app that initiated this refund.
6207
- * @format GUID
6208
- * @readonly
6209
- * @immutable
6156
+ * List of items to be paid by memberships
6157
+ * @minSize 1
6158
+ * @maxSize 300
6210
6159
  */
6211
- requestingServiceAppId?: string | null;
6160
+ membershipCharges?: MembershipChargeItem[];
6212
6161
  }
6213
- interface RefundTransaction {
6162
+ interface MembershipChargeItem {
6214
6163
  /**
6215
- * ID of the payment associated with this refund.
6164
+ * The id of used membership
6165
+ * @minLength 1
6166
+ * @maxLength 100
6167
+ */
6168
+ membershipId?: string;
6169
+ /**
6170
+ * ID of the application providing this payment option
6216
6171
  * @format GUID
6217
- * @immutable
6218
6172
  */
6219
- paymentId?: string;
6173
+ appId?: string;
6174
+ /** The name of used membership */
6175
+ membershipName?: MembershipName;
6176
+ /** Additional data about this membership */
6177
+ membershipAdditionalData?: Record<string, any> | null;
6178
+ /** Catalog and item reference info. */
6179
+ catalogReference?: CatalogReference;
6180
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
6181
+ serviceProperties?: ServiceProperties;
6220
6182
  /**
6221
- * Refund amount.
6222
- * @immutable
6183
+ * Usually would be the same as catalogReference.catalogItemId
6184
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
6185
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
6186
+ * @minLength 1
6187
+ * @maxLength 36
6223
6188
  */
6224
- amount?: Price;
6225
- /** Refund status. */
6226
- refundStatus?: RefundStatusWithLiterals;
6227
- /** Optional details of current refund status. */
6228
- refundStatusInfo?: RefundStatusInfo;
6189
+ rootCatalogItemId?: string | null;
6229
6190
  /**
6230
- * Payment gateway's refund ID.
6231
- * This field is only returned when the value of `external_refund` is `false`.
6232
- * @format GUID
6191
+ * line item id of Checkout/Order line item
6192
+ * @minLength 1
6193
+ * @maxLength 100
6233
6194
  */
6234
- gatewayRefundId?: string | null;
6235
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6236
- providerRefundId?: string | null;
6195
+ lineItemId?: string;
6196
+ }
6197
+ interface MembershipName {
6237
6198
  /**
6238
- * Whether refund was made externally and manually on the payment provider's side.
6239
- * @immutable
6199
+ * Membership name in the site's original language.
6200
+ * @maxLength 100
6240
6201
  */
6241
- externalRefund?: boolean;
6202
+ original?: string;
6242
6203
  /**
6243
- * Location where the refund was processed.
6244
- * @internal
6245
- * @format GUID
6246
- * @immutable
6204
+ * Membership name translated into the buyer's language.
6205
+ *
6206
+ * Default: The value of `original`
6207
+ * @maxLength 100
6247
6208
  */
6248
- locationId?: string | null;
6209
+ translated?: string | null;
6249
6210
  }
6250
- /** Refund transaction status. */
6251
- declare enum RefundStatus {
6252
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6253
- PENDING = "PENDING",
6254
- /** Refund transaction succeeded. */
6255
- SUCCEEDED = "SUCCEEDED",
6256
- /** Refund transaction failed. */
6257
- FAILED = "FAILED",
6258
- /** Refund request acknowledged, and will be executed soon. */
6259
- SCHEDULED = "SCHEDULED",
6260
- /** Refund was initiated on payment provider side. */
6261
- STARTED = "STARTED"
6211
+ interface ChargeMembershipsResponse {
6262
6212
  }
6263
- /** @enumType */
6264
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6265
- interface RefundStatusInfo {
6213
+ interface TriggerRefundRequest {
6214
+ /**
6215
+ * The order this refund related to
6216
+ * @minLength 1
6217
+ * @maxLength 100
6218
+ */
6219
+ ecomOrderId: string;
6220
+ /**
6221
+ * Refund operations information
6222
+ * @minSize 1
6223
+ * @maxSize 1
6224
+ */
6225
+ payments: PaymentRefund[];
6226
+ /** Business model of a refund */
6227
+ details?: RefundDetails;
6228
+ /** Side effect details related to refund */
6229
+ sideEffects?: RefundSideEffects;
6230
+ }
6231
+ interface PaymentRefund {
6232
+ /**
6233
+ * Specific payment within the order to refund
6234
+ * @format GUID
6235
+ */
6236
+ paymentId?: string;
6237
+ /** Refund amount. Not relevant for membership and gift card refunds. */
6238
+ amount?: Price;
6266
6239
  /**
6267
- * Reason code for the refund's current status.
6268
- *
6269
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6240
+ * Whether refund is made externally and manually (on the payment provider's side)
6241
+ * 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.
6242
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
6243
+ */
6244
+ externalRefund?: boolean;
6245
+ /**
6246
+ * Gateway refund id. When param is present, new refund is not created.
6247
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
6248
+ * and all side effects from request will be executed.
6249
+ * @internal
6270
6250
  * @minLength 1
6271
- * @maxLength 10
6251
+ * @maxLength 100
6272
6252
  */
6273
- paymentGatewayReasonCode?: string | null;
6253
+ gatewayRefundId?: string | null;
6254
+ }
6255
+ interface RefundSideEffects {
6256
+ /** Inventory restock details as part of this refund. */
6257
+ restockInfo?: RestockInfo;
6258
+ /** Whether to send a refund confirmation email to the customer. */
6259
+ sendOrderRefundedEmail?: boolean;
6274
6260
  /**
6275
- * Free text explanation of current refund status.
6261
+ * Custom message added to the refund confirmation email.
6276
6262
  * @minLength 1
6277
6263
  * @maxLength 1000
6278
6264
  */
6279
- description?: string | null;
6280
- }
6281
- interface AggregatedRefundSummary {
6282
- /** Total amount requested for refund. */
6283
- requestedRefund?: Price;
6284
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6285
- pendingRefund?: Price;
6286
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6287
- refunded?: Price;
6288
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
6289
- failedRefundAmount?: Price;
6290
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
6291
- pending?: boolean;
6292
- /** Breakdown of refunded items. Available only after refund is complete. */
6293
- breakdown?: RefundItemsBreakdown;
6265
+ customMessage?: string | null;
6294
6266
  }
6295
- interface RefundItemsBreakdown {
6267
+ interface RestockInfo {
6268
+ /** Restock type. */
6269
+ type?: RestockTypeWithLiterals;
6296
6270
  /**
6297
- * Refunded line items and the amount refunded for each.
6271
+ * Deprecated, use items instead
6272
+ * @internal
6298
6273
  * @maxSize 300
6274
+ * @deprecated
6299
6275
  */
6300
- lineItems?: LineItemRefundSummary[];
6276
+ lineItemIds?: string[];
6277
+ /**
6278
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
6279
+ * @maxSize 300
6280
+ */
6281
+ items?: RestockItem[];
6301
6282
  }
6302
- interface LineItemRefundSummary {
6283
+ declare enum RestockType {
6284
+ NO_ITEMS = "NO_ITEMS",
6285
+ ALL_ITEMS = "ALL_ITEMS",
6286
+ SOME_ITEMS = "SOME_ITEMS"
6287
+ }
6288
+ /** @enumType */
6289
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
6290
+ interface RestockItem {
6303
6291
  /**
6304
- * ID of the refunded line item.
6292
+ * ID of the line item being restocked.
6305
6293
  * @format GUID
6306
6294
  */
6307
6295
  lineItemId?: string;
6308
- /** Total refunded amount for the line item. */
6309
- totalRefundedAmount?: Price;
6310
- }
6311
- interface CalculateRefundRequest {
6312
6296
  /**
6313
- * Order ID
6314
- * @minLength 1
6315
- * @maxLength 100
6297
+ * Line item quantity being restocked.
6298
+ * @min 1
6299
+ * @max 100000
6316
6300
  */
6317
- ecomOrderId?: string;
6301
+ quantity?: number;
6318
6302
  /**
6319
- * Refunded line items and quantity
6320
- * @maxSize 300
6303
+ * Per-location breakdown of restock quantities.
6304
+ * @internal
6305
+ * @maxSize 5
6321
6306
  */
6322
- refundItems?: CalculateRefundItemRequest[];
6323
- /** Should include shipping in refund calculation */
6324
- refundShipping?: boolean;
6307
+ restockLocations?: RestockLocation[];
6325
6308
  }
6326
- interface CalculateRefundItemRequest {
6309
+ interface TriggerRefundResponse {
6310
+ /** All order's transactions after the refunds were added */
6311
+ orderTransactions?: OrderTransactions;
6312
+ /** Created refund ID */
6313
+ refundId?: string | null;
6314
+ /** Payment ID's that the refund execution had failed for */
6315
+ failedPaymentIds?: ItemMetadata[];
6316
+ }
6317
+ /**
6318
+ * A record of all payments and refunds associated with an order.
6319
+ *
6320
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
6321
+ */
6322
+ interface OrderTransactions {
6327
6323
  /**
6328
- * ID of the line item being refunded
6324
+ * Order ID.
6329
6325
  * @format GUID
6330
6326
  */
6331
- id?: string;
6327
+ orderId?: string;
6332
6328
  /**
6333
- * How much of that line item is being refunded
6334
- * @min 1
6335
- * @max 100000
6329
+ * Record of payments made to the merchant.
6330
+ * @maxSize 100
6336
6331
  */
6337
- quantity?: number;
6338
- }
6339
- interface CalculateRefundResponse {
6340
- /** Total refundable amount */
6341
- total?: Price;
6342
- /** Tax cost of the order */
6343
- tax?: Price;
6344
- /** Discount given for this order */
6345
- discount?: Price;
6346
- /** Total cost of the order (without tax) */
6347
- subtotal?: Price;
6348
- /** Total shipping cost for order */
6349
- shipping?: Price;
6350
- /** Previous refund given on that order */
6351
- previouslyRefundedAmount?: Price;
6332
+ payments?: Payment[];
6352
6333
  /**
6353
- * The refundable items of that order
6334
+ * Record of refunds made to the buyer.
6354
6335
  * @maxSize 300
6355
6336
  */
6356
- items?: CalculateRefundItemResponse[];
6337
+ refunds?: Refund[];
6357
6338
  }
6358
- interface CalculateRefundItemResponse {
6339
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
6340
+ /** Regular payment details. */
6341
+ regularPaymentDetails?: RegularPaymentDetails;
6342
+ /** Gift card payment details. */
6343
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6344
+ /** Membership payment details. */
6345
+ membershipPaymentDetails?: MembershipPaymentDetails;
6359
6346
  /**
6360
- * Line item ID
6347
+ * Receipt created by Wix
6348
+ * @internal
6349
+ */
6350
+ wixReceipt?: WixReceiptInfo;
6351
+ /**
6352
+ * Receipt created by an external system.
6353
+ * @internal
6354
+ */
6355
+ externalReceipt?: ExternalReceiptInfo;
6356
+ /** @internal */
6357
+ canceled?: CanceledStatusDetails;
6358
+ /** @internal */
6359
+ declined?: DeclinedStatusDetails;
6360
+ /** @internal */
6361
+ voided?: VoidedStatusDetails;
6362
+ /**
6363
+ * Payment ID.
6361
6364
  * @format GUID
6365
+ * @readonly
6362
6366
  */
6363
- id?: string;
6364
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6365
- price?: Price;
6366
- }
6367
- interface VoidAuthorizedPaymentsRequest {
6367
+ id?: string | null;
6368
+ /** 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. */
6369
+ createdDate?: Date | null;
6368
6370
  /**
6369
- * Wix eCommerce order ID
6370
- * @minLength 1
6371
- * @maxLength 100
6371
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
6372
+ * @readonly
6372
6373
  */
6373
- ecomOrderId: string;
6374
+ updatedDate?: Date | null;
6375
+ /** Payment amount. */
6376
+ amount?: Price;
6374
6377
  /**
6375
- * Payment IDs
6376
- * @minSize 1
6377
- * @maxSize 100
6378
+ * Whether refunds for this payment are disabled.
6379
+ * + `true`: This payment is not refundable.
6380
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
6381
+ */
6382
+ refundDisabled?: boolean;
6383
+ /**
6384
+ * Whether receipt generation is allowed for this payment.
6385
+ * + `true`: This payment supports receipt generation.
6386
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
6387
+ * @readonly
6388
+ */
6389
+ supportReceiptGeneration?: boolean;
6390
+ /** Details about cash rounding applied to this payment, when relevant. */
6391
+ cashRounding?: CashRoundingDetails;
6392
+ /**
6393
+ * Overall payment status.
6394
+ *
6395
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
6396
+ */
6397
+ status?: PaymentStatusWithLiterals;
6398
+ /**
6399
+ * Detailed payment status information including gateway reason codes and status-specific details.
6400
+ * @internal
6401
+ */
6402
+ paymentStatusDetails?: PaymentStatusDetails;
6403
+ /**
6404
+ * Location where the payment was processed.
6405
+ * @internal
6378
6406
  * @format GUID
6407
+ * @immutable
6379
6408
  */
6380
- paymentIds: string[];
6409
+ locationId?: string | null;
6410
+ /**
6411
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
6412
+ * @format GUID
6413
+ */
6414
+ chargeCorrelationId?: string | null;
6381
6415
  }
6382
- interface VoidAuthorizedPaymentsResponse {
6383
- /** All order's transactions after the void was triggered */
6384
- orderTransactions?: OrderTransactions;
6416
+ /** @oneof */
6417
+ interface PaymentPaymentDetailsOneOf {
6418
+ /** Regular payment details. */
6419
+ regularPaymentDetails?: RegularPaymentDetails;
6420
+ /** Gift card payment details. */
6421
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6422
+ /** Membership payment details. */
6423
+ membershipPaymentDetails?: MembershipPaymentDetails;
6385
6424
  }
6386
- interface CaptureAuthorizedPaymentsRequest {
6425
+ /** @oneof */
6426
+ interface PaymentReceiptInfoOneOf {
6387
6427
  /**
6388
- * Wix eCommerce order ID
6389
- * @minLength 1
6390
- * @maxLength 100
6428
+ * Receipt created by Wix
6429
+ * @internal
6391
6430
  */
6392
- ecomOrderId: string;
6431
+ wixReceipt?: WixReceiptInfo;
6432
+ /**
6433
+ * Receipt created by an external system.
6434
+ * @internal
6435
+ */
6436
+ externalReceipt?: ExternalReceiptInfo;
6437
+ }
6438
+ /** @oneof */
6439
+ interface PaymentStatusDetailsOneOf {
6440
+ /** @internal */
6441
+ canceled?: CanceledStatusDetails;
6442
+ /** @internal */
6443
+ declined?: DeclinedStatusDetails;
6444
+ /** @internal */
6445
+ voided?: VoidedStatusDetails;
6446
+ }
6447
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6448
+ /** Credit card details. */
6449
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6393
6450
  /**
6394
- * Capture payments information
6395
- * @minSize 1
6396
- * @maxSize 100
6451
+ * Wix Payments order ID.
6452
+ * @maxLength 100
6397
6453
  */
6398
- payments: PaymentCapture[];
6399
- }
6400
- interface PaymentCapture {
6454
+ paymentOrderId?: string | null;
6401
6455
  /**
6402
- * Payment ID
6403
- * @format GUID
6456
+ * Payment gateway's transaction ID.
6457
+ * This field is only returned when the value of `offline_payment` is `false`.
6458
+ * @maxLength 100
6404
6459
  */
6405
- paymentId?: string | null;
6460
+ gatewayTransactionId?: string | null;
6406
6461
  /**
6407
- * Capture amount.
6408
- * If not provided - full authorized amount will be captured.
6462
+ * Payment method.
6463
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6464
+ * Non-exhaustive list of supported values:
6465
+ * + `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`
6466
+ * @maxLength 150
6467
+ * @deprecated Payment method.
6468
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6469
+ * Non-exhaustive list of supported values:
6470
+ * + `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`
6471
+ * @replacedBy payment_method_name
6472
+ * @targetRemovalDate 2026-07-01
6409
6473
  */
6410
- amount?: Price;
6411
- }
6412
- interface CaptureAuthorizedPaymentsResponse {
6413
- /** All order's transactions after the capture was triggered */
6414
- orderTransactions?: OrderTransactions;
6415
- }
6416
- interface ChargeSavedPaymentMethodRequest {
6474
+ paymentMethod?: string | null;
6417
6475
  /**
6418
- * Ecom Order ID.
6419
- * @minLength 1
6476
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6420
6477
  * @maxLength 100
6421
6478
  */
6422
- ecomOrderId?: string;
6423
- /** Amount to be charged */
6424
- amount?: Price;
6425
- }
6426
- interface ChargeSavedPaymentMethodResponse {
6427
- /** Payment gateway's order ID (e.g Wix Payments) */
6428
- paymentGatewayOrderId?: string;
6429
- }
6430
- interface SendBuyerConfirmationEmailRequest {
6431
- /** @format GUID */
6432
- orderId?: string;
6433
- }
6434
- interface SendBuyerConfirmationEmailResponse {
6435
- }
6436
- interface SendBuyerPaymentsReceivedEmailRequest {
6479
+ providerTransactionId?: string | null;
6480
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6481
+ offlinePayment?: boolean;
6437
6482
  /**
6438
- * @minLength 1
6439
- * @maxLength 100
6483
+ * Payment status.
6484
+ * @deprecated Payment status.
6485
+ * @replacedBy payment.status
6486
+ * @targetRemovalDate 2026-11-01
6440
6487
  */
6441
- orderId?: string;
6442
- }
6443
- interface SendBuyerPaymentsReceivedEmailResponse {
6444
- }
6445
- interface SendBuyerPickupConfirmationEmailRequest {
6488
+ status?: TransactionStatusWithLiterals;
6489
+ /** Whether there is a payment agreement that allows for future charges. */
6490
+ savedPaymentMethod?: boolean;
6491
+ /** Authorization details. */
6492
+ authorizationDetails?: AuthorizationDetails;
6446
6493
  /**
6447
- * @minLength 1
6448
- * @maxLength 100
6494
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6495
+ * @internal
6496
+ * @maxLength 300
6449
6497
  */
6450
- orderId?: string;
6451
- }
6452
- interface SendBuyerPickupConfirmationEmailResponse {
6453
- }
6454
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
6498
+ paymentProvider?: string | null;
6455
6499
  /**
6456
- * IDs of orders to send pickup emails for.
6457
- * @minSize 1
6458
- * @maxSize 300
6500
+ * Record of chargebacks made by the buyer.
6501
+ * @maxSize 6
6459
6502
  */
6460
- orderIds?: string[];
6461
- }
6462
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
6463
- }
6464
- interface SendBuyerShippingConfirmationEmailRequest {
6503
+ chargebacks?: Chargeback[];
6465
6504
  /**
6466
- * @minLength 1
6467
- * @maxLength 100
6505
+ * Payment method ID.
6506
+ * @internal
6507
+ * @maxLength 36
6468
6508
  */
6469
- orderId?: string;
6470
- }
6471
- interface SendBuyerShippingConfirmationEmailResponse {
6472
- }
6473
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
6509
+ paymentMethodId?: string | null;
6510
+ /** Platform fee amount associated with this payment. */
6511
+ platformFee?: Price;
6474
6512
  /**
6475
- * IDs of orders to send pickup emails for.
6476
- * @minSize 1
6477
- * @maxSize 300
6513
+ * Payment method with buyer and optional owner translations.
6514
+ * Non-exhaustive list of supported values:
6515
+ * + `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`
6478
6516
  */
6479
- orderIds?: string[];
6517
+ paymentMethodName?: PaymentMethodName;
6480
6518
  }
6481
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
6519
+ /** @oneof */
6520
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6521
+ /** Credit card details. */
6522
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6482
6523
  }
6483
- interface SendMerchantOrderReceivedNotificationRequest {
6524
+ declare enum TransactionStatus {
6525
+ UNDEFINED = "UNDEFINED",
6526
+ APPROVED = "APPROVED",
6527
+ PENDING = "PENDING",
6528
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6529
+ CANCELED = "CANCELED",
6530
+ DECLINED = "DECLINED",
6531
+ REFUNDED = "REFUNDED",
6532
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6533
+ AUTHORIZED = "AUTHORIZED",
6534
+ VOIDED = "VOIDED"
6535
+ }
6536
+ /** @enumType */
6537
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6538
+ interface CreditCardPaymentMethodDetails {
6484
6539
  /**
6485
- * @minLength 1
6486
- * @maxLength 100
6540
+ * The last 4 digits of the card number.
6541
+ * @maxLength 4
6487
6542
  */
6488
- orderId?: string;
6489
- }
6490
- interface SendMerchantOrderReceivedNotificationResponse {
6491
- }
6492
- interface SendCancelRefundEmailRequest {
6543
+ lastFourDigits?: string | null;
6493
6544
  /**
6494
- * The ID of order that is canceled/refunded
6495
- * @minLength 1
6545
+ * Card issuer's brand.
6496
6546
  * @maxLength 100
6497
6547
  */
6498
- orderId?: string;
6548
+ brand?: string | null;
6549
+ }
6550
+ interface AuthorizationDetails {
6499
6551
  /**
6500
- * Personal note added to the email (optional)
6501
- * @minLength 1
6502
- * @maxLength 1000
6552
+ * Whether the authorized payment is of a delayed capture.
6553
+ * @readonly
6503
6554
  */
6504
- customMessage?: string | null;
6505
- /** Refund amount */
6506
- refundAmount?: Price;
6555
+ delayedCapture?: boolean;
6556
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6557
+ authorizedDate?: Date | null;
6507
6558
  /**
6508
- * Refund ID. (Optional)
6509
- * @format GUID
6559
+ * List of captures associated with payment
6560
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6561
+ * @maxSize 1
6510
6562
  */
6511
- refundId?: string | null;
6512
- }
6513
- interface SendCancelRefundEmailResponse {
6563
+ captures?: AuthorizationCapture[];
6564
+ /** Void associated with payment */
6565
+ void?: AuthorizationVoid;
6566
+ /** Scheduled action for this transaction */
6567
+ scheduledAction?: V1ScheduledAction;
6514
6568
  }
6515
- interface SendRefundEmailRequest {
6516
- /**
6517
- * The ID of order that is refunded
6518
- * @format GUID
6519
- */
6520
- orderId?: string;
6569
+ interface AuthorizationCapture {
6521
6570
  /**
6522
- * Refund ID
6571
+ * Capture ID.
6523
6572
  * @format GUID
6573
+ * @readonly
6524
6574
  */
6525
- refundId?: string;
6575
+ id?: string | null;
6576
+ /** Status of this capture action */
6577
+ status?: AuthorizationCaptureStatusWithLiterals;
6526
6578
  /**
6527
- * Personal note added to the email (optional)
6528
- * @minLength 1
6529
- * @maxLength 1000
6579
+ * Amount of this capture
6580
+ * @immutable
6530
6581
  */
6531
- customMessage?: string | null;
6582
+ amount?: Price;
6583
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6584
+ createdDate?: Date | null;
6585
+ /** In case of status is FAILED may contain failure details */
6586
+ failureDetails?: AuthorizationActionFailureDetails;
6532
6587
  }
6533
- interface SendRefundEmailResponse {
6588
+ declare enum AuthorizationCaptureStatus {
6589
+ /** Capture operation still in progress. */
6590
+ PENDING = "PENDING",
6591
+ /** Capture operation succeeded. */
6592
+ SUCCEEDED = "SUCCEEDED",
6593
+ /** Capture operation failed. */
6594
+ FAILED = "FAILED"
6534
6595
  }
6535
- interface SendFulfillmentEmailRequest {
6536
- /** @format GUID */
6537
- orderId?: string;
6538
- /** @format GUID */
6539
- fulfillerId?: string;
6596
+ /** @enumType */
6597
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6598
+ interface AuthorizationActionFailureDetails {
6599
+ /** @maxLength 100 */
6600
+ failureCode?: string;
6540
6601
  }
6541
- interface SendFulfillmentEmailResponse {
6602
+ interface AuthorizationVoid {
6603
+ /** Status of this void action */
6604
+ status?: AuthorizationVoidStatusWithLiterals;
6605
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6606
+ voidedDate?: Date | null;
6607
+ /** In case of status is FAILED may contain failure details */
6608
+ failureDetails?: AuthorizationActionFailureDetails;
6609
+ /** Reason of void action */
6610
+ reason?: ReasonWithLiterals;
6542
6611
  }
6543
- interface SendMerchantOrderReceivedPushRequest {
6544
- /**
6545
- * @minLength 1
6546
- * @maxLength 100
6547
- */
6548
- orderId?: string;
6612
+ declare enum AuthorizationVoidStatus {
6613
+ /** Void operation still in progress. */
6614
+ PENDING = "PENDING",
6615
+ /** Void operation succeeded. */
6616
+ SUCCEEDED = "SUCCEEDED",
6617
+ /** Void operation failed. */
6618
+ FAILED = "FAILED"
6549
6619
  }
6550
- interface SendMerchantOrderReceivedPushResponse {
6620
+ /** @enumType */
6621
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6622
+ /** Reason the authorization was voided. */
6623
+ declare enum Reason {
6624
+ /** Authorization was voided by user. */
6625
+ MANUAL = "MANUAL",
6626
+ /** Authorization passed execution date. */
6627
+ SCHEDULED = "SCHEDULED"
6551
6628
  }
6552
- interface PreviewEmailByTypeRequest {
6553
- emailType?: PreviewEmailTypeWithLiterals;
6629
+ /** @enumType */
6630
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6631
+ interface V1ScheduledAction {
6632
+ /** Type of the action. */
6633
+ actionType?: ActionTypeWithLiterals;
6634
+ /** The date and time of the action. */
6635
+ executionDate?: Date | null;
6554
6636
  }
6555
- declare enum PreviewEmailType {
6556
- ORDER_PLACED = "ORDER_PLACED",
6557
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6558
- ORDER_SHIPPED = "ORDER_SHIPPED",
6559
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6637
+ declare enum ActionType {
6638
+ VOID = "VOID",
6639
+ CAPTURE = "CAPTURE"
6560
6640
  }
6561
6641
  /** @enumType */
6562
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6563
- interface PreviewEmailByTypeResponse {
6564
- emailPreview?: string;
6565
- }
6566
- interface PreviewRefundEmailRequest {
6567
- /**
6568
- * @minLength 1
6569
- * @maxLength 100
6570
- */
6571
- orderId?: string;
6572
- /** Refund amount */
6573
- refundAmount?: Price;
6574
- /** Refund business details */
6575
- details?: RefundDetails;
6642
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6643
+ interface Chargeback {
6576
6644
  /**
6577
- * Personal note added to the email (optional)
6578
- * @minLength 1
6579
- * @maxLength 1000
6645
+ * Chargeback ID.
6646
+ * @format GUID
6647
+ * @readonly
6648
+ * @immutable
6580
6649
  */
6581
- customMessage?: string | null;
6650
+ id?: string;
6582
6651
  /**
6583
- * Refund ID. (Optional)
6584
- * @format GUID
6652
+ * 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.
6653
+ * @readonly
6654
+ * @immutable
6585
6655
  */
6586
- refundId?: string | null;
6587
- }
6588
- interface PreviewRefundEmailResponse {
6589
- emailPreview?: string;
6590
- }
6591
- interface PreviewCancelEmailRequest {
6656
+ createdDate?: Date | null;
6592
6657
  /**
6593
- * @minLength 1
6594
- * @maxLength 100
6658
+ * 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.
6659
+ * @readonly
6595
6660
  */
6596
- orderId?: string;
6661
+ updatedDate?: Date | null;
6597
6662
  /**
6598
- * Personal note added to the email (optional)
6599
- * @minLength 1
6600
- * @maxLength 1000
6663
+ * Amount.
6664
+ * @readonly
6665
+ * @immutable
6601
6666
  */
6602
- customMessage?: string | null;
6603
- }
6604
- interface PreviewCancelEmailResponse {
6605
- emailPreview?: string;
6606
- }
6607
- interface PreviewCancelRefundEmailRequest {
6667
+ amount?: Price;
6608
6668
  /**
6609
- * @minLength 1
6610
- * @maxLength 100
6669
+ * Reversal amount. Present only when status is REVERSED.
6670
+ * @readonly
6611
6671
  */
6612
- orderId?: string;
6672
+ reversalAmount?: Price;
6613
6673
  /**
6614
- * Personal note added to the email (optional)
6615
- * @minLength 1
6616
- * @maxLength 1000
6674
+ * Status.
6675
+ *
6676
+ * Default: `"APPROVED"`.
6617
6677
  */
6618
- customMessage?: string | null;
6619
- /** Refund amount */
6620
- refundAmount?: Price;
6678
+ status?: ChargebackStatusWithLiterals;
6621
6679
  /**
6622
- * Refund ID. (Optional)
6680
+ * External chargeback ID.
6623
6681
  * @format GUID
6682
+ * @readonly
6683
+ * @immutable
6624
6684
  */
6625
- refundId?: string | null;
6626
- }
6627
- interface PreviewCancelRefundEmailResponse {
6628
- emailPreview?: string;
6629
- }
6630
- interface PreviewBuyerPaymentsReceivedEmailRequest {
6631
- }
6632
- interface PreviewBuyerPaymentsReceivedEmailResponse {
6633
- emailPreview?: string;
6634
- }
6635
- interface PreviewBuyerConfirmationEmailRequest {
6636
- }
6637
- interface PreviewBuyerConfirmationEmailResponse {
6638
- emailPreview?: string;
6639
- }
6640
- interface PreviewBuyerPickupConfirmationEmailRequest {
6641
- }
6642
- interface PreviewBuyerPickupConfirmationEmailResponse {
6643
- emailPreview?: string;
6644
- }
6645
- interface PreviewShippingConfirmationEmailRequest {
6646
- }
6647
- interface PreviewShippingConfirmationEmailResponse {
6648
- emailPreview?: string;
6649
- }
6650
- interface PreviewResendDownloadLinksEmailRequest {
6685
+ externalId?: string | null;
6651
6686
  }
6652
- interface PreviewResendDownloadLinksEmailResponse {
6653
- emailPreview?: string;
6687
+ declare enum ChargebackStatus {
6688
+ /** Chargeback was approved. */
6689
+ APPROVED = "APPROVED",
6690
+ /** Chargeback was reversed. */
6691
+ REVERSED = "REVERSED"
6654
6692
  }
6655
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6656
- /** Emitted on a meta site creation. */
6657
- siteCreated?: SiteCreated;
6658
- /** Emitted on a meta site transfer completion. */
6659
- siteTransferred?: SiteTransferred;
6660
- /** Emitted on a meta site deletion. */
6661
- siteDeleted?: SiteDeleted;
6662
- /** Emitted on a meta site restoration. */
6663
- siteUndeleted?: SiteUndeleted;
6664
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6665
- sitePublished?: SitePublished;
6666
- /** Emitted on a meta site unpublish. */
6667
- siteUnpublished?: SiteUnpublished;
6668
- /** Emitted when meta site is marked as template. */
6669
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6670
- /** Emitted when meta site is marked as a WixSite. */
6671
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6672
- /** Emitted when an application is provisioned (installed). */
6673
- serviceProvisioned?: ServiceProvisioned;
6674
- /** Emitted when an application is removed (uninstalled). */
6675
- serviceRemoved?: ServiceRemoved;
6676
- /** Emitted when meta site name (URL slug) is changed. */
6677
- siteRenamedPayload?: SiteRenamed;
6678
- /** Emitted when meta site was permanently deleted. */
6679
- hardDeleted?: SiteHardDeleted;
6680
- /** Emitted on a namespace change. */
6681
- namespaceChanged?: NamespaceChanged;
6682
- /** Emitted when Studio is attached. */
6683
- studioAssigned?: StudioAssigned;
6684
- /** Emitted when Studio is detached. */
6685
- studioUnassigned?: StudioUnassigned;
6693
+ /** @enumType */
6694
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6695
+ interface PaymentMethodName {
6686
6696
  /**
6687
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6688
- * the actual URL.
6689
- *
6690
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6691
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6697
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6698
+ * @maxLength 150
6692
6699
  */
6693
- urlChanged?: SiteUrlChanged;
6694
- /** Site is marked as PurgedExternally */
6695
- sitePurgedExternally?: SitePurgedExternally;
6696
- /** Emitted when Odeditor is attached. */
6697
- odeditorAssigned?: OdeditorAssigned;
6698
- /** Emitted when Odeditor is detached. */
6699
- odeditorUnassigned?: OdeditorUnassigned;
6700
- /** Emitted when Picasso is attached. */
6701
- picassoAssigned?: PicassoAssigned;
6702
- /** Emitted when Picasso is detached. */
6703
- picassoUnassigned?: PicassoUnassigned;
6704
- /** Emitted when Wixel is attached. */
6705
- wixelAssigned?: WixelAssigned;
6706
- /** Emitted when Wixel is detached. */
6707
- wixelUnassigned?: WixelUnassigned;
6708
- /** Emitted when StudioTwo is attached. */
6709
- studioTwoAssigned?: StudioTwoAssigned;
6710
- /** Emitted when StudioTwo is detached. */
6711
- studioTwoUnassigned?: StudioTwoUnassigned;
6712
- /** Emitted when media from user domain is enabled. */
6713
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6714
- /** Emitted when media from user domain is disabled. */
6715
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6716
- /** Emitted when Editorless is attached. */
6717
- editorlessAssigned?: EditorlessAssigned;
6718
- /** Emitted when Editorless is detached. */
6719
- editorlessUnassigned?: EditorlessUnassigned;
6700
+ buyerLanguageName?: string | null;
6720
6701
  /**
6721
- * A meta site id.
6722
- * @format GUID
6702
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6703
+ *
6704
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6705
+ * @maxLength 150
6723
6706
  */
6724
- metaSiteId?: string;
6725
- /** A meta site version. Monotonically increasing. */
6726
- version?: string;
6727
- /** A timestamp of the event. */
6728
- timestamp?: string;
6707
+ siteLanguageName?: string | null;
6729
6708
  /**
6730
- * TODO(meta-site): Change validation once validations are disabled for consumers
6731
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6732
- * @maxSize 4000
6709
+ * User-provided payment method name.
6710
+ *
6711
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6733
6712
  */
6734
- assets?: Asset[];
6713
+ userDefinedName?: UserDefinedPaymentMethodName;
6735
6714
  }
6736
- /** @oneof */
6737
- interface MetaSiteSpecialEventPayloadOneOf {
6738
- /** Emitted on a meta site creation. */
6739
- siteCreated?: SiteCreated;
6740
- /** Emitted on a meta site transfer completion. */
6741
- siteTransferred?: SiteTransferred;
6742
- /** Emitted on a meta site deletion. */
6743
- siteDeleted?: SiteDeleted;
6744
- /** Emitted on a meta site restoration. */
6745
- siteUndeleted?: SiteUndeleted;
6746
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6747
- sitePublished?: SitePublished;
6748
- /** Emitted on a meta site unpublish. */
6749
- siteUnpublished?: SiteUnpublished;
6750
- /** Emitted when meta site is marked as template. */
6751
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6752
- /** Emitted when meta site is marked as a WixSite. */
6753
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6754
- /** Emitted when an application is provisioned (installed). */
6755
- serviceProvisioned?: ServiceProvisioned;
6756
- /** Emitted when an application is removed (uninstalled). */
6757
- serviceRemoved?: ServiceRemoved;
6758
- /** Emitted when meta site name (URL slug) is changed. */
6759
- siteRenamedPayload?: SiteRenamed;
6760
- /** Emitted when meta site was permanently deleted. */
6761
- hardDeleted?: SiteHardDeleted;
6762
- /** Emitted on a namespace change. */
6763
- namespaceChanged?: NamespaceChanged;
6764
- /** Emitted when Studio is attached. */
6765
- studioAssigned?: StudioAssigned;
6766
- /** Emitted when Studio is detached. */
6767
- studioUnassigned?: StudioUnassigned;
6715
+ interface GiftCardPaymentDetails {
6716
+ /**
6717
+ * Gift card payment ID.
6718
+ * @maxLength 100
6719
+ */
6720
+ giftCardPaymentId?: string;
6721
+ /**
6722
+ * Gift card ID.
6723
+ * @internal
6724
+ * @deprecated
6725
+ */
6726
+ giftCardId?: string;
6768
6727
  /**
6769
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6770
- * the actual URL.
6771
- *
6772
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6773
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6728
+ * ID of the app that created the gift card.
6729
+ * @format GUID
6774
6730
  */
6775
- urlChanged?: SiteUrlChanged;
6776
- /** Site is marked as PurgedExternally */
6777
- sitePurgedExternally?: SitePurgedExternally;
6778
- /** Emitted when Odeditor is attached. */
6779
- odeditorAssigned?: OdeditorAssigned;
6780
- /** Emitted when Odeditor is detached. */
6781
- odeditorUnassigned?: OdeditorUnassigned;
6782
- /** Emitted when Picasso is attached. */
6783
- picassoAssigned?: PicassoAssigned;
6784
- /** Emitted when Picasso is detached. */
6785
- picassoUnassigned?: PicassoUnassigned;
6786
- /** Emitted when Wixel is attached. */
6787
- wixelAssigned?: WixelAssigned;
6788
- /** Emitted when Wixel is detached. */
6789
- wixelUnassigned?: WixelUnassigned;
6790
- /** Emitted when StudioTwo is attached. */
6791
- studioTwoAssigned?: StudioTwoAssigned;
6792
- /** Emitted when StudioTwo is detached. */
6793
- studioTwoUnassigned?: StudioTwoUnassigned;
6794
- /** Emitted when media from user domain is enabled. */
6795
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6796
- /** Emitted when media from user domain is disabled. */
6797
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6798
- /** Emitted when Editorless is attached. */
6799
- editorlessAssigned?: EditorlessAssigned;
6800
- /** Emitted when Editorless is detached. */
6801
- editorlessUnassigned?: EditorlessUnassigned;
6802
- }
6803
- interface Asset {
6731
+ appId?: string;
6804
6732
  /**
6805
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6806
- * @maxLength 36
6733
+ * Whether the gift card is voided.
6734
+ * @readonly
6735
+ * @deprecated Whether the gift card is voided.
6736
+ * @replacedBy payment.status
6737
+ * @targetRemovalDate 2026-11-01
6807
6738
  */
6808
- appDefId?: string;
6739
+ voided?: boolean;
6809
6740
  /**
6810
- * An instance id. For legacy reasons may be UUID or a string.
6741
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6742
+ * @maxLength 30
6743
+ * @immutable
6744
+ */
6745
+ obfuscatedCode?: string | null;
6746
+ }
6747
+ interface MembershipPaymentDetails {
6748
+ /**
6749
+ * Membership ID.
6811
6750
  * @maxLength 200
6812
6751
  */
6813
- instanceId?: string;
6814
- /** An application state. */
6815
- state?: StateWithLiterals;
6752
+ membershipId?: string;
6753
+ /**
6754
+ * ID of the line item this membership applies to.
6755
+ * @minLength 1
6756
+ * @maxLength 100
6757
+ */
6758
+ lineItemId?: string;
6759
+ /**
6760
+ * Payment status.
6761
+ * @deprecated Payment status.
6762
+ * @replacedBy payment.status
6763
+ * @targetRemovalDate 2026-11-01
6764
+ */
6765
+ status?: MembershipPaymentStatusWithLiterals;
6766
+ /** Membership name. */
6767
+ name?: MembershipName;
6768
+ /**
6769
+ * The transaction ID in the membership system. Can be used to void the transaction.
6770
+ * @minLength 1
6771
+ * @maxLength 100
6772
+ */
6773
+ externalTransactionId?: string | null;
6774
+ /**
6775
+ * Whether the membership is voided.
6776
+ * @readonly
6777
+ * @deprecated Whether the membership is voided.
6778
+ * @replacedBy payment.status
6779
+ * @targetRemovalDate 2026-11-01
6780
+ */
6781
+ voided?: boolean;
6782
+ /**
6783
+ * ID of the application providing this payment option.
6784
+ * @format GUID
6785
+ */
6786
+ providerAppId?: string;
6787
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6788
+ futureMembership?: FutureMembershipDetails;
6816
6789
  }
6817
- declare enum State {
6818
- UNKNOWN = "UNKNOWN",
6819
- ENABLED = "ENABLED",
6820
- DISABLED = "DISABLED",
6821
- PENDING = "PENDING",
6822
- DEMO = "DEMO"
6790
+ declare enum MembershipPaymentStatus {
6791
+ /** Payment was charged. */
6792
+ CHARGED = "CHARGED",
6793
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
6794
+ CHARGE_FAILED = "CHARGE_FAILED",
6795
+ /** Payment is pending. */
6796
+ CHARGE_PENDING = "CHARGE_PENDING",
6797
+ /** Payment was voided. */
6798
+ VOIDED = "VOIDED"
6823
6799
  }
6824
6800
  /** @enumType */
6825
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6826
- interface SiteCreated {
6801
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6802
+ interface FutureMembershipDetails {
6827
6803
  /**
6828
- * A template identifier (empty if not created from a template).
6829
- * @maxLength 36
6804
+ * ID of the plan line item in the order from which the membership will be created.
6805
+ * @format GUID
6830
6806
  */
6831
- originTemplateId?: string;
6807
+ lineItemId?: string;
6832
6808
  /**
6833
- * An account id of the owner.
6834
- * @format GUID
6809
+ * ID of the benefit the future membership will grant.
6810
+ * @maxLength 200
6835
6811
  */
6836
- ownerId?: string;
6837
- /** A context in which meta site was created. */
6838
- context?: SiteCreatedContextWithLiterals;
6812
+ benefitId?: string;
6813
+ }
6814
+ interface WixReceiptInfo {
6839
6815
  /**
6840
- * A meta site id from which this site was created.
6841
- *
6842
- * In case of a creation from a template it's a template id.
6843
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6816
+ * Receipt ID
6844
6817
  * @format GUID
6845
6818
  */
6846
- originMetaSiteId?: string | null;
6819
+ receiptId?: string;
6847
6820
  /**
6848
- * A meta site name (URL slug).
6849
- * @maxLength 20
6821
+ * Display number of receipt
6822
+ * @minLength 1
6823
+ * @maxLength 40
6850
6824
  */
6851
- siteName?: string;
6852
- /** A namespace. */
6853
- namespace?: NamespaceWithLiterals;
6854
- }
6855
- declare enum SiteCreatedContext {
6856
- /** A valid option, we don't expose all reasons why site might be created. */
6857
- OTHER = "OTHER",
6858
- /** A meta site was created from template. */
6859
- FROM_TEMPLATE = "FROM_TEMPLATE",
6860
- /** A meta site was created by copying of the transfferred meta site. */
6861
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6862
- /** A copy of existing meta site. */
6863
- DUPLICATE = "DUPLICATE",
6864
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6865
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6866
- /** deprecated A meta site was created for Flash editor. */
6867
- FLASH = "FLASH"
6825
+ displayNumber?: string | null;
6868
6826
  }
6869
- /** @enumType */
6870
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6871
- declare enum Namespace {
6872
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6873
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6874
- WIX = "WIX",
6875
- /** 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. */
6876
- SHOUT_OUT = "SHOUT_OUT",
6877
- /** 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. */
6878
- ALBUMS = "ALBUMS",
6879
- /** 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. */
6880
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6881
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6882
- HOTELS = "HOTELS",
6883
- /** 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. */
6884
- CLUBS = "CLUBS",
6885
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6886
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6827
+ interface ExternalReceiptInfo {
6887
6828
  /**
6888
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6889
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6829
+ * External receipt ID
6830
+ * @maxLength 100
6890
6831
  */
6891
- DEV_SITE = "DEV_SITE",
6892
- /** 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. */
6893
- LOGOS = "LOGOS",
6894
- /** 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. */
6895
- VIDEO_MAKER = "VIDEO_MAKER",
6896
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6897
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6898
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6899
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6832
+ receiptId?: string | null;
6900
6833
  /**
6901
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6902
- *
6903
- * Meta site with this namespace will *not* be shown in a user's site list by default.
6834
+ * ID of the app providing the receipt
6835
+ * @format GUID
6904
6836
  */
6905
- HTML_DRAFT = "HTML_DRAFT",
6837
+ appId?: string | null;
6906
6838
  /**
6907
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6908
- * Will be accessible from Site List and will not have a website app.
6909
- * Once the user attaches a site, the site will become a regular wixsite.
6839
+ * Display number of receipt
6840
+ * @minLength 1
6841
+ * @maxLength 40
6910
6842
  */
6911
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
6912
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6913
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
6914
- /** It is to be used in the Business First efforts. */
6915
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
6916
- /** Bookings business flow with no site. */
6917
- ANYWHERE = "ANYWHERE",
6918
- /** Namespace for Headless Backoffice with no editor */
6919
- HEADLESS = "HEADLESS",
6843
+ displayNumber?: string | null;
6844
+ }
6845
+ interface CashRoundingDetails {
6920
6846
  /**
6921
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6922
- * The site will be used for account level CSM feature for enterprise
6847
+ * Payment amount before cash rounding was applied.
6848
+ * When provided, balance and status calculations use this value instead of `amount`
6849
+ * to prevent false overpayment or underpayment due to rounding.
6923
6850
  */
6924
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6925
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6926
- RISE = "RISE",
6851
+ unroundedAmount?: Price;
6852
+ /**
6853
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6854
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6855
+ * @readonly
6856
+ */
6857
+ roundingAdjustment?: CashRounding;
6858
+ }
6859
+ declare enum PaymentStatus {
6860
+ /** Payment was charged successfully. */
6861
+ APPROVED = "APPROVED",
6862
+ /** Payment is being processed and hasn't been confirmed yet. */
6863
+ PENDING = "PENDING",
6864
+ /** 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. */
6865
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6866
+ /** Payment was canceled before it was charged. */
6867
+ CANCELED = "CANCELED",
6868
+ /** Payment was declined by the payment provider. */
6869
+ DECLINED = "DECLINED",
6870
+ /** Payment was fully refunded. */
6871
+ REFUNDED = "REFUNDED",
6872
+ /** Part of the payment amount was refunded. */
6873
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6874
+ /** 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. */
6875
+ AUTHORIZED = "AUTHORIZED",
6927
6876
  /**
6928
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6929
- * There's a blank site behind the scene but it's blank).
6930
- * The Mobile company will be the owner of this namespace.
6877
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6878
+ *
6879
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6931
6880
  */
6932
- BRANDED_FIRST = "BRANDED_FIRST",
6933
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6934
- NOWNIA = "NOWNIA",
6881
+ VOIDED = "VOIDED"
6882
+ }
6883
+ /** @enumType */
6884
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6885
+ interface CanceledStatusDetails {
6886
+ reason?: CanceledReasonWithLiterals;
6887
+ }
6888
+ declare enum CanceledReason {
6889
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
6890
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6891
+ /** Payment was not completed by user and expired. */
6892
+ EXPIRED = "EXPIRED"
6893
+ }
6894
+ /** @enumType */
6895
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6896
+ interface DeclinedStatusDetails {
6897
+ reason?: DeclinedReasonWithLiterals;
6898
+ }
6899
+ declare enum DeclinedReason {
6900
+ /** Corresponding charge failed. */
6901
+ CHARGE_FAILED = "CHARGE_FAILED",
6902
+ /** Payment details expired. */
6903
+ EXPIRED = "EXPIRED",
6904
+ /** Insufficient funds. */
6905
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6906
+ /** Gift card was disabled before charge was attempted. */
6907
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6908
+ }
6909
+ /** @enumType */
6910
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6911
+ interface VoidedStatusDetails {
6912
+ reason?: VoidedReasonWithLiterals;
6913
+ }
6914
+ declare enum VoidedReason {
6915
+ /** Payment was voided by merchant request. */
6916
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6917
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6918
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6919
+ }
6920
+ /** @enumType */
6921
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6922
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6923
+ /** @internal */
6924
+ canceled?: CanceledStatusDetails;
6925
+ /** @internal */
6926
+ declined?: DeclinedStatusDetails;
6927
+ /** @internal */
6928
+ voided?: VoidedStatusDetails;
6935
6929
  /**
6936
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
6937
- * The Partners company owns this namespace.
6930
+ * Reason code from the payment gateway.
6931
+ * @internal
6932
+ * @minLength 1
6933
+ * @maxLength 10
6938
6934
  */
6939
- UGC_TEMPLATE = "UGC_TEMPLATE",
6940
- /** Codux Headless Sites */
6941
- CODUX = "CODUX",
6942
- /** Bobb - AI Design Creator. */
6943
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6935
+ paymentGatewayReasonCode?: string | null;
6936
+ }
6937
+ /** @oneof */
6938
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6939
+ /** @internal */
6940
+ canceled?: CanceledStatusDetails;
6941
+ /** @internal */
6942
+ declined?: DeclinedStatusDetails;
6943
+ /** @internal */
6944
+ voided?: VoidedStatusDetails;
6945
+ }
6946
+ interface Refund {
6944
6947
  /**
6945
- * Shared Blog Site is a unique single site across Enterprise account,
6946
- * This site will hold all Blog posts related to the Marketing product.
6948
+ * Refund ID.
6949
+ * @format GUID
6950
+ * @readonly
6947
6951
  */
6948
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6949
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6950
- STANDALONE_FORMS = "STANDALONE_FORMS",
6951
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6952
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
6953
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6954
- MIMIR = "MIMIR",
6955
- /** Wix Twins platform. */
6956
- TWINS = "TWINS",
6957
- /** Wix Nano. */
6958
- NANO = "NANO",
6959
- /** Base44 headless sites. */
6960
- BASE44 = "BASE44",
6961
- /** Wix Channels Sites */
6962
- CHANNELS = "CHANNELS",
6963
- /** Nautilus platform. */
6964
- NAUTILUS = "NAUTILUS",
6952
+ id?: string;
6965
6953
  /**
6966
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6967
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6954
+ * List of transactions.
6955
+ * @maxSize 50
6968
6956
  */
6969
- SYMPHONY = "SYMPHONY",
6970
- /** Nautilus platform app. */
6971
- NAUTILUS_APPS = "NAUTILUS_APPS",
6957
+ transactions?: RefundTransaction[];
6958
+ /** Refund business details. */
6959
+ details?: RefundDetails;
6972
6960
  /**
6973
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6974
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6961
+ * 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.
6962
+ * @readonly
6963
+ * @immutable
6975
6964
  */
6976
- VIBU = "VIBU",
6965
+ createdDate?: Date | null;
6977
6966
  /**
6978
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6979
- * (an Enterprise account may have several), holding that BrandKit's brand definition
6980
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6981
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
6967
+ * Aggregated refund summary.
6968
+ * @readonly
6982
6969
  */
6983
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6970
+ summary?: AggregatedRefundSummary;
6984
6971
  /**
6985
- * Dev-center development sites (com.wixpress.devcenter.dsm).
6986
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6972
+ * ID of the app that initiated this refund.
6973
+ * @format GUID
6974
+ * @readonly
6975
+ * @immutable
6987
6976
  */
6988
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6977
+ requestingServiceAppId?: string | null;
6989
6978
  }
6990
- /** @enumType */
6991
- 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';
6992
- /** Site transferred to another user. */
6993
- interface SiteTransferred {
6979
+ interface RefundTransaction {
6994
6980
  /**
6995
- * A previous owner id (user that transfers meta site).
6981
+ * ID of the payment associated with this refund.
6996
6982
  * @format GUID
6983
+ * @immutable
6997
6984
  */
6998
- oldOwnerId?: string;
6985
+ paymentId?: string;
6999
6986
  /**
7000
- * A new owner id (user that accepts meta site).
6987
+ * Refund amount.
6988
+ * @immutable
6989
+ */
6990
+ amount?: Price;
6991
+ /** Refund status. */
6992
+ refundStatus?: RefundStatusWithLiterals;
6993
+ /** Optional details of current refund status. */
6994
+ refundStatusInfo?: RefundStatusInfo;
6995
+ /**
6996
+ * Payment gateway's refund ID.
6997
+ * This field is only returned when the value of `external_refund` is `false`.
7001
6998
  * @format GUID
7002
6999
  */
7003
- newOwnerId?: string;
7004
- }
7005
- /** Soft deletion of the meta site. Could be restored. */
7006
- interface SiteDeleted {
7007
- /** A deletion context. */
7008
- deleteContext?: DeleteContext;
7009
- }
7010
- interface DeleteContext {
7011
- /** When the meta site was deleted. */
7012
- dateDeleted?: Date | null;
7013
- /** A status. */
7014
- deleteStatus?: DeleteStatusWithLiterals;
7000
+ gatewayRefundId?: string | null;
7001
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
7002
+ providerRefundId?: string | null;
7015
7003
  /**
7016
- * A reason (flow).
7017
- * @maxLength 255
7004
+ * Whether refund was made externally and manually on the payment provider's side.
7005
+ * @immutable
7018
7006
  */
7019
- deleteOrigin?: string;
7007
+ externalRefund?: boolean;
7020
7008
  /**
7021
- * A service that deleted it.
7022
- * @maxLength 255
7009
+ * Location where the refund was processed.
7010
+ * @internal
7011
+ * @format GUID
7012
+ * @immutable
7023
7013
  */
7024
- initiatorId?: string | null;
7014
+ locationId?: string | null;
7025
7015
  }
7026
- declare enum DeleteStatus {
7027
- UNKNOWN = "UNKNOWN",
7028
- TRASH = "TRASH",
7029
- DELETED = "DELETED",
7030
- PENDING_PURGE = "PENDING_PURGE",
7031
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
7016
+ /** Refund transaction status. */
7017
+ declare enum RefundStatus {
7018
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
7019
+ PENDING = "PENDING",
7020
+ /** Refund transaction succeeded. */
7021
+ SUCCEEDED = "SUCCEEDED",
7022
+ /** Refund transaction failed. */
7023
+ FAILED = "FAILED",
7024
+ /** Refund request acknowledged, and will be executed soon. */
7025
+ SCHEDULED = "SCHEDULED",
7026
+ /** Refund was initiated on payment provider side. */
7027
+ STARTED = "STARTED"
7032
7028
  }
7033
7029
  /** @enumType */
7034
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
7035
- /** Restoration of the meta site. */
7036
- interface SiteUndeleted {
7037
- }
7038
- /** First publish of a meta site. Or subsequent publish after unpublish. */
7039
- interface SitePublished {
7040
- }
7041
- interface SiteUnpublished {
7030
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
7031
+ interface RefundStatusInfo {
7042
7032
  /**
7043
- * A list of URLs previously associated with the meta site.
7044
- * @maxLength 4000
7045
- * @maxSize 10000
7033
+ * Reason code for the refund's current status.
7034
+ *
7035
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
7036
+ * @minLength 1
7037
+ * @maxLength 10
7046
7038
  */
7047
- urls?: string[];
7048
- }
7049
- interface SiteMarkedAsTemplate {
7050
- }
7051
- interface SiteMarkedAsWixSite {
7039
+ paymentGatewayReasonCode?: string | null;
7040
+ /**
7041
+ * Free text explanation of current refund status.
7042
+ * @minLength 1
7043
+ * @maxLength 1000
7044
+ */
7045
+ description?: string | null;
7052
7046
  }
7053
- /**
7054
- * Represents a service provisioned a site.
7055
- *
7056
- * Note on `origin_instance_id`:
7057
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
7058
- * This is because of the following scenario:
7059
- *
7060
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
7061
- * such as a product catalog. When you create a site from this template, you inherit this
7062
- * default product catalog. However, if the template's product catalog is modified,
7063
- * your site will retain the catalog as it was at the time of site creation. This ensures that
7064
- * your site remains consistent with what you initially received and does not include any
7065
- * changes made to the original template afterward.
7066
- * To ensure this, the TPA on the template gets a new instance_id.
7067
- */
7068
- interface ServiceProvisioned {
7047
+ interface AggregatedRefundSummary {
7048
+ /** Total amount requested for refund. */
7049
+ requestedRefund?: Price;
7050
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
7051
+ pendingRefund?: Price;
7052
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
7053
+ refunded?: Price;
7054
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
7055
+ failedRefundAmount?: Price;
7056
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
7057
+ pending?: boolean;
7058
+ /** Breakdown of refunded items. Available only after refund is complete. */
7059
+ breakdown?: RefundItemsBreakdown;
7060
+ }
7061
+ interface RefundItemsBreakdown {
7069
7062
  /**
7070
- * Either UUID or EmbeddedServiceType.
7071
- * @maxLength 36
7063
+ * Refunded line items and the amount refunded for each.
7064
+ * @maxSize 300
7072
7065
  */
7073
- appDefId?: string;
7066
+ lineItems?: LineItemRefundSummary[];
7067
+ }
7068
+ interface LineItemRefundSummary {
7074
7069
  /**
7075
- * Not only UUID. Something here could be something weird.
7076
- * @maxLength 36
7070
+ * ID of the refunded line item.
7071
+ * @format GUID
7077
7072
  */
7078
- instanceId?: string;
7073
+ lineItemId?: string;
7074
+ /** Total refunded amount for the line item. */
7075
+ totalRefundedAmount?: Price;
7076
+ }
7077
+ interface CalculateRefundRequest {
7079
7078
  /**
7080
- * An instance id from which this instance is originated.
7081
- * @maxLength 36
7079
+ * Order ID
7080
+ * @minLength 1
7081
+ * @maxLength 100
7082
7082
  */
7083
- originInstanceId?: string;
7083
+ ecomOrderId?: string;
7084
7084
  /**
7085
- * A version.
7086
- * @maxLength 500
7085
+ * Refunded line items and quantity
7086
+ * @maxSize 300
7087
7087
  */
7088
- version?: string | null;
7088
+ refundItems?: CalculateRefundItemRequest[];
7089
+ /** Should include shipping in refund calculation */
7090
+ refundShipping?: boolean;
7091
+ }
7092
+ interface CalculateRefundItemRequest {
7089
7093
  /**
7090
- * The origin meta site id
7094
+ * ID of the line item being refunded
7091
7095
  * @format GUID
7092
7096
  */
7093
- originMetaSiteId?: string | null;
7094
- }
7095
- interface ServiceRemoved {
7097
+ id?: string;
7096
7098
  /**
7097
- * Either UUID or EmbeddedServiceType.
7098
- * @maxLength 36
7099
+ * How much of that line item is being refunded
7100
+ * @min 1
7101
+ * @max 100000
7099
7102
  */
7100
- appDefId?: string;
7103
+ quantity?: number;
7104
+ }
7105
+ interface CalculateRefundResponse {
7106
+ /** Total refundable amount */
7107
+ total?: Price;
7108
+ /** Tax cost of the order */
7109
+ tax?: Price;
7110
+ /** Discount given for this order */
7111
+ discount?: Price;
7112
+ /** Total cost of the order (without tax) */
7113
+ subtotal?: Price;
7114
+ /** Total shipping cost for order */
7115
+ shipping?: Price;
7116
+ /** Previous refund given on that order */
7117
+ previouslyRefundedAmount?: Price;
7101
7118
  /**
7102
- * Not only UUID. Something here could be something weird.
7103
- * @maxLength 36
7119
+ * The refundable items of that order
7120
+ * @maxSize 300
7104
7121
  */
7105
- instanceId?: string;
7122
+ items?: CalculateRefundItemResponse[];
7123
+ }
7124
+ interface CalculateRefundItemResponse {
7106
7125
  /**
7107
- * A version.
7108
- * @maxLength 500
7126
+ * Line item ID
7127
+ * @format GUID
7109
7128
  */
7110
- version?: string | null;
7129
+ id?: string;
7130
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
7131
+ price?: Price;
7111
7132
  }
7112
- /** Rename of the site. Meaning, free public url has been changed as well. */
7113
- interface SiteRenamed {
7133
+ interface VoidAuthorizedPaymentsRequest {
7114
7134
  /**
7115
- * A new meta site name (URL slug).
7116
- * @maxLength 20
7135
+ * Wix eCommerce order ID
7136
+ * @minLength 1
7137
+ * @maxLength 100
7117
7138
  */
7118
- newSiteName?: string;
7139
+ ecomOrderId: string;
7119
7140
  /**
7120
- * A previous meta site name (URL slug).
7121
- * @maxLength 255
7141
+ * Payment IDs
7142
+ * @minSize 1
7143
+ * @maxSize 100
7144
+ * @format GUID
7122
7145
  */
7123
- oldSiteName?: string;
7124
- }
7125
- /**
7126
- * Hard deletion of the meta site.
7127
- *
7128
- * Could not be restored. Therefore it's desirable to cleanup data.
7129
- */
7130
- interface SiteHardDeleted {
7131
- /** A deletion context. */
7132
- deleteContext?: DeleteContext;
7133
- }
7134
- interface NamespaceChanged {
7135
- /** A previous namespace. */
7136
- oldNamespace?: NamespaceWithLiterals;
7137
- /** A new namespace. */
7138
- newNamespace?: NamespaceWithLiterals;
7139
- }
7140
- /** Assigned Studio editor */
7141
- interface StudioAssigned {
7142
- }
7143
- /** Unassigned Studio editor */
7144
- interface StudioUnassigned {
7146
+ paymentIds: string[];
7145
7147
  }
7146
- /**
7147
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
7148
- *
7149
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
7150
- * with sites and its urls, you need to listen to another topic/event. Read about it:
7151
- *
7152
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
7153
- */
7154
- interface SiteUrlChanged {
7148
+ interface VoidAuthorizedPaymentsResponse {
7149
+ /** All order's transactions after the void was triggered */
7150
+ orderTransactions?: OrderTransactions;
7155
7151
  }
7156
- /**
7157
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
7158
- * Consumed by other teams to remove relevant data.
7159
- */
7160
- interface SitePurgedExternally {
7152
+ interface CaptureAuthorizedPaymentsRequest {
7161
7153
  /**
7162
- * @maxLength 2048
7154
+ * Wix eCommerce order ID
7155
+ * @minLength 1
7156
+ * @maxLength 100
7157
+ */
7158
+ ecomOrderId: string;
7159
+ /**
7160
+ * Capture payments information
7161
+ * @minSize 1
7163
7162
  * @maxSize 100
7164
- * @deprecated
7165
- * @targetRemovalDate 2025-04-15
7166
7163
  */
7167
- appDefId?: string[];
7168
- }
7169
- /** Assigned Odeditor */
7170
- interface OdeditorAssigned {
7171
- }
7172
- /** Unassigned Odeditor */
7173
- interface OdeditorUnassigned {
7174
- }
7175
- /** Assigned Picasso editor */
7176
- interface PicassoAssigned {
7177
- }
7178
- /** Unassigned Picasso */
7179
- interface PicassoUnassigned {
7180
- }
7181
- /** Assigned Wixel */
7182
- interface WixelAssigned {
7183
- }
7184
- /** Unassigned Wixel */
7185
- interface WixelUnassigned {
7186
- }
7187
- /** Assigned StudioTwo */
7188
- interface StudioTwoAssigned {
7189
- }
7190
- /** Unassigned StudioTwo */
7191
- interface StudioTwoUnassigned {
7192
- }
7193
- /** Media from user domain is enabled. */
7194
- interface UserDomainMediaEnabled {
7195
- }
7196
- /** Media from user domain is disabled. */
7197
- interface UserDomainMediaDisabled {
7198
- }
7199
- /** Assigned Editorless */
7200
- interface EditorlessAssigned {
7201
- }
7202
- /** Unassigned Editorless */
7203
- interface EditorlessUnassigned {
7164
+ payments: PaymentCapture[];
7204
7165
  }
7205
- interface HasCustomEmailConfigurationsRequest {
7166
+ interface PaymentCapture {
7167
+ /**
7168
+ * Payment ID
7169
+ * @format GUID
7170
+ */
7171
+ paymentId?: string | null;
7172
+ /**
7173
+ * Capture amount.
7174
+ * If not provided - full authorized amount will be captured.
7175
+ */
7176
+ amount?: Price;
7206
7177
  }
7207
- interface HasCustomEmailConfigurationsResponse {
7208
- hasCustomConfigurations?: boolean;
7178
+ interface CaptureAuthorizedPaymentsResponse {
7179
+ /** All order's transactions after the capture was triggered */
7180
+ orderTransactions?: OrderTransactions;
7209
7181
  }
7210
- interface AddToAutomationMigrationPopulationRequest {
7211
- /** When true, sends custom email configurations to automation system via email */
7212
- sendCustomEmailConfigs?: boolean;
7213
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
7214
- origin?: OriginWithLiterals;
7182
+ interface ChargeSavedPaymentMethodRequest {
7183
+ /**
7184
+ * Ecom Order ID.
7185
+ * @minLength 1
7186
+ * @maxLength 100
7187
+ */
7188
+ ecomOrderId?: string;
7189
+ /** Amount to be charged */
7190
+ amount?: Price;
7215
7191
  }
7216
- declare enum Origin {
7217
- OPT_IN = "OPT_IN",
7218
- MIGRATION = "MIGRATION"
7192
+ interface ChargeSavedPaymentMethodResponse {
7193
+ /** Payment gateway's order ID (e.g Wix Payments) */
7194
+ paymentGatewayOrderId?: string;
7219
7195
  }
7220
- /** @enumType */
7221
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
7222
- interface AddToAutomationMigrationPopulationResponse {
7223
- success?: boolean;
7196
+ interface V1TriggerReindexRequest {
7197
+ /** @format GUID */
7198
+ metasiteId?: string;
7199
+ /**
7200
+ * @minLength 1
7201
+ * @maxLength 100
7202
+ * @maxSize 100
7203
+ */
7204
+ orderIds?: string[];
7224
7205
  }
7225
- interface IsInAutomationMigrationPopulationRequest {
7206
+ interface V1TriggerReindexResponse {
7226
7207
  }
7227
- interface IsInAutomationMigrationPopulationResponse {
7228
- inPopulation?: boolean;
7208
+ interface V1TriggerReindexOrderRequest {
7209
+ /** @format GUID */
7210
+ metasiteId?: string;
7211
+ /**
7212
+ * @minLength 1
7213
+ * @maxLength 100
7214
+ */
7215
+ orderId?: string;
7229
7216
  }
7230
7217
  interface DiffmatokyPayload {
7231
7218
  left?: string;