@wix/auto_sdk_ecom_orders 1.0.330 → 1.0.332

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