@wix/auto_sdk_payments_payments 1.0.0

package/build/internal/es/payments-platform-v1-payment-payments.universal-C5s3nmb-.d.mts

@@ -0,0 +1,1705 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { SearchSpec, Search, NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * A payment is a read-only aggregate view of a charge. Each payment
+ * combines a single charge with all of its related refunds, disputes, and
+ * notification of fraud into one entity, sharing its ID with the source charge.
+ */
+interface Payment {
+    /**
+     * Payment ID. Identical to the charge ID.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Date and time the payment was created.
+     * @immutable
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the payment was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * ID of the Wix app that initiated the checkout.
+     * @minLength 1
+     * @maxLength 255
+     * @readonly
+     */
+    appId?: string | null;
+    /**
+     * Whether a refund can currently be created for the payment, based on the
+     * charge state, payment method, and provider configuration. A `true` value
+     * can still result in a failed refund attempt due to permissions, account
+     * balance, or provider restrictions enforced at refund creation time.
+     * @readonly
+     */
+    refundable?: boolean | null;
+    /**
+     * Charge details for the payment, including amount, currency, status,
+     * payment method, and buyer information.
+     * @readonly
+     */
+    charge?: Charge;
+    /**
+     * List of refunds associated with the payment, ordered by creation date in descending order.
+     * For the complete refund history, use the [Refunds API](https://dev.wix.com/docs/api-reference/business-management/payments/refunds/introduction).
+     * @maxSize 50
+     * @readonly
+     */
+    refunds?: Refund[];
+    /**
+     * List of disputes associated with the payment, ordered by creation date in descending order.
+     * For the complete dispute history, use the [Disputes API](https://dev.wix.com/docs/api-reference/business-management/payments/disputes/introduction).
+     * @maxSize 20
+     * @readonly
+     */
+    disputes?: Dispute[];
+    /**
+     * Notification of fraud associated with this payment, if any.
+     *
+     * A charge has at most one notification of fraud.
+     * @readonly
+     */
+    notificationOfFraud?: NotificationOfFraud;
+}
+/**
+ * A charge is a record of an attempt to move money from a buyer to a merchant.
+ * Read more about charges in this [article](<https://dev.wix.com/docs/api-reference/business-management/payments/charges/introduction>).
+ */
+interface Charge {
+    /**
+     * Charge ID.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Date and time the charge was created.
+     * @immutable
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the charge was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * ID of the merchant's provider account connection.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    accountConnectionId?: string | null;
+    /**
+     * ID of the PaymentIntent that initiated the charge.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    paymentIntentId?: string | null;
+    /**
+     * Status of the charge.
+     * See the [Charges API](https://dev.wix.com/docs/api-reference/business-management/payments/charges/introduction) for more information.
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+    /**
+     * Additional details about the current charge status.
+     * @readonly
+     */
+    statusDetails?: StatusDetails;
+    /**
+     * Total charge amount in the currency's main units.
+     * For example, `12.95` for $12.95 USD.
+     * @decimalValue options { gte:0, maxScale:8 }
+     * @readonly
+     */
+    amount?: string | null;
+    /**
+     * Currency of the charge.
+     * @format CURRENCY
+     * @immutable
+     * @readonly
+     */
+    currencyCode?: string | null;
+    /**
+     * Platform fee amount in the currency's main units.
+     * For example, `1.50` for a $1.50 platform fee.
+     * Used in scenarios where the platform charges a fee for processing the transaction.
+     * @decimalValue options { gt:0, maxScale:8 }
+     * @readonly
+     */
+    applicationFee?: string | null;
+    /**
+     * Items being purchased in this charge.
+     * Each line item represents a product or service with quantity, pricing, and tax information.
+     * @maxSize 100
+     * @readonly
+     */
+    orderLineItems?: OrderLineItem[];
+    /**
+     * Detailed breakdown of amounts that contribute to the total charge amount.
+     * Includes shipping costs, taxes, and discounts applied to the order.
+     * @readonly
+     */
+    amountBreakdown?: AmountBreakdown;
+    /**
+     * Text that appears on the customer's payment statement for this charge.
+     * Helps customers identify the transaction.
+     * @maxLength 20
+     * @readonly
+     */
+    statementDescriptor?: string | null;
+    /**
+     * Customer's billing address and contact information.
+     * Used for payment processing, fraud prevention, and compliance requirements.
+     * @readonly
+     */
+    billingInfo?: ContactInfo;
+    /**
+     * Customer's shipping address and contact information.
+     * Used for order fulfillment and risk assessment.
+     * @readonly
+     */
+    shippingInfo?: ContactInfo;
+    /**
+     * Enriched payment method information from the payment provider.
+     * Includes processed details like card brand, last 4 digits, account information and other information that may vary based on payment method used.
+     * @readonly
+     */
+    paymentMethod?: PaymentMethod;
+    /**
+     * Configuration for the payment processing flow.
+     * @readonly
+     */
+    flowDetails?: FlowDetails;
+    /**
+     * Information about the customer making the payment.
+     * Links to contact records, site membership, and user accounts for personalization and compliance.
+     * @readonly
+     */
+    buyer?: Buyer;
+    /**
+     * ID of the payment provider that processed this charge.
+     * @minLength 1
+     * @maxLength 100
+     * @readonly
+     */
+    providerId?: string | null;
+    /**
+     * Charge ID as it appears in the payment provider's system.
+     * @minLength 1
+     * @maxLength 100
+     * @readonly
+     */
+    providerChargeId?: string | null;
+    /**
+     * Order identifier from the external system that initiated this charge.
+     * Passed through to the payment provider for reporting and allowing correlation between payment and order.
+     * @minLength 1
+     * @maxLength 1000
+     * @readonly
+     */
+    externalOrderId?: string | null;
+}
+/** Shipping amount breakdown details. */
+interface Shipping {
+    /**
+     * Shipping cost amount.
+     * @decimalValue options { gt:0, maxScale:8 }
+     */
+    amount?: string | null;
+    /**
+     * Shipping discount amount.
+     * @decimalValue options { gt:0, maxScale:8 }
+     */
+    discount?: string | null;
+}
+/** Full contact details for an address */
+interface FullAddressContactDetails {
+    /** Contact's first name. */
+    firstName?: string | null;
+    /** Contact's last name. */
+    lastName?: string | null;
+    /**
+     * Contact's full name.
+     * @internal
+     */
+    fullName?: string | null;
+    /**
+     * Contact's phone number.
+     * @format PHONE
+     */
+    phone?: string | null;
+    /** Contact's company name. */
+    company?: string | null;
+    /**
+     * Email associated with the address.
+     * @format EMAIL
+     */
+    email?: string | null;
+    /** Tax info. Currently usable only in Brazil. */
+    vatId?: VatId;
+}
+interface VatId {
+    /** Customer's tax ID. */
+    _id?: string;
+    /**
+     * Tax type.
+     *
+     * Supported values:
+     * + `CPF`: for individual tax payers
+     * + `CNPJ`: for corporations
+     */
+    type?: VatTypeWithLiterals;
+}
+/** tax info types */
+declare enum VatType {
+    UNSPECIFIED = "UNSPECIFIED",
+    /** CPF - for individual tax payers. */
+    CPF = "CPF",
+    /** CNPJ - for corporations */
+    CNPJ = "CNPJ"
+}
+/** @enumType */
+type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
+/** Physical address */
+interface Address extends AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine1?: string | null;
+    /**
+     * Country code.
+     * @format COUNTRY
+     */
+    country?: string | null;
+    /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Zip/postal code. */
+    postalCode?: string | null;
+    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
+    addressLine2?: string | null;
+    /**
+     * A string containing the full address of this location.
+     * @internal
+     */
+    formatted?: string | null;
+    /**
+     * Free text to help find the address.
+     * @internal
+     */
+    hint?: string | null;
+    /**
+     * Coordinates of the physical address.
+     * @internal
+     */
+    location?: AddressLocation;
+    /**
+     * Country full name.
+     * @internal
+     */
+    countryFullname?: string | null;
+    /**
+     * Subdivision full name.
+     * @internal
+     */
+    subdivisionFullname?: string | null;
+}
+/** @oneof */
+interface AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+    /**
+     * Apartment number.
+     * @internal
+     */
+    apt?: string;
+    /**
+     * Optional address line 1
+     * @internal
+     */
+    formattedAddressLine?: string | null;
+}
+interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+/** Information about a card payment method. */
+interface Card {
+    /**
+     * Last 4 digits of the card number.
+     * @minLength 4
+     * @maxLength 4
+     */
+    lastFourDigits?: string | null;
+    /**
+     * Bank Identification Number - the first 4-8 digits of the card number.
+     * @minLength 4
+     * @maxLength 8
+     */
+    bin?: string | null;
+    /**
+     * Month when the card expires (1-12).
+     * @min 1
+     * @max 12
+     */
+    expirationMonth?: number | null;
+    /**
+     * Full year when the card expires.
+     * @min 2000
+     * @max 2099
+     */
+    expirationYear?: number | null;
+    /**
+     * Full name of the cardholder as printed on the card.
+     * @minLength 1
+     * @maxLength 1000
+     */
+    cardholderName?: string | null;
+}
+/** Account information for digital wallet or bank account payments. */
+interface Account {
+    /**
+     * Email address associated with the payment account.
+     * @format EMAIL
+     */
+    email?: string | null;
+    /**
+     * Name of the bank that issued the payment method.
+     * @maxLength 1024
+     */
+    issuingBank?: string | null;
+}
+/** Provider-specific status reason information. */
+interface ProviderStatusReason {
+    /**
+     * Type of reason code from the provider.
+     * For example, `issuer_decline_code`, `card_error`, or `request_error`.
+     * @minLength 1
+     * @maxLength 100
+     */
+    type?: string | null;
+    /**
+     * Provider-specific reason code.
+     * @minLength 1
+     * @maxLength 100
+     */
+    code?: string | null;
+    /**
+     * Human-readable description of the provider reason.
+     * @minLength 1
+     * @maxLength 1000
+     */
+    description?: string | null;
+}
+/** Status of a charge in its processing lifecycle. */
+declare enum Status {
+    /** Charge has been created and is waiting for processing to begin. */
+    INITIATED = "INITIATED",
+    /**
+     * Charge requires additional action from the buyer to proceed.
+     * Check the [Charges API](https://dev.wix.com/docs/api-reference/business-management/payments/charges/introduction) for specific instructions.
+     */
+    ACTION_REQUIRED = "ACTION_REQUIRED",
+    /** Payment processing is in progress, awaiting confirmation from the provider, issuer, or merchant. */
+    PENDING = "PENDING",
+    /**
+     * Funds have been authorized but not yet captured.
+     * Use the [Charges API](https://dev.wix.com/docs/api-reference/business-management/payments/charges/introduction) to capture or void the charge.
+     */
+    AUTHORIZED = "AUTHORIZED",
+    /**
+     * Funds have been successfully captured from the buyer's payment method.
+     * This is the final successful state for most charges.
+     */
+    CAPTURED = "CAPTURED",
+    /**
+     * Authorization was canceled before funds were captured.
+     * No money was transferred and the authorization hold is released.
+     */
+    VOIDED = "VOIDED",
+    /**
+     * Charge failed due to payment processing issues.
+     * Check `statusDetails` for details about the failure reason.
+     */
+    FAILED = "FAILED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'INITIATED' | 'ACTION_REQUIRED' | 'PENDING' | 'AUTHORIZED' | 'CAPTURED' | 'VOIDED' | 'FAILED';
+/** Detailed information about the charge status. */
+interface StatusDetails {
+    /**
+     * Standardized 4-character reason code indicating why the charge is in its current status.
+     * See [reason codes](https://dev.wix.com/docs/api-reference/business-management/payments/payment-service-provider-service-plugin/reason-codes) for more information.
+     * @minLength 4
+     * @maxLength 4
+     */
+    code?: string | null;
+    /**
+     * Human-readable description of the status code.
+     * @minLength 1
+     * @maxLength 1000
+     */
+    description?: string | null;
+    /**
+     * Status of the charge as reported by the payment provider.
+     * @minLength 1
+     * @maxLength 100
+     */
+    providerStatus?: string | null;
+    /**
+     * Detailed status information from the payment provider.
+     * Contains provider-specific reason codes and descriptions.
+     * @maxSize 10
+     */
+    providerStatusReasons?: ProviderStatusReason[];
+}
+/** An individual item in the order being charged. */
+interface OrderLineItem {
+    /**
+     * Stock Keeping Unit identifier for the item.
+     * @minLength 1
+     * @maxLength 255
+     */
+    sku?: string | null;
+    /**
+     * Display name of the item.
+     * @minLength 1
+     * @maxLength 200
+     */
+    name?: string | null;
+    /**
+     * Number of units of this item being purchased.
+     * @min 1
+     */
+    quantity?: number | null;
+    /**
+     * Price per unit before taxes and discounts are applied.
+     * @decimalValue options { gte:0, maxScale:8 }
+     */
+    unitPrice?: string | null;
+    /**
+     * Detailed description of the item.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    description?: string | null;
+    /** Whether the item is a physical product that requires shipping. */
+    tangible?: boolean | null;
+    /**
+     * Total discount amount applied to this line item for the specified quantity.
+     * @decimalValue options { gt:0, maxScale:8 }
+     */
+    discount?: string | null;
+    /**
+     * Total tax amount for this line item for the specified quantity.
+     * @decimalValue options { gt:0, maxScale:8 }
+     */
+    tax?: string | null;
+}
+/** Breakdown of additional amounts that contribute to the total order amount. */
+interface AmountBreakdown {
+    /**
+     * Total amount of all items before taxes and discounts.
+     * Equals the sum of unitPrice * quantity amounts from all order line items.
+     * @decimalValue options { gte:0, maxScale:8 }
+     */
+    itemsTotal?: string | null;
+    /**
+     * Total tax amount for the entire order.
+     * Equals the sum of tax amounts from all order line items when individual item taxes are specified.
+     * @decimalValue options { gte:0, maxScale:8 }
+     */
+    taxTotal?: string | null;
+    /**
+     * Total discount amount for the entire order.
+     * Equals the sum of all item discounts when individual item discounts are specified.
+     * @decimalValue options { gte:0, maxScale:8 }
+     */
+    discountTotal?: string | null;
+    /** Shipping breakdown details. */
+    shipping?: Shipping;
+}
+/** Contact and address information for billing or shipping. */
+interface ContactInfo {
+    /** Contact details including name, email, and phone number. */
+    contactDetails?: FullAddressContactDetails;
+    /** Physical address information. */
+    address?: Address;
+}
+/** Processed payment method information from the payment provider. */
+interface PaymentMethod {
+    /**
+     * ID of the payment method type.
+     * @format GUID
+     */
+    paymentMethodTypeId?: string | null;
+    /**
+     * ID of the specific payment method brand used (e.g., Visa, Mastercard in case of card payment or Venmo for PayPal payments).
+     * @format GUID
+     */
+    paymentBrandId?: string | null;
+    /** Information about the card used for payment. */
+    card?: Card;
+    /** Information about the account used for payment. */
+    account?: Account;
+}
+/** Configuration and details about the payment processing flow. */
+interface FlowDetails {
+    /** Whether this is a Mail Order/Telephone Order (MOTO) transaction. */
+    moto?: boolean | null;
+    /**
+     * Number of installments for this payment.
+     * @min 1
+     */
+    installmentCount?: number | null;
+}
+/** Information about the customer making the payment. */
+interface Buyer {
+    /**
+     * ID of the buyer's contact record in the contacts system.
+     * @format GUID
+     */
+    contactId?: string | null;
+    /**
+     * ID of the buyer's site membership if they are a registered member.
+     * @format GUID
+     */
+    memberId?: string | null;
+    /**
+     * Buyer's preferred language in IETF BCP 47 format.
+     * For example, `en-US` for U.S. English.
+     * @format LANGUAGE_TAG
+     */
+    languageCode?: string | null;
+}
+/** The refund object. A refund object is the record of an attempt to return charged funds. */
+interface Refund {
+    /**
+     * Refund ID.
+     * @readonly
+     * @immutable
+     * @format GUID
+     */
+    _id?: string | null;
+    /**
+     * Date and time the refund was created.
+     * @readonly
+     * @immutable
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the refund was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Amount being returned to the buyer in the refund currency's main units (such as dollars or euros).
+     * For example, `"12.95"`.
+     * @immutable
+     * @decimalValue options { gt:0, maxScale:8 }
+     */
+    amount?: string | null;
+    /**
+     * Whether the refund is for the entire amount of the charge.
+     * @readonly
+     * @immutable
+     */
+    full?: boolean | null;
+    /**
+     * Status of the refund.
+     *
+     * Learn more about the [refund lifecycle](https://dev.wix.com/docs/api-reference/business-management/payments/refunds/refund-lifecycle).
+     * @readonly
+     */
+    status?: RefundStatusWithLiterals;
+    /**
+     * Payment service provider's ID for the refund.
+     * @readonly
+     * @immutable
+     * @minLength 1
+     * @maxLength 100
+     */
+    providerRefundId?: string | null;
+    /**
+     * Reason this refund was issued.
+     * @minLength 1
+     * @maxLength 1000
+     */
+    reason?: string | null;
+    /**
+     * Details about the refund status.
+     * Used to provide additional information about why a refund was given its status.
+     * @readonly
+     */
+    statusInfo?: StatusInfo;
+    /**
+     * Unique number assigned to a refund. This number is shared across all parties involved in processing the refund. It allows the merchant to track the refund with their bank.
+     * @readonly
+     * @immutable
+     * @minLength 1
+     * @maxLength 30
+     */
+    acquirerReferenceNumber?: string | null;
+    /**
+     * Note providing additional information about this refund.
+     * @immutable
+     * @minLength 1
+     * @maxLength 200
+     */
+    note?: string | null;
+}
+declare enum RefundStatus {
+    /** Refund is in progress. */
+    PENDING = "PENDING",
+    /** Refund succeeded. */
+    SUCCEEDED = "SUCCEEDED",
+    /** Refund failed. */
+    FAILED = "FAILED",
+    /** Refund had succeeded, but has since been reversed. */
+    REVERSED = "REVERSED"
+}
+/** @enumType */
+type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'REVERSED';
+interface StatusInfo {
+    /**
+     * Reason code with detailed information about the refund status.
+     * See the full list of [reason codes](https://dev.wix.com/docs/api-reference/business-management/payments/payment-service-provider-service-plugin/reason-codes#refund-declined).
+     * @minLength 1
+     * @maxLength 10
+     */
+    code?: string;
+    /**
+     * Description of the status.
+     * @minLength 1
+     * @maxLength 1000
+     */
+    description?: string | null;
+}
+/** A dispute is a customer-initiated challenge of a payment through their payment service provider (PSP) or bank. */
+interface Dispute {
+    /**
+     * Dispute ID.
+     * @format GUID
+     * @immutable
+     */
+    _id?: string;
+    /**
+     * Stage of the dispute process.
+     * @readonly
+     */
+    stage?: DisputeStageWithLiterals;
+    /**
+     * Reason why the customer initiated the dispute.
+     * @readonly
+     */
+    reason?: DisputeReasonWithLiterals;
+    /**
+     * Disputed amount in the currency's main units. For example, `"12.95"` for $12.95.
+     * @immutable
+     * @decimalValue options { gt:0, maxScale:8 }
+     */
+    amount?: string | null;
+    /**
+     * Current status of the dispute. This indicates what action is required and who needs to take it.
+     * @readonly
+     */
+    status?: DisputeStatusWithLiterals;
+    /**
+     * Level of seller protection coverage for this dispute.
+     *
+     * Seller protection is set by the payment provider. For example, PayPal offers a [seller protection program](https://www.paypal.com/ua/legalhub/paypal/seller-protection).
+     * @readonly
+     */
+    sellerProtection?: SellerProtectionWithLiterals;
+    /**
+     * Channel through which the dispute is being processed.
+     * @readonly
+     */
+    channel?: DisputeChannelWithLiterals;
+    /**
+     * The latest date and time until which the dispute can remain in its current status.
+     *
+     * If this date passes, the dispute will be resolved against the party that is required to take action. For example, if the status is `WAITING_MERCHANT`, and the due date passes, the dispute will be `LOST` and a refund will be processed automatically.
+     * @readonly
+     */
+    dueDate?: Date | null;
+    /**
+     * Unique identifier assigned by the payment service provider for this dispute.
+     * @immutable
+     * @minLength 1
+     * @maxLength 64
+     */
+    providerDisputeId?: string;
+    /**
+     * Network reason code provided by the card network or issuing bank that initiated the dispute.
+     * @minLength 1
+     * @maxLength 64
+     */
+    networkReasonCode?: string | null;
+    /**
+     * Whether the dispute can be defended with evidence.
+     * @readonly
+     */
+    defendable?: boolean | null;
+    /**
+     * Whether the dispute was automatically defended by the payment processor.
+     * @readonly
+     */
+    autoDefended?: boolean | null;
+    /**
+     * Date and time at which the dispute was defended.
+     * @readonly
+     */
+    defendedDate?: Date | null;
+    /**
+     * Date and time at which the dispute was accepted.
+     * @readonly
+     */
+    acceptedDate?: Date | null;
+    /**
+     * List of actions that can be performed on the dispute.
+     * Each action has a specific due date by which it must be completed.
+     * Available actions depend on the dispute's current status and stage.
+     * @readonly
+     * @maxSize 20
+     */
+    actions?: DisputeAction[];
+    /**
+     * Date and time the dispute was created.
+     * @readonly
+     * @immutable
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the dispute was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+}
+declare enum DisputeStage {
+    /** Formal dispute filed through the card network or issuing bank. */
+    CHARGEBACK = "CHARGEBACK",
+    /** Initial inquiry from the customer requesting information about the charge. */
+    INQUIRY = "INQUIRY"
+}
+/** @enumType */
+type DisputeStageWithLiterals = DisputeStage | 'CHARGEBACK' | 'INQUIRY';
+declare enum DisputeReason {
+    /** Fraudulent use of a physical card. */
+    FRAUD_CARD_PRESENT = "FRAUD_CARD_PRESENT",
+    /** Fraudulent use without the physical card present. */
+    FRAUD_CARD_ABSENT = "FRAUD_CARD_ABSENT",
+    /** Duplicate charge processing. */
+    DUPLICATE_PROCESSING = "DUPLICATE_PROCESSING",
+    /** Services or goods were not provided as promised. */
+    SERVICES_NOT_PROVIDED = "SERVICES_NOT_PROVIDED",
+    /** Recurring payment that should have been canceled. */
+    CANCELED_RECURRING = "CANCELED_RECURRING",
+    /** Item received was not as described. */
+    NOT_AS_DESCRIBED = "NOT_AS_DESCRIBED",
+    /** Item received was counterfeit. */
+    COUNTERFEIT = "COUNTERFEIT",
+    /** Merchant misrepresented the transaction. */
+    MISREPRESENTATION = "MISREPRESENTATION",
+    /** Transaction was canceled but still charged. */
+    CANCELED = "CANCELED",
+    /** Other dispute reason not covered by specific categories. */
+    OTHER = "OTHER"
+}
+/** @enumType */
+type DisputeReasonWithLiterals = DisputeReason | 'FRAUD_CARD_PRESENT' | 'FRAUD_CARD_ABSENT' | 'DUPLICATE_PROCESSING' | 'SERVICES_NOT_PROVIDED' | 'CANCELED_RECURRING' | 'NOT_AS_DESCRIBED' | 'COUNTERFEIT' | 'MISREPRESENTATION' | 'CANCELED' | 'OTHER';
+declare enum DisputeStatus {
+    /** Merchant action required to proceed with the dispute. */
+    WAITING_MERCHANT = "WAITING_MERCHANT",
+    /** Dispute is being reviewed by the payment service provider or bank. */
+    UNDER_REVIEW = "UNDER_REVIEW",
+    /** Customer action required to proceed with the dispute. */
+    WAITING_BUYER = "WAITING_BUYER",
+    /** Dispute resolved in favor of the merchant. */
+    WON = "WON",
+    /** Dispute resolved in favor of the customer. When a dispute is lost, the refund is processed automatically. */
+    LOST = "LOST"
+}
+/** @enumType */
+type DisputeStatusWithLiterals = DisputeStatus | 'WAITING_MERCHANT' | 'UNDER_REVIEW' | 'WAITING_BUYER' | 'WON' | 'LOST';
+declare enum SellerProtection {
+    /** Transaction is not eligible for seller protection. */
+    NOT_ELIGIBLE = "NOT_ELIGIBLE",
+    /** Transaction is eligible for basic seller protection. */
+    ELIGIBLE = "ELIGIBLE",
+    /** Transaction is eligible for extended seller protection coverage. */
+    EXTENDED = "EXTENDED"
+}
+/** @enumType */
+type SellerProtectionWithLiterals = SellerProtection | 'NOT_ELIGIBLE' | 'ELIGIBLE' | 'EXTENDED';
+declare enum DisputeChannel {
+    /** Dispute is processed by the payment service provider. */
+    INTERNAL = "INTERNAL",
+    /** Dispute is processed through the card network or issuing bank. */
+    EXTERNAL = "EXTERNAL"
+}
+/** @enumType */
+type DisputeChannelWithLiterals = DisputeChannel | 'INTERNAL' | 'EXTERNAL';
+interface DisputeAction {
+    /** Type of action that can be performed. */
+    type?: DisputeActionTypeWithLiterals;
+    /** Latest date and time by which this action must be performed. */
+    dueDate?: Date | null;
+}
+declare enum DisputeActionType {
+    /** Dispute can be accepted. */
+    ACCEPT = "ACCEPT",
+    /** Dispute can be defended. */
+    DEFEND = "DEFEND"
+}
+/** @enumType */
+type DisputeActionTypeWithLiterals = DisputeActionType | 'ACCEPT' | 'DEFEND';
+/**
+ * A notification of fraud is a pre-dispute fraud alert raised against a charge.
+ * Card networks issue these alerts to flag a transaction that a cardholder has
+ * reported as fraudulent.
+ *
+ * A notification of fraud is informational and doesn't move funds. It may
+ * precede a chargeback, but doesn't have to. A charge has at most one
+ * notification of fraud, and notifications of fraud are immutable once created.
+ */
+interface NotificationOfFraud {
+    /**
+     * Standardized fraud reason, mapped from the raw reason reported by the upstream payment provider.
+     * @immutable
+     */
+    reason?: ReasonWithLiterals;
+    /**
+     * Date and time the notification of fraud was created.
+     * @readonly
+     * @immutable
+     */
+    _createdDate?: Date | null;
+}
+/** Standardized fraud reason. */
+declare enum Reason {
+    /** Cardholder reported that a newly issued card was intercepted before it reached them. */
+    CARD_NEVER_RECEIVED = "CARD_NEVER_RECEIVED",
+    /** Card was issued based on a fraudulent application. */
+    FRAUDULENT_CARD_APPLICATION = "FRAUDULENT_CARD_APPLICATION",
+    /** Transaction was made with a counterfeit card. */
+    MADE_WITH_COUNTERFEIT_CARD = "MADE_WITH_COUNTERFEIT_CARD",
+    /** Transaction was made with a card the cardholder had reported as lost. */
+    MADE_WITH_LOST_CARD = "MADE_WITH_LOST_CARD",
+    /** Transaction was made with a card the cardholder had reported as stolen. */
+    MADE_WITH_STOLEN_CARD = "MADE_WITH_STOLEN_CARD",
+    /** Catch-all for fraud reasons that don't fit any other category, or that the upstream payment provider reported in a non-standard form. */
+    MISCELLANEOUS = "MISCELLANEOUS",
+    /** Cardholder reported that the transaction was made without their authorization. */
+    UNAUTHORIZED_USE_OF_CARD = "UNAUTHORIZED_USE_OF_CARD",
+    /** Generic fraud signal that doesn't classify the reason further. Typically used by non-card payment methods. */
+    FRAUD = "FRAUD",
+    /** Cardholder's account was taken over by a third party who then made the transaction. */
+    ACCOUNT_TAKEOVER_FRAUD = "ACCOUNT_TAKEOVER_FRAUD",
+    /** Card-not-present fraud, typically an online transaction made without the physical card. */
+    CARD_NOT_PRESENT_FRAUD = "CARD_NOT_PRESENT_FRAUD",
+    /** The same card information was used for multiple unauthorized imprints. */
+    MULTIPLE_IMPRINT_FRAUD = "MULTIPLE_IMPRINT_FRAUD",
+    /** Card was used at a merchant suspected of colluding in a bust-out scheme. */
+    BUST_OUT_COLLUSIVE_MERCHANT = "BUST_OUT_COLLUSIVE_MERCHANT",
+    /** The card account number was used fraudulently without the physical card. */
+    FRAUDULENT_USE_OF_ACCOUNT_NUMBER = "FRAUDULENT_USE_OF_ACCOUNT_NUMBER",
+    /** Card network flagged the transaction as incorrectly processed in a way that resembles fraud. */
+    INCORRECT_PROCESSING = "INCORRECT_PROCESSING",
+    /** Merchant misrepresented goods or services to the cardholder. */
+    MERCHANT_MISREPRESENTATION = "MERCHANT_MISREPRESENTATION",
+    /** Acquiring bank reported that the card used in the transaction is counterfeit. */
+    ACQUIRER_REPORTED_COUNTERFEIT = "ACQUIRER_REPORTED_COUNTERFEIT"
+}
+/** @enumType */
+type ReasonWithLiterals = Reason | 'CARD_NEVER_RECEIVED' | 'FRAUDULENT_CARD_APPLICATION' | 'MADE_WITH_COUNTERFEIT_CARD' | 'MADE_WITH_LOST_CARD' | 'MADE_WITH_STOLEN_CARD' | 'MISCELLANEOUS' | 'UNAUTHORIZED_USE_OF_CARD' | 'FRAUD' | 'ACCOUNT_TAKEOVER_FRAUD' | 'CARD_NOT_PRESENT_FRAUD' | 'MULTIPLE_IMPRINT_FRAUD' | 'BUST_OUT_COLLUSIVE_MERCHANT' | 'FRAUDULENT_USE_OF_ACCOUNT_NUMBER' | 'INCORRECT_PROCESSING' | 'MERCHANT_MISREPRESENTATION' | 'ACQUIRER_REPORTED_COUNTERFEIT';
+/** Request to synchronize a payment. */
+interface SyncPaymentRequest {
+    /**
+     * Payment ID. This is the source charge ID.
+     * @format GUID
+     */
+    paymentId?: string;
+}
+/** Response returned after a payment sync request. */
+interface SyncPaymentResponse {
+    /** The synchronized payment. */
+    payment?: Payment;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+/** Request to retrieve a payment. */
+interface GetPaymentRequest {
+    /**
+     * Payment ID. This is the source charge ID.
+     * @format GUID
+     */
+    paymentId: string;
+}
+/** Response containing the requested payment. */
+interface GetPaymentResponse {
+    /** Retrieved payment. */
+    payment?: Payment;
+}
+/** Request to search payments. */
+interface SearchPaymentsRequest {
+    /**
+     * Search options.
+     *
+     * For supported full-text, filter, and sort fields, see @Supported Filters and Search Fields.
+     */
+    search?: CursorSearch;
+}
+interface CursorSearch extends CursorSearchPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Use the cursor from `pagingMetadata.cursors` in the previous
+     * response to retrieve another page.
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * For supported payment filters, see @Supported Filters and Search Fields.
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort fields.
+     *
+     * For supported payment sort fields, see @Supported Filters and Search Fields.
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 10
+     */
+    sort?: Sorting[];
+    /** Free text to match against searchable payment fields. */
+    search?: SearchDetails;
+    /**
+     * UTC offset or IANA time zone. Valid values are
+     * ISO 8601 UTC offsets, such as +02:00 or -06:00,
+     * and IANA time zone IDs, such as Europe/Rome.
+     *
+     * Affects all date filters. You can override this behavior for a specific
+     * filter by specifying a timestamp that includes a time zone, such as
+     * `"2023-12-20T10:52:34.795Z"`.
+     * @maxLength 50
+     */
+    timeZone?: string | null;
+}
+/** @oneof */
+interface CursorSearchPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Use the cursor from `pagingMetadata.cursors` in the previous
+     * response to retrieve another page.
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface SearchDetails {
+    /** Defines how separate search terms in `expression` are combined. */
+    mode?: ModeWithLiterals;
+    /**
+     * Search term or expression.
+     * @maxLength 100
+     */
+    expression?: string | null;
+    /**
+     * Fields to search. If omitted, all searchable fields are searched. Use dot
+     * notation to specify a JSON path.
+     *
+     * For supported payment search fields, see @Supported Filters and Search Fields.
+     * @maxLength 200
+     * @maxSize 20
+     */
+    fields?: string[];
+    /** Whether to use automatic fuzzy search that allows typos. */
+    fuzzy?: boolean;
+}
+declare enum Mode {
+    /** Any of the search terms must be present. */
+    OR = "OR",
+    /** All search terms must be present. */
+    AND = "AND"
+}
+/** @enumType */
+type ModeWithLiterals = Mode | 'OR' | 'AND';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results. Defaults to 50 if not provided.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+/**
+ * Response containing a page of payments that match the search and the
+ * pagination metadata for the current page.
+ */
+interface SearchPaymentsResponse {
+    /** Payments matching the search. */
+    payments?: Payment[];
+    /** Cursor paging metadata for the current page. */
+    pagingMetadata?: CursorPagingMetadata;
+    /**
+     * Aggregation results.
+     * @internal
+     */
+    aggregationData?: AggregationData;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface AggregationData {
+    /**
+     * key = aggregation name (as derived from search request).
+     * @maxSize 10000
+     */
+    results?: AggregationResults[];
+}
+interface ValueAggregationResult {
+    /**
+     * Value of the field.
+     * @maxLength 100
+     */
+    value?: string;
+    /** Count of entities with this value. */
+    count?: number;
+}
+interface RangeAggregationResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Count of entities in this range. */
+    count?: number;
+}
+declare enum ScalarType {
+    /** Count of distinct values. */
+    COUNT_DISTINCT = "COUNT_DISTINCT",
+    /** Minimum value. */
+    MIN = "MIN",
+    /** Maximum value. */
+    MAX = "MAX",
+    /**
+     * Sum of values.
+     * @internal
+     */
+    SUM = "SUM",
+    /**
+     * Average of values.
+     * @internal
+     */
+    AVG = "AVG"
+}
+/** @enumType */
+type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
+interface ValueResult {
+    /**
+     * Value of the field.
+     * @maxLength 1000
+     */
+    value?: string;
+    /** Count of entities with this value. */
+    count?: number | null;
+}
+interface RangeResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Count of entities in this range. */
+    count?: number | null;
+}
+interface ScalarResult {
+    /** Value of the scalar aggregation. */
+    value?: number;
+}
+interface NestedResultValue extends NestedResultValueResultOneOf {
+    /** Value aggregation result. */
+    value?: ValueResult;
+    /** Range aggregation result. */
+    range?: RangeResult;
+    /** Scalar aggregation result. */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation result. */
+    dateHistogram?: ValueResult;
+}
+/** @oneof */
+interface NestedResultValueResultOneOf {
+    /** Value aggregation result. */
+    value?: ValueResult;
+    /** Range aggregation result. */
+    range?: RangeResult;
+    /** Scalar aggregation result. */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation result. */
+    dateHistogram?: ValueResult;
+}
+interface Results {
+    /** List of nested aggregations. */
+    results?: Record<string, NestedResultValue>;
+}
+interface DateHistogramResult {
+    /**
+     * Date in ISO 8601 format.
+     * @maxLength 100
+     */
+    value?: string;
+    /** Count of documents in the bucket. */
+    count?: number;
+}
+declare enum AggregationType {
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
+    VALUE = "VALUE",
+    /** An aggregation, where user can define set of ranges - each representing a bucket. */
+    RANGE = "RANGE",
+    /** A single-value metric aggregation. For example, min, max, sum, avg. */
+    SCALAR = "SCALAR",
+    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM",
+    /** Multi-level aggregation, where each next aggregation is nested within previous one. */
+    NESTED = "NESTED"
+}
+/** @enumType */
+type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
+interface ValueResults {
+    /**
+     * List of value aggregations.
+     * @maxSize 250
+     */
+    results?: ValueAggregationResult[];
+}
+interface RangeResults {
+    /**
+     * List of ranges returned in same order as requested.
+     * @maxSize 50
+     */
+    results?: RangeAggregationResult[];
+}
+interface AggregationResultsScalarResult {
+    /** Type of scalar aggregation. */
+    type?: ScalarTypeWithLiterals;
+    /** Value of the scalar aggregation. */
+    value?: number;
+}
+interface DateHistogramResults {
+    /**
+     * List of date histogram aggregations.
+     * @maxSize 200
+     */
+    results?: DateHistogramResult[];
+}
+/**
+ * Results of `NESTED` aggregation type in a flattened form.
+ * Aggregations in resulting array are keyed by requested aggregation `name`.
+ */
+interface NestedResults {
+    /**
+     * List of nested aggregations.
+     * @maxSize 1000
+     */
+    results?: Results[];
+}
+interface AggregationResults extends AggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** Date histogram aggregation results. */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results. */
+    nested?: NestedResults;
+    /**
+     * User-defined name of aggregation as derived from search request.
+     * @maxLength 100
+     */
+    name?: string;
+    /** Type of aggregation that must match provided kind as derived from search request. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by as derived from search request.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface AggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** Date histogram aggregation results. */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results. */
+    nested?: NestedResults;
+}
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+    accountInfo?: AccountInfoMetadata;
+}
+interface AccountInfoMetadata {
+    /** ID of the Wix account associated with the event */
+    accountId: string;
+    /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
+    siteId?: string;
+    /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
+    parentAccountId?: string;
+}
+interface PaymentCreatedEnvelope {
+    entity: Payment;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a payment is created.
+ * @permissionId payments:platform:v1:payment:read_events
+ * @webhook
+ * @eventType wix.payments.platform.v1.payment_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onPaymentCreated(handler: (event: PaymentCreatedEnvelope) => void | Promise<void>): void;
+interface PaymentUpdatedEnvelope {
+    entity: Payment;
+    metadata: EventMetadata;
+    /** @hidden */
+    modifiedFields: Record<string, any>;
+}
+/**
+ * Triggered when a payment is updated.
+ * @permissionId payments:platform:v1:payment:read_events
+ * @webhook
+ * @eventType wix.payments.platform.v1.payment_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onPaymentUpdated(handler: (event: PaymentUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Retrieves a payment by ID.
+ *
+ * The payment ID is identical to the source charge ID, so the same value can
+ * be used to look up the underlying charge.
+ * @param paymentId - Payment ID. This is the source charge ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField paymentId
+ * @permissionId payments:platform:v1:payment:get_payment
+ * @returns Retrieved payment.
+ * @fqn wix.payments.platform.v1.Payments.GetPayment
+ */
+declare function getPayment(paymentId: string): Promise<NonNullablePaths<Payment, `charge.status` | `charge.statusDetails.providerStatusReasons` | `charge.orderLineItems` | `charge.billingInfo.contactDetails.vatId._id` | `charge.billingInfo.contactDetails.vatId.type` | `charge.billingInfo.address.streetAddress.number` | `charge.billingInfo.address.streetAddress.name` | `refunds` | `refunds.${number}.status` | `refunds.${number}.statusInfo.code` | `disputes` | `disputes.${number}._id` | `disputes.${number}.stage` | `disputes.${number}.reason` | `disputes.${number}.status` | `disputes.${number}.sellerProtection` | `disputes.${number}.channel` | `disputes.${number}.providerDisputeId` | `notificationOfFraud.reason`, 6>>;
+interface PaymentSearchSpec extends SearchSpec {
+    searchable: [
+        'charge.billingInfo.contactDetails.email',
+        'charge.billingInfo.contactDetails.firstName',
+        'charge.billingInfo.contactDetails.lastName',
+        'charge.orderLineItems.name',
+        'charge.shippingInfo.contactDetails.email'
+    ];
+    paging: 'cursor';
+    wql: [
+        {
+            operators: '*';
+            fields: ['_createdDate', '_id', 'refundable'];
+            sort: 'BOTH';
+        },
+        {
+            operators: '*';
+            fields: ['appId'];
+            sort: 'NONE';
+        },
+        {
+            operators: '*';
+            fields: [
+                'charge.amount',
+                'charge.currencyCode',
+                'charge.paymentMethod.paymentBrandId',
+                'charge.paymentMethod.paymentMethodTypeId',
+                'charge.providerId',
+                'charge.status'
+            ];
+            sort: 'BOTH';
+        },
+        {
+            operators: ['$matchItems'];
+            fields: ['refunds'];
+            sort: 'NONE';
+        },
+        {
+            operators: ['$matchItems'];
+            fields: ['disputes'];
+            sort: 'NONE';
+        },
+        {
+            operators: '*';
+            fields: [
+                'notificationOfFraud._createdDate',
+                'notificationOfFraud.reason'
+            ];
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonSearchWithEntityContext = Search<Payment, PaymentSearchSpec>;
+type PaymentSearch = {
+    /**
+    Cursor paging options.
+  
+    Use the cursor from `pagingMetadata.cursors` in the previous
+    response to retrieve another page.
+    Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results. Defaults to 50 if not provided.
+      @max: 100
+      */
+        limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    For supported payment filters, see
+    @Supported: Filters and Search Fields.
+    Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+    */
+    filter?: CommonSearchWithEntityContext['filter'] | null;
+    /**
+    Sort fields.
+  
+    For supported payment sort fields, see
+    @Supported: Filters and Search Fields.
+    Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).,
+    @maxSize: 10
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
+    }[];
+    /**
+    Free text to match against searchable payment fields.
+    */
+    search?: {
+        /**
+      Defines how separate search terms in `expression` are combined.
+      */
+        mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
+        /**
+      Search term or expression.
+      @maxLength: 100
+      */
+        expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
+        /**
+      Fields to search. If omitted, all searchable fields are searched. Use dot
+      notation to specify a JSON path.
+    
+      For supported payment search fields, see
+      @Supported: Filters and Search Fields.,
+      @maxLength: 200,
+      @maxSize: 20
+      */
+        fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
+        /**
+      Whether to use automatic fuzzy search that allows typos.
+      */
+        fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
+    };
+    /**
+    UTC offset or IANA time zone. Valid values are
+    ISO 8601 UTC offsets, such as +02:00 or -06:00,
+    and IANA time zone IDs, such as Europe/Rome.
+  
+    Affects all date filters. You can override this behavior for a specific
+    filter by specifying a timestamp that includes a time zone, such as
+    `"2023-12-20T10:52:34.795Z"`.
+    @maxLength: 50
+    */
+    timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
+};
+declare const utils: {
+    search: _wix_sdk_types.SearchHelpers<Payment, PaymentSearchSpec, PaymentSearch>;
+};
+
+export { type IdentificationData as $, AggregationType as A, type Buyer as B, type Charge as C, DisputeStage as D, type Refund as E, type FullAddressContactDetails as F, type StatusInfo as G, type Dispute as H, type DisputeAction as I, type SyncPaymentRequest as J, type SyncPaymentResponse as K, type DomainEvent as L, Mode as M, type NotificationOfFraud as N, type OrderLineItem as O, type Payment as P, type DomainEventBodyOneOf as Q, RefundStatus as R, type SearchPaymentsResponse as S, type EntityCreatedEvent as T, type RestoreInfo as U, VatType as V, WebhookIdentityType as W, type EntityUpdatedEvent as X, type EntityDeletedEvent as Y, type ActionEvent as Z, type MessageEnvelope as _, type PaymentSearch as a, type IdentificationDataIdOneOf as a0, type AccountInfo as a1, type GetPaymentRequest as a2, type GetPaymentResponse as a3, type SearchPaymentsRequest as a4, type CursorSearch as a5, type CursorSearchPagingMethodOneOf as a6, type Sorting as a7, type SearchDetails as a8, type CursorPaging as a9, type RefundStatusWithLiterals as aA, type DisputeStageWithLiterals as aB, type DisputeReasonWithLiterals as aC, type DisputeStatusWithLiterals as aD, type SellerProtectionWithLiterals as aE, type DisputeChannelWithLiterals as aF, type DisputeActionTypeWithLiterals as aG, type ReasonWithLiterals as aH, type WebhookIdentityTypeWithLiterals as aI, type SortOrderWithLiterals as aJ, type ModeWithLiterals as aK, type ScalarTypeWithLiterals as aL, type AggregationTypeWithLiterals as aM, type CommonSearchWithEntityContext as aN, onPaymentCreated as aO, onPaymentUpdated as aP, getPayment as aQ, type CursorPagingMetadata as aa, type Cursors as ab, type AggregationData as ac, type ValueAggregationResult as ad, type RangeAggregationResult as ae, type ValueResult as af, type RangeResult as ag, type ScalarResult as ah, type NestedResultValue as ai, type NestedResultValueResultOneOf as aj, type Results as ak, type DateHistogramResult as al, type ValueResults as am, type RangeResults as an, type AggregationResultsScalarResult as ao, type DateHistogramResults as ap, type NestedResults as aq, type AggregationResults as ar, type AggregationResultsResultOneOf as as, type BaseEventMetadata as at, type EventMetadata as au, type AccountInfoMetadata as av, type PaymentSearchSpec as aw, utils as ax, type VatTypeWithLiterals as ay, type StatusWithLiterals as az, type PaymentCreatedEnvelope as b, type PaymentUpdatedEnvelope as c, Status as d, DisputeReason as e, DisputeStatus as f, SellerProtection as g, DisputeChannel as h, DisputeActionType as i, Reason as j, SortOrder as k, ScalarType as l, type Shipping as m, type VatId as n, type Address as o, type AddressStreetOneOf as p, type StreetAddress as q, type AddressLocation as r, type Card as s, type Account as t, type ProviderStatusReason as u, type StatusDetails as v, type AmountBreakdown as w, type ContactInfo as x, type PaymentMethod as y, type FlowDetails as z };