@wix/auto_sdk_payments_payouts 1.0.0 → 1.0.2

package/build/cjs/index.typings.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../index.typings.ts","../../src/payments-payouts-v4-payout-payouts.universal.ts","../../src/payments-payouts-v4-payout-payouts.http.ts"],"sourcesContent":["export * from './src/payments-payouts-v4-payout-payouts.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixPaymentsPayoutsV4Payout from './payments-payouts-v4-payout-payouts.http.js';\n\n/**\n * A payout is one outgoing transfer of funds from a Wix Payments merchant account\n * to the merchant's bank account. The entity carries the amount, lifecycle status,\n * estimated arrival date, and (when applicable) failure information.\n */\nexport interface Payout {\n  /**\n   * Unique identifier of the payout. Immutable.\n   * @format GUID\n   */\n  _id?: string;\n  /**\n   * ID of the Wix Payments account that owns this payout.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * ID of the Wix Payments account profile this payout belongs to.\n   * A Wix Payments account has one or more profiles; each profile has its own\n   * balance and its own payouts. Most merchants have a single profile.\n   * @format GUID\n   */\n  accountProfileId?: string;\n  /**\n   * Date the payout was created, in advance of the underlying transfer being\n   * initiated at the bank rail. Once initiated, the funds typically reach the\n   * merchant's bank account within 3-5 business days, depending on the receiving bank.\n   */\n  _createdDate?: Date | null;\n  /** Amount of funds transferred to the merchant's bank account. */\n  amount?: Money;\n  /**\n   * Lifecycle status of the payout. `SENT` means the bank rail accepted the transfer\n   * for delivery; `FAILED` means the receiving bank rejected the transfer. The rail\n   * does not provide a delivery acknowledgement, so `SENT` is not the same as\n   * \"delivered to the merchant\" — see the per-value documentation on `PayoutStatus`.\n   */\n  status?: PayoutStatusWithLiterals;\n  /**\n   * Estimated date for when the funds should arrive at the merchant's bank, returned\n   * by the underlying bank rail when available. This is a prediction, not a guarantee —\n   * actual arrival depends on the receiving bank's processing and may be later.\n   * @format LOCAL_DATE\n   */\n  estimatedArrivalDateV2?: string | null;\n  /**\n   * Set only when `status` is `FAILED`. Indicates why the bank rail rejected the transfer.\n   * The codes are a Wix Payments unified set; the original provider-specific reason is not exposed.\n   */\n  failureReason?: PayoutFailureReason;\n  /**\n   * Reference returned by the bank rail (e.g. ACH trace number, SEPA reference) once\n   * the transfer is initiated. Use it for reconciliation against the merchant's bank\n   * statement. Empty when the rail has not yet returned a reference.\n   * @maxLength 500\n   */\n  bankTransferReference?: string | null;\n  /**\n   * `true` if the payout's `amount` includes funds that originate from a Wix Capital\n   * advance the merchant has taken out. `false` if the amount is composed only of\n   * regular sales proceeds.\n   */\n  cashAdvanceIncluded?: boolean;\n}\n\n/**\n * Money.\n * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.\n */\nexport interface Money {\n  /**\n   * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.\n   * @format DECIMAL_VALUE\n   */\n  value?: string;\n  /**\n   * Currency code. Must be valid ISO 4217 currency code (e.g., USD).\n   * @format CURRENCY\n   */\n  currency?: string;\n  /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */\n  formattedValue?: string | null;\n}\n\n/** Lifecycle status of a payout. */\nexport enum PayoutStatus {\n  /** Default value. Not returned by the API. */\n  UNKNOWN = 'UNKNOWN',\n  /**\n   * The bank rail accepted the transfer. Funds are en route to the merchant's bank,\n   * but acceptance is not the same as delivery — a `SENT` payout can still flip to\n   * `FAILED` if the receiving bank rejects the transfer (the rail's return window\n   * is up to 60 days for ACH and up to 13 months for SEPA).\n   */\n  SENT = 'SENT',\n  /**\n   * The transfer was rejected by the receiving bank. See `failure_reason` for the cause;\n   * the funds remain in the merchant's Wix Payments balance.\n   */\n  FAILED = 'FAILED',\n}\n\n/** @enumType */\nexport type PayoutStatusWithLiterals =\n  | PayoutStatus\n  | 'UNKNOWN'\n  | 'SENT'\n  | 'FAILED';\n\n/**\n * Carries the reason a payout failed. Wraps the `PayoutFailureCode` enum to leave room\n * for future fields (e.g. a human-readable message); new clients should still read\n * `failure_reason.code` for the enum value.\n */\nexport interface PayoutFailureReason {\n  /** Why the bank rail rejected the transfer. */\n  code?: PayoutFailureCodeWithLiterals;\n}\n\n/**\n * Reasons a payout can fail. Values describe real-world bank-rail conditions and\n * are mapped from the underlying provider into a Wix Payments unified vocabulary.\n */\nexport enum PayoutFailureCode {\n  /**\n   * Generic failure with no more specific reason available from the bank rail.\n   * Note: this value is also returned when no failure reason is known — clients\n   * cannot distinguish \"unknown\" from \"generic\" using this code alone.\n   */\n  GENERIC_PAYOUT_FAILURE = 'GENERIC_PAYOUT_FAILURE',\n  /**\n   * The merchant's bank account is closed. The merchant must provide new bank\n   * account details before further payouts can succeed.\n   */\n  ACCOUNT_CLOSED = 'ACCOUNT_CLOSED',\n  /**\n   * The merchant's bank account is frozen (e.g. due to a hold placed by the bank).\n   * The merchant must resolve the hold with their bank before further payouts can succeed.\n   */\n  ACCOUNT_FROZEN = 'ACCOUNT_FROZEN',\n  /**\n   * The merchant's bank account is restricted from receiving the transfer\n   * (e.g. account type or status does not permit incoming credits).\n   */\n  BANK_ACCOUNT_RESTRICTED = 'BANK_ACCOUNT_RESTRICTED',\n  /**\n   * Ownership of the merchant's bank account changed and the rail no longer\n   * recognises the previously-recorded owner. New bank details are required.\n   */\n  BANK_OWNERSHIP_CHANGED = 'BANK_OWNERSHIP_CHANGED',\n  /**\n   * The receiving bank could not process the transfer for an unspecified reason.\n   * A subsequent payout attempt may succeed.\n   */\n  COULD_NOT_PROCESS = 'COULD_NOT_PROCESS',\n  /**\n   * The merchant's bank declined the debit authorisation associated with the transfer.\n   * The merchant must contact their bank to authorise Wix Payments payouts.\n   */\n  DEBIT_NOT_AUTHORIZED = 'DEBIT_NOT_AUTHORIZED',\n  /**\n   * The account holder name on file does not match what the receiving bank has on record.\n   * The merchant must correct the account holder name.\n   */\n  INCORRECT_ACCOUNT_HOLDER_NAME = 'INCORRECT_ACCOUNT_HOLDER_NAME',\n  /** The city in the bank account details is invalid for the receiving bank. */\n  INVALID_ACCOUNT_DETAILS_CITY = 'INVALID_ACCOUNT_DETAILS_CITY',\n  /** The bank account number is invalid (wrong format or does not exist). */\n  INVALID_ACCOUNT_NUMBER = 'INVALID_ACCOUNT_NUMBER',\n  /** The payout currency is not supported by the receiving bank account. */\n  INVALID_CURRENCY = 'INVALID_CURRENCY',\n  /** The routing number (US) is invalid or does not match the receiving bank. */\n  INVALID_ROUTING_NUMBER = 'INVALID_ROUTING_NUMBER',\n  /** The sort code (UK) is invalid or does not match the receiving bank. */\n  INVALID_SORT_CODE = 'INVALID_SORT_CODE',\n  /**\n   * No bank account is on file for the merchant.\n   * The merchant must add bank details before payouts can succeed.\n   */\n  NO_ACCOUNT = 'NO_ACCOUNT',\n  /**\n   * A technical error at the bank rail prevented the transfer.\n   * A subsequent payout attempt may succeed.\n   */\n  TECHNICAL_ERROR = 'TECHNICAL_ERROR',\n}\n\n/** @enumType */\nexport type PayoutFailureCodeWithLiterals =\n  | PayoutFailureCode\n  | 'GENERIC_PAYOUT_FAILURE'\n  | 'ACCOUNT_CLOSED'\n  | 'ACCOUNT_FROZEN'\n  | 'BANK_ACCOUNT_RESTRICTED'\n  | 'BANK_OWNERSHIP_CHANGED'\n  | 'COULD_NOT_PROCESS'\n  | 'DEBIT_NOT_AUTHORIZED'\n  | 'INCORRECT_ACCOUNT_HOLDER_NAME'\n  | 'INVALID_ACCOUNT_DETAILS_CITY'\n  | 'INVALID_ACCOUNT_NUMBER'\n  | 'INVALID_CURRENCY'\n  | 'INVALID_ROUTING_NUMBER'\n  | 'INVALID_SORT_CODE'\n  | 'NO_ACCOUNT'\n  | 'TECHNICAL_ERROR';\n\nexport interface ListPayoutsRequest {\n  /**\n   * ID of the Wix Payments account whose payouts to list.\n   * @format GUID\n   */\n  accountId: string;\n  /**\n   * Optional. When omitted, payouts across all profiles of the account are returned.\n   * When set, only payouts belonging to the specified account profile are returned.\n   * @format GUID\n   */\n  accountProfileId?: string | null;\n  /** Optional. Returns only payouts created before this timestamp. */\n  createdBefore?: Date | null;\n  /** Optional. Returns only payouts created after this timestamp. */\n  createdAfter?: Date | null;\n  /** Optional. Sorting. Only `created_date` is supported; requests sorting by any other field are rejected with INVALID_ARGUMENT. */\n  sort?: Sorting;\n  /** Optional paging. Offset-based. */\n  paging?: Paging;\n}\n\nexport interface Sorting {\n  /**\n   * Name of the field to sort by.\n   * @maxLength 512\n   */\n  fieldName?: string;\n  /** Sort order. */\n  order?: SortOrderWithLiterals;\n}\n\nexport enum SortOrder {\n  ASC = 'ASC',\n  DESC = 'DESC',\n}\n\n/** @enumType */\nexport type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';\n\nexport interface Paging {\n  /** Number of items to load. */\n  limit?: number | null;\n  /** Number of items to skip in the current sort order. */\n  offset?: number | null;\n}\n\nexport interface ListPayoutsResponse {\n  /** List of payouts. */\n  payouts?: Payout[];\n  /** Paging metadata. */\n  metadata?: PagingMetadata;\n}\n\nexport interface PagingMetadata {\n  /** Number of items returned in the response. */\n  count?: number | null;\n  /** Offset that was requested. */\n  offset?: number | null;\n  /** Total number of items that match the query. */\n  total?: number | null;\n  /** Flag that indicates the server failed to calculate the `total` field. */\n  tooManyToCount?: boolean | null;\n}\n\nexport interface CreatePayoutRequest {\n  /** Payout. */\n  payout?: Payout;\n}\n\nexport interface CreatePayoutResponse {\n  /** Payout. */\n  payout?: Payout;\n}\n\nexport interface GetPayoutRequest {\n  /**\n   * ID of the Wix Payments account the payout belongs to.\n   * @format GUID\n   */\n  accountId: string;\n  /**\n   * ID of the payout to retrieve.\n   * @format GUID\n   */\n  payoutId: string;\n}\n\nexport interface GetPayoutResponse {\n  /** Payout. */\n  payout?: Payout;\n}\n\nexport interface ListPayoutGroupsRequest {\n  /**\n   * Wix Payments account identifier.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * Optional filter by payout date. Use it to return payouts before specific date.\n   * @format LOCAL_DATE\n   */\n  payoutDateBefore?: string | null;\n  /**\n   * Optional filter by payout date. Use it to return payouts after specific date.\n   * @format LOCAL_DATE\n   */\n  payoutDateAfter?: string | null;\n  /** Optional sorting. Supported fields: \"payout_date\". */\n  sort?: Sorting;\n  /** Optional paging. */\n  paging?: Paging;\n}\n\nexport interface ListPayoutGroupsResponse {\n  /** List of payout groups. */\n  groups?: PayoutGroup[];\n  /** Paging metadata. */\n  metadata?: PagingMetadata;\n}\n\n/** Payout group */\nexport interface PayoutGroup {\n  /**\n   * Payout date.\n   * @format LOCAL_DATE\n   */\n  payoutDate?: string;\n  /**\n   * Payout number within the same date, is absent if there's only one group\n   * @min 1\n   * @max 99\n   */\n  payoutNumber?: number | null;\n  /** Payout group amount */\n  amount?: Money;\n  /**\n   * Payouts associated with the group\n   * @maxSize 10\n   */\n  payouts?: Payout[];\n}\n\nexport interface GetPayoutGroupRequest {\n  /**\n   * Wix Payments account identifier.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * Payout date.\n   * @format LOCAL_DATE\n   */\n  payoutDate?: string;\n  /**\n   * Optional payout number within the same date\n   * @min 1\n   * @max 99\n   */\n  payoutNumber?: number | null;\n}\n\nexport interface GetPayoutGroupResponse {\n  /** Payout group. */\n  group?: PayoutGroup;\n}\n\nexport interface GetPayoutGroupByPayoutIdRequest {\n  /**\n   * Wix Payments account identifier.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * Payout identifier.\n   * @format GUID\n   */\n  payoutId?: string;\n}\n\nexport interface GetPayoutGroupByPayoutIdResponse {\n  /** Payout group. */\n  group?: PayoutGroup;\n}\n\nexport interface DomainEvent extends DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * 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.\n   * 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.\n   */\n  entityEventSequence?: string | null;\n}\n\n/** @oneof */\nexport interface DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n}\n\nexport interface EntityCreatedEvent {\n  entity?: string;\n}\n\nexport interface RestoreInfo {\n  deletedDate?: Date | null;\n}\n\nexport interface EntityUpdatedEvent {\n  /**\n   * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n   * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n   * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n   */\n  currentEntity?: string;\n}\n\nexport interface EntityDeletedEvent {\n  /** Entity that was deleted. */\n  deletedEntity?: string | null;\n}\n\nexport interface ActionEvent {\n  body?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n  /** Details related to the account */\n  accountInfo?: AccountInfo;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\n\nexport interface AccountInfo {\n  /**\n   * ID of the Wix account associated with the event.\n   * @format GUID\n   */\n  accountId?: string | null;\n  /**\n   * ID of the parent Wix account. Only included when accountId belongs to a child account.\n   * @format GUID\n   */\n  parentAccountId?: string | null;\n  /**\n   * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.\n   * @format GUID\n   */\n  siteId?: string | null;\n}\n\nexport interface BaseEventMetadata {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Details related to the account */\n  accountInfo?: AccountInfo;\n}\n\nexport interface EventMetadata extends BaseEventMetadata {\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * 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.\n   * 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.\n   */\n  entityEventSequence?: string | null;\n  accountInfo?: AccountInfoMetadata;\n}\n\nexport interface AccountInfoMetadata {\n  /** ID of the Wix account associated with the event */\n  accountId: string;\n  /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */\n  siteId?: string;\n  /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */\n  parentAccountId?: string;\n}\n\nexport interface PayoutCreatedEnvelope {\n  entity: Payout;\n  metadata: EventMetadata;\n}\n\n/**\n * Emitted once when the payout is first persisted, before the underlying transfer\n * is initiated at the bank. At this point `status` is SENT and `estimated_arrival_date`\n * is set if the bank rail returned one; `failure_reason` and `bank_transfer_reference`\n * are not yet populated.\n * @permissionId PAYMENTS.PAYOUT_READ\n * @webhook\n * @eventType wix.payments.payouts.v4.payout_created\n * @serviceIdentifier wix.payments.v4.payouts.PayoutsService\n * @slug created\n * @documentationMaturity preview\n */\nexport declare function onPayoutCreated(\n  handler: (event: PayoutCreatedEnvelope) => void | Promise<void>\n): void;\n\nexport interface PayoutUpdatedEnvelope {\n  entity: Payout;\n  metadata: EventMetadata;\n}\n\n/**\n * Emitted on every change to a persisted payout. Typical transitions include:\n * status moving from SENT to FAILED (and the corresponding `failure_reason` being set),\n * `estimated_arrival_date` being updated by the bank rail, and `bank_transfer_reference`\n * being populated once the rail returns it.\n * @permissionId PAYMENTS.PAYOUT_READ\n * @webhook\n * @eventType wix.payments.payouts.v4.payout_updated\n * @serviceIdentifier wix.payments.v4.payouts.PayoutsService\n * @slug updated\n * @documentationMaturity preview\n */\nexport declare function onPayoutUpdated(\n  handler: (event: PayoutUpdatedEnvelope) => void | Promise<void>\n): void;\n\n/**\n * Retrieves a paginated list of payouts for the specified Wix Payments account,\n * with optional filters by profile and creation date.\n * @param accountId - ID of the Wix Payments account whose payouts to list.\n * @public\n * @documentationMaturity preview\n * @requiredField accountId\n * @permissionId PAYMENTS.PAYOUT_READ\n * @fqn wix.payments.v4.payouts.PayoutsService.ListPayouts\n */\nexport async function listPayouts(\n  accountId: string,\n  options?: ListPayoutsOptions\n): Promise<\n  NonNullablePaths<\n    ListPayoutsResponse,\n    | `payouts`\n    | `payouts.${number}._id`\n    | `payouts.${number}.accountId`\n    | `payouts.${number}.accountProfileId`\n    | `payouts.${number}.amount.value`\n    | `payouts.${number}.amount.currency`\n    | `payouts.${number}.status`\n    | `payouts.${number}.failureReason.code`\n    | `payouts.${number}.cashAdvanceIncluded`,\n    5\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    accountId: accountId,\n    accountProfileId: options?.accountProfileId,\n    createdBefore: options?.createdBefore,\n    createdAfter: options?.createdAfter,\n    sort: options?.sort,\n    paging: options?.paging,\n  });\n\n  const reqOpts = ambassadorWixPaymentsPayoutsV4Payout.listPayouts(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          accountId: '$[0]',\n          accountProfileId: '$[1].accountProfileId',\n          createdBefore: '$[1].createdBefore',\n          createdAfter: '$[1].createdAfter',\n          sort: '$[1].sort',\n          paging: '$[1].paging',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['accountId', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface ListPayoutsOptions {\n  /**\n   * Optional. When omitted, payouts across all profiles of the account are returned.\n   * When set, only payouts belonging to the specified account profile are returned.\n   * @format GUID\n   */\n  accountProfileId?: string | null;\n  /** Optional. Returns only payouts created before this timestamp. */\n  createdBefore?: Date | null;\n  /** Optional. Returns only payouts created after this timestamp. */\n  createdAfter?: Date | null;\n  /** Optional. Sorting. Only `created_date` is supported; requests sorting by any other field are rejected with INVALID_ARGUMENT. */\n  sort?: Sorting;\n  /** Optional paging. Offset-based. */\n  paging?: Paging;\n}\n\n/**\n * Retrieves a single payout by id.\n * @param payoutId - ID of the payout to retrieve.\n * @param accountId - ID of the Wix Payments account the payout belongs to.\n * @public\n * @documentationMaturity preview\n * @requiredField accountId\n * @requiredField payoutId\n * @permissionId PAYMENTS.PAYOUT_READ\n * @returns Payout.\n * @fqn wix.payments.v4.payouts.PayoutsService.GetPayout\n */\nexport async function getPayout(\n  payoutId: string,\n  accountId: string\n): Promise<\n  NonNullablePaths<\n    Payout,\n    | `_id`\n    | `accountId`\n    | `accountProfileId`\n    | `amount.value`\n    | `amount.currency`\n    | `status`\n    | `failureReason.code`\n    | `cashAdvanceIncluded`,\n    3\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    payoutId: payoutId,\n    accountId: accountId,\n  });\n\n  const reqOpts = ambassadorWixPaymentsPayoutsV4Payout.getPayout(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)?.payout!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { payoutId: '$[0]', accountId: '$[1]' },\n        singleArgumentUnchanged: false,\n      },\n      ['payoutId', 'accountId']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixPaymentsV4PayoutsPayoutsServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'api._api_base_domain_': [\n      {\n        srcPath: '/wixpay-payout',\n        destPath: '',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payouts',\n        destPath: '/v4/bo-payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payout-policies',\n        destPath: '/v4/bo-payout-policies',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payouts',\n        destPath: '/v4/bo-payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payout-policies',\n        destPath: '/v4/bo-payout-policies',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payouts',\n        destPath: '/v4/bo-payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payout-policies',\n        destPath: '/v4/bo-payout-policies',\n      },\n    ],\n    'payment-webhooks.wixapps.net': [\n      {\n        srcPath: '/wix-payments/payout-callbacks/stripe',\n        destPath: '/payout-callbacks/stripe',\n      },\n      {\n        srcPath: '/wix-payments/payout-callbacks/adyen',\n        destPath: '/payout-callbacks/adyen',\n      },\n      {\n        srcPath: '/wix-payments/payout-callbacks/stone',\n        destPath: '/payout-callbacks/stone',\n      },\n      {\n        srcPath: '/wix-payments/payout-callbacks/paypal',\n        destPath: '/payout-callbacks/paypal',\n      },\n    ],\n    'cronulla-jobs._base_domain_': [\n      {\n        srcPath: '/wix-payments/wixpay-payout/internal-api/jobs',\n        destPath: '/internal-api/jobs',\n      },\n    ],\n    'manage.base44.com': [\n      {\n        srcPath: '/_api/wixpay-payout',\n        destPath: '',\n      },\n    ],\n    'payments.base44.com': [\n      {\n        srcPath: '/_api/wixpay-payout',\n        destPath: '',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/wixpay-payouts/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_payments_payouts';\n\n/**\n * Retrieves a paginated list of payouts for the specified Wix Payments account,\n * with optional filters by profile and creation date.\n */\nexport function listPayouts(payload: object): RequestOptionsFactory<any> {\n  function __listPayouts({ host }: any) {\n    const serializedData = transformPaths(payload, [\n      {\n        transformFn: transformSDKTimestampToRESTTimestamp,\n        paths: [{ path: 'createdBefore' }, { path: 'createdAfter' }],\n      },\n    ]);\n    const metadata = {\n      entityFqdn: 'wix.payments.payouts.v4.payout',\n      method: 'GET' as any,\n      methodFqn: 'wix.payments.v4.payouts.PayoutsService.ListPayouts',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixPaymentsV4PayoutsPayoutsServiceUrl({\n        protoPath: '/v4/payouts',\n        data: serializedData,\n        host,\n      }),\n      params: toURLSearchParams(serializedData, true),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'payouts.createdDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __listPayouts;\n}\n\n/** Retrieves a single payout by id. */\nexport function getPayout(payload: object): RequestOptionsFactory<any> {\n  function __getPayout({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.payments.payouts.v4.payout',\n      method: 'GET' as any,\n      methodFqn: 'wix.payments.v4.payouts.PayoutsService.GetPayout',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixPaymentsV4PayoutsPayoutsServiceUrl({\n        protoPath: '/v4/payouts/{payoutId}',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'payout.createdDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getPayout;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAAA;AAAA,EAAA,mBAAAC;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,0BAAkC;AAClC,uBAAqD;AACrD,IAAAC,oBAAqD;AACrD,6BAA+B;AAC/B,IAAAC,uBAA2B;AAI3B,SAAS,6CACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,yBAAyB;AAAA,MACvB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,gCAAgC;AAAA,MAC9B;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,+BAA+B;AAAA,MAC7B;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,uBAAuB;AAAA,MACrB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAMd,SAAS,YAAY,SAA6C;AACvE,WAAS,cAAc,EAAE,KAAK,GAAQ;AACpC,UAAM,qBAAiB,uCAAe,SAAS;AAAA,MAC7C;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,gBAAgB,GAAG,EAAE,MAAM,eAAe,CAAC;AAAA,MAC7D;AAAA,IACF,CAAC;AACD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,6CAA6C;AAAA,QAChD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,gBAAgB,IAAI;AAAA,MAC9C,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAAA,QACzC;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,UAAU,SAA6C;AACrE,WAAS,YAAY,EAAE,KAAK,GAAQ;AAClC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,6CAA6C;AAAA,QAChD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,qBAAqB,CAAC;AAAA,QACxC;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;AD7GO,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,aAAU;AAOV,EAAAA,cAAA,UAAO;AAKP,EAAAA,cAAA,YAAS;AAdC,SAAAA;AAAA,GAAA;AAsCL,IAAK,oBAAL,kBAAKC,uBAAL;AAML,EAAAA,mBAAA,4BAAyB;AAKzB,EAAAA,mBAAA,oBAAiB;AAKjB,EAAAA,mBAAA,oBAAiB;AAKjB,EAAAA,mBAAA,6BAA0B;AAK1B,EAAAA,mBAAA,4BAAyB;AAKzB,EAAAA,mBAAA,uBAAoB;AAKpB,EAAAA,mBAAA,0BAAuB;AAKvB,EAAAA,mBAAA,mCAAgC;AAEhC,EAAAA,mBAAA,kCAA+B;AAE/B,EAAAA,mBAAA,4BAAyB;AAEzB,EAAAA,mBAAA,sBAAmB;AAEnB,EAAAA,mBAAA,4BAAyB;AAEzB,EAAAA,mBAAA,uBAAoB;AAKpB,EAAAA,mBAAA,gBAAa;AAKb,EAAAA,mBAAA,qBAAkB;AA7DR,SAAAA;AAAA,GAAA;AAmHL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,UAAO;AAFG,SAAAA;AAAA,GAAA;AAmSL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;AAiJZ,eAAsBC,aACpB,WACA,SAeA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,kBAAkB,SAAS;AAAA,IAC3B,eAAe,SAAS;AAAA,IACxB,cAAc,SAAS;AAAA,IACvB,MAAM,SAAS;AAAA,IACf,QAAQ,SAAS;AAAA,EACnB,CAAC;AAED,QAAM,UAA+C,YAAY,OAAO;AAExE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,WAAW;AAAA,UACX,kBAAkB;AAAA,UAClB,eAAe;AAAA,UACf,cAAc;AAAA,UACd,MAAM;AAAA,UACN,QAAQ;AAAA,QACV;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,aAAa,SAAS;AAAA,IACzB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AA+BA,eAAsBC,WACpB,UACA,WAcA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,UAA+C,UAAU,OAAO;AAEtE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI,GAAG;AAAA,EAC/D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAD;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,UAAU,QAAQ,WAAW,OAAO;AAAA,QAChE,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,YAAY,WAAW;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;","names":["getPayout","listPayouts","import_timestamp","import_rest_modules","payload","PayoutStatus","PayoutFailureCode","SortOrder","WebhookIdentityType","listPayouts","sdkTransformError","getPayout"]}
+{"version":3,"sources":["../../index.typings.ts","../../src/payments-payouts-v4-payout-payouts.universal.ts","../../src/payments-payouts-v4-payout-payouts.http.ts"],"sourcesContent":["export * from './src/payments-payouts-v4-payout-payouts.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixPaymentsPayoutsV4Payout from './payments-payouts-v4-payout-payouts.http.js';\n\n/**\n * A payout is an outgoing transfer of funds from a Wix Payments account to the\n * merchant's bank account. Each payout has an amount, a lifecycle status, an\n * estimated arrival date, and (when applicable) a failure reason.\n */\nexport interface Payout {\n  /**\n   * Payout ID.\n   * @format GUID\n   */\n  _id?: string;\n  /**\n   * ID of the Wix Payments account that owns the payout. Retrieve account IDs\n   * from the Accounts API.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * ID of the Wix Payments account profile that owns the payout.\n   *\n   * A Wix Payments account has 1 or more profiles. Each profile has its own\n   * balance and its own payouts. Most merchants have 1 profile. Retrieve\n   * profile IDs from the Accounts API.\n   * @format GUID\n   */\n  accountProfileId?: string;\n  /**\n   * Date and time the payout was created.\n   *\n   * The payout is created before the underlying transfer is initiated at the\n   * bank. Once initiated, the funds typically reach the merchant's bank account\n   * within 3 to 5 business days, depending on the receiving bank.\n   */\n  _createdDate?: Date | null;\n  /** Amount of the transfer to the merchant's bank account. */\n  amount?: Money;\n  /**\n   * Lifecycle status of the payout.\n   *\n   * `SENT` means the bank rail accepted the transfer for delivery. `FAILED` means\n   * the receiving bank rejected the transfer.\n   *\n   * A `SENT` status doesn't guarantee that the funds were delivered to the\n   * merchant. The bank rail doesn't provide a delivery acknowledgement, and a\n   * payout in `SENT` can later transition to `FAILED` if the receiving bank\n   * rejects the transfer. See the per-value documentation on `PayoutStatus` for\n   * details.\n   */\n  status?: PayoutStatusWithLiterals;\n  /**\n   * Estimated date for when the funds should arrive at the merchant's bank\n   * account, in `YYYY-MM-DD` format.\n   *\n   * The estimated arrival date is a prediction, not a guarantee. Actual arrival\n   * depends on the receiving bank's processing and may be later.\n   * @format LOCAL_DATE\n   */\n  estimatedArrivalDateV2?: string | null;\n  /**\n   * Reason the bank rail rejected the transfer.\n   *\n   * Returned only when `status` is `FAILED`.\n   */\n  failureReason?: PayoutFailureReason;\n  /**\n   * Reference returned by the bank rail once the transfer is initiated. For\n   * example, an ACH trace number or a SEPA reference. Use this value to\n   * reconcile against the merchant's bank statement.\n   *\n   * Empty until the bank rail returns a reference.\n   * @maxLength 500\n   */\n  bankTransferReference?: string | null;\n  /**\n   * Whether the payout `amount` includes funds from a Wix Capital cash advance\n   * taken out by the merchant. If `false`, the amount comes only from the\n   * merchant's sales proceeds.\n   */\n  cashAdvanceIncluded?: boolean;\n}\n\n/**\n * Money.\n * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.\n */\nexport interface Money {\n  /**\n   * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.\n   * @format DECIMAL_VALUE\n   */\n  value?: string;\n  /**\n   * Currency code. Must be valid ISO 4217 currency code (e.g., USD).\n   * @format CURRENCY\n   */\n  currency?: string;\n  /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */\n  formattedValue?: string | null;\n}\n\n/** Lifecycle status of a payout. */\nexport enum PayoutStatus {\n  /** Unknown payout status. Not returned by the API. */\n  UNKNOWN = 'UNKNOWN',\n  /**\n   * The bank rail accepted the transfer. Funds are en route to the merchant's\n   * bank account.\n   *\n   * Acceptance isn't the same as delivery. A `SENT` payout can still\n   * transition to `FAILED` if the receiving bank rejects the transfer. The\n   * bank rail's return window is up to 60 days for ACH and up to 13 months\n   * for SEPA.\n   */\n  SENT = 'SENT',\n  /**\n   * The bank rail rejected the transfer. See `failureReason` for the cause.\n   * The funds remain in the merchant's Wix Payments balance.\n   */\n  FAILED = 'FAILED',\n}\n\n/** @enumType */\nexport type PayoutStatusWithLiterals =\n  | PayoutStatus\n  | 'UNKNOWN'\n  | 'SENT'\n  | 'FAILED';\n\n/** Reason a payout failed. */\nexport interface PayoutFailureReason {\n  /** Why the bank rail rejected the transfer. */\n  code?: PayoutFailureCodeWithLiterals;\n}\n\n/**\n * Possible reasons for a payout failure. Each value describes a real-world\n * bank-rail condition.\n */\nexport enum PayoutFailureCode {\n  /**\n   * Generic failure with no more specific reason available from the bank\n   * rail. This value is also returned when no failure reason is known.\n   * Clients can't distinguish \"unknown\" from \"generic\" using this code alone.\n   */\n  GENERIC_PAYOUT_FAILURE = 'GENERIC_PAYOUT_FAILURE',\n  /**\n   * The merchant's bank account is closed. The merchant must provide new\n   * bank account details before further payouts can succeed.\n   */\n  ACCOUNT_CLOSED = 'ACCOUNT_CLOSED',\n  /**\n   * The merchant's bank account is frozen, for example due to a hold placed\n   * by the bank. The merchant must resolve the hold with their bank before\n   * further payouts can succeed.\n   */\n  ACCOUNT_FROZEN = 'ACCOUNT_FROZEN',\n  /**\n   * The merchant's bank account is restricted from receiving the transfer.\n   * For example, the account type or status doesn't permit incoming credits.\n   */\n  BANK_ACCOUNT_RESTRICTED = 'BANK_ACCOUNT_RESTRICTED',\n  /**\n   * Ownership of the merchant's bank account changed and the rail no longer\n   * recognises the previously-recorded owner. New bank details are required.\n   */\n  BANK_OWNERSHIP_CHANGED = 'BANK_OWNERSHIP_CHANGED',\n  /**\n   * The receiving bank couldn't process the transfer for an unspecified\n   * reason. A subsequent payout attempt may succeed.\n   */\n  COULD_NOT_PROCESS = 'COULD_NOT_PROCESS',\n  /**\n   * The merchant's bank declined the debit authorisation associated with the\n   * transfer. The merchant must contact their bank to authorise Wix Payments\n   * payouts.\n   */\n  DEBIT_NOT_AUTHORIZED = 'DEBIT_NOT_AUTHORIZED',\n  /**\n   * The account holder name on file doesn't match the name the receiving\n   * bank has on record. The merchant must correct the account holder name.\n   */\n  INCORRECT_ACCOUNT_HOLDER_NAME = 'INCORRECT_ACCOUNT_HOLDER_NAME',\n  /** The city in the bank account details is invalid for the receiving bank. */\n  INVALID_ACCOUNT_DETAILS_CITY = 'INVALID_ACCOUNT_DETAILS_CITY',\n  /**\n   * The bank account number is invalid. The format is wrong or the account\n   * doesn't exist.\n   */\n  INVALID_ACCOUNT_NUMBER = 'INVALID_ACCOUNT_NUMBER',\n  /** The payout currency isn't supported by the receiving bank account. */\n  INVALID_CURRENCY = 'INVALID_CURRENCY',\n  /** The routing number (US) is invalid or doesn't match the receiving bank. */\n  INVALID_ROUTING_NUMBER = 'INVALID_ROUTING_NUMBER',\n  /** The sort code (UK) is invalid or doesn't match the receiving bank. */\n  INVALID_SORT_CODE = 'INVALID_SORT_CODE',\n  /**\n   * No bank account is on file for the merchant. The merchant must add bank\n   * details before payouts can succeed.\n   */\n  NO_ACCOUNT = 'NO_ACCOUNT',\n  /**\n   * A technical error at the bank rail prevented the transfer. A subsequent\n   * payout attempt may succeed.\n   */\n  TECHNICAL_ERROR = 'TECHNICAL_ERROR',\n}\n\n/** @enumType */\nexport type PayoutFailureCodeWithLiterals =\n  | PayoutFailureCode\n  | 'GENERIC_PAYOUT_FAILURE'\n  | 'ACCOUNT_CLOSED'\n  | 'ACCOUNT_FROZEN'\n  | 'BANK_ACCOUNT_RESTRICTED'\n  | 'BANK_OWNERSHIP_CHANGED'\n  | 'COULD_NOT_PROCESS'\n  | 'DEBIT_NOT_AUTHORIZED'\n  | 'INCORRECT_ACCOUNT_HOLDER_NAME'\n  | 'INVALID_ACCOUNT_DETAILS_CITY'\n  | 'INVALID_ACCOUNT_NUMBER'\n  | 'INVALID_CURRENCY'\n  | 'INVALID_ROUTING_NUMBER'\n  | 'INVALID_SORT_CODE'\n  | 'NO_ACCOUNT'\n  | 'TECHNICAL_ERROR';\n\nexport interface ListPayoutsRequest {\n  /**\n   * ID of the Wix Payments account whose payouts to list. Retrieve account\n   * IDs from the Accounts API.\n   * @format GUID\n   */\n  accountId: string;\n  /**\n   * ID of the Wix Payments account profile to filter by.\n   *\n   * When omitted, payouts across all profiles of the account are returned.\n   * Retrieve profile IDs from the Accounts API.\n   * @format GUID\n   */\n  accountProfileId?: string | null;\n  /** Returns only payouts created before this date and time. */\n  createdBefore?: Date | null;\n  /** Returns only payouts created after this date and time. */\n  createdAfter?: Date | null;\n  /**\n   * Sort order for the result list.\n   *\n   * Supported `fieldName` values: `created_date` (snake_case, not auto-converted). At most 1 sort field is allowed.\n   */\n  sort?: Sorting;\n  /** Offset-based paging. */\n  paging?: Paging;\n}\n\nexport interface Sorting {\n  /**\n   * Name of the field to sort by.\n   * @maxLength 512\n   */\n  fieldName?: string;\n  /** Sort order. */\n  order?: SortOrderWithLiterals;\n}\n\nexport enum SortOrder {\n  ASC = 'ASC',\n  DESC = 'DESC',\n}\n\n/** @enumType */\nexport type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';\n\nexport interface Paging {\n  /** Number of items to load. */\n  limit?: number | null;\n  /** Number of items to skip in the current sort order. */\n  offset?: number | null;\n}\n\nexport interface ListPayoutsResponse {\n  /** List of retrieved payouts. */\n  payouts?: Payout[];\n  /** Paging metadata. */\n  metadata?: PagingMetadata;\n}\n\nexport interface PagingMetadata {\n  /** Number of items returned in the response. */\n  count?: number | null;\n  /** Offset that was requested. */\n  offset?: number | null;\n  /** Total number of items that match the query. */\n  total?: number | null;\n  /** Flag that indicates the server failed to calculate the `total` field. */\n  tooManyToCount?: boolean | null;\n}\n\nexport interface CreatePayoutRequest {\n  /** Payout to create. */\n  payout?: Payout;\n}\n\nexport interface CreatePayoutResponse {\n  /** Created payout. */\n  payout?: Payout;\n}\n\nexport interface GetPayoutRequest {\n  /**\n   * ID of the Wix Payments account that owns the payout. The payout must\n   * belong to this account. Retrieve account IDs from the Accounts API.\n   * @format GUID\n   */\n  accountId: string;\n  /**\n   * ID of the payout to retrieve.\n   * @format GUID\n   */\n  payoutId: string;\n}\n\nexport interface GetPayoutResponse {\n  /** Retrieved payout. */\n  payout?: Payout;\n}\n\nexport interface ListPayoutGroupsRequest {\n  /**\n   * ID of the Wix Payments account whose payout groups to list. Retrieve\n   * account IDs from the Accounts API.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * Optional filter by payout date. Use it to return payouts before specific date.\n   * @format LOCAL_DATE\n   */\n  payoutDateBefore?: string | null;\n  /**\n   * Optional filter by payout date. Use it to return payouts after specific date.\n   * @format LOCAL_DATE\n   */\n  payoutDateAfter?: string | null;\n  /** Optional sorting. Supported fields: \"payout_date\". */\n  sort?: Sorting;\n  /** Optional paging. */\n  paging?: Paging;\n}\n\nexport interface ListPayoutGroupsResponse {\n  /** List of payout groups. */\n  groups?: PayoutGroup[];\n  /** Paging metadata. */\n  metadata?: PagingMetadata;\n}\n\n/** Payout group */\nexport interface PayoutGroup {\n  /**\n   * Payout date.\n   * @format LOCAL_DATE\n   */\n  payoutDate?: string;\n  /**\n   * Payout number within the same date, is absent if there's only one group\n   * @min 1\n   * @max 99\n   */\n  payoutNumber?: number | null;\n  /** Payout group amount */\n  amount?: Money;\n  /**\n   * Payouts associated with the group\n   * @maxSize 10\n   */\n  payouts?: Payout[];\n}\n\nexport interface GetPayoutGroupRequest {\n  /**\n   * ID of the Wix Payments account that owns the payout group. Retrieve\n   * account IDs from the Accounts API.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * Payout date.\n   * @format LOCAL_DATE\n   */\n  payoutDate?: string;\n  /**\n   * Optional payout number within the same date\n   * @min 1\n   * @max 99\n   */\n  payoutNumber?: number | null;\n}\n\nexport interface GetPayoutGroupResponse {\n  /** Payout group. */\n  group?: PayoutGroup;\n}\n\nexport interface GetPayoutGroupByPayoutIdRequest {\n  /**\n   * ID of the Wix Payments account that owns the payout. Retrieve account IDs\n   * from the Accounts API.\n   * @format GUID\n   */\n  accountId?: string;\n  /**\n   * ID of the payout whose group to retrieve.\n   * @format GUID\n   */\n  payoutId?: string;\n}\n\nexport interface GetPayoutGroupByPayoutIdResponse {\n  /** Payout group. */\n  group?: PayoutGroup;\n}\n\nexport interface DomainEvent extends DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * 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.\n   * 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.\n   */\n  entityEventSequence?: string | null;\n}\n\n/** @oneof */\nexport interface DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n}\n\nexport interface EntityCreatedEvent {\n  entity?: string;\n}\n\nexport interface RestoreInfo {\n  deletedDate?: Date | null;\n}\n\nexport interface EntityUpdatedEvent {\n  /**\n   * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n   * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n   * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n   */\n  currentEntity?: string;\n}\n\nexport interface EntityDeletedEvent {\n  /** Entity that was deleted. */\n  deletedEntity?: string | null;\n}\n\nexport interface ActionEvent {\n  body?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n  /** Details related to the account */\n  accountInfo?: AccountInfo;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\n\nexport interface AccountInfo {\n  /**\n   * ID of the Wix account associated with the event.\n   * @format GUID\n   */\n  accountId?: string | null;\n  /**\n   * ID of the parent Wix account. Only included when accountId belongs to a child account.\n   * @format GUID\n   */\n  parentAccountId?: string | null;\n  /**\n   * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.\n   * @format GUID\n   */\n  siteId?: string | null;\n}\n\nexport interface BaseEventMetadata {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Details related to the account */\n  accountInfo?: AccountInfo;\n}\n\nexport interface EventMetadata extends BaseEventMetadata {\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * 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.\n   * 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.\n   */\n  entityEventSequence?: string | null;\n  accountInfo?: AccountInfoMetadata;\n}\n\nexport interface AccountInfoMetadata {\n  /** ID of the Wix account associated with the event */\n  accountId: string;\n  /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */\n  siteId?: string;\n  /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */\n  parentAccountId?: string;\n}\n\nexport interface PayoutCreatedEnvelope {\n  entity: Payout;\n  metadata: EventMetadata;\n}\n\n/**\n * Triggered when a payout is created.\n *\n * The payout is created before the underlying transfer is initiated at the\n * bank. At this point `status` is `SENT` and `estimatedArrivalDateV2` is set\n * if the bank rail returned one. `failureReason` and `bankTransferReference`\n * are not yet populated.\n * @permissionScope View settlement reports and payouts\n * @permissionScopeId SCOPE.PAYMENTS.PAYOUTS-VIEW-FOR-SITE\n * @permissionId PAYMENTS.PAYOUT_READ\n * @webhook\n * @eventType wix.payments.payouts.v4.payout_created\n * @serviceIdentifier wix.payments.v4.payouts.PayoutsService\n * @slug created\n * @documentationMaturity preview\n */\nexport declare function onPayoutCreated(\n  handler: (event: PayoutCreatedEnvelope) => void | Promise<void>\n): void;\n\nexport interface PayoutUpdatedEnvelope {\n  entity: Payout;\n  metadata: EventMetadata;\n}\n\n/**\n * Triggered when a payout is updated.\n *\n * Typical updates include `status` transitioning from `SENT` to `FAILED`\n * (with `failureReason` being set), `estimatedArrivalDateV2` being refined by\n * the bank rail, and `bankTransferReference` being populated once the rail\n * returns it.\n * @permissionScope View settlement reports and payouts\n * @permissionScopeId SCOPE.PAYMENTS.PAYOUTS-VIEW-FOR-SITE\n * @permissionId PAYMENTS.PAYOUT_READ\n * @webhook\n * @eventType wix.payments.payouts.v4.payout_updated\n * @serviceIdentifier wix.payments.v4.payouts.PayoutsService\n * @slug updated\n * @documentationMaturity preview\n */\nexport declare function onPayoutUpdated(\n  handler: (event: PayoutUpdatedEnvelope) => void | Promise<void>\n): void;\n\n/**\n * Retrieves a paginated list of payouts for the specified Wix Payments account.\n *\n * Supports optional filters by account profile and by creation date range.\n * @param accountId - ID of the Wix Payments account whose payouts to list. Retrieve account\n * IDs from the Accounts API.\n * @public\n * @documentationMaturity preview\n * @requiredField accountId\n * @permissionId PAYMENTS.PAYOUT_READ\n * @applicableIdentity APP\n * @fqn wix.payments.v4.payouts.PayoutsService.ListPayouts\n */\nexport async function listPayouts(\n  accountId: string,\n  options?: ListPayoutsOptions\n): Promise<\n  NonNullablePaths<\n    ListPayoutsResponse,\n    | `payouts`\n    | `payouts.${number}._id`\n    | `payouts.${number}.accountId`\n    | `payouts.${number}.accountProfileId`\n    | `payouts.${number}.amount.value`\n    | `payouts.${number}.amount.currency`\n    | `payouts.${number}.status`\n    | `payouts.${number}.failureReason.code`\n    | `payouts.${number}.cashAdvanceIncluded`,\n    5\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    accountId: accountId,\n    accountProfileId: options?.accountProfileId,\n    createdBefore: options?.createdBefore,\n    createdAfter: options?.createdAfter,\n    sort: options?.sort,\n    paging: options?.paging,\n  });\n\n  const reqOpts = ambassadorWixPaymentsPayoutsV4Payout.listPayouts(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          accountId: '$[0]',\n          accountProfileId: '$[1].accountProfileId',\n          createdBefore: '$[1].createdBefore',\n          createdAfter: '$[1].createdAfter',\n          sort: '$[1].sort',\n          paging: '$[1].paging',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['accountId', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface ListPayoutsOptions {\n  /**\n   * ID of the Wix Payments account profile to filter by.\n   *\n   * When omitted, payouts across all profiles of the account are returned.\n   * Retrieve profile IDs from the Accounts API.\n   * @format GUID\n   */\n  accountProfileId?: string | null;\n  /** Returns only payouts created before this date and time. */\n  createdBefore?: Date | null;\n  /** Returns only payouts created after this date and time. */\n  createdAfter?: Date | null;\n  /**\n   * Sort order for the result list.\n   *\n   * Supported `fieldName` values: `created_date` (snake_case, not auto-converted). At most 1 sort field is allowed.\n   */\n  sort?: Sorting;\n  /** Offset-based paging. */\n  paging?: Paging;\n}\n\n/**\n * Retrieves a single payout by ID.\n * @param payoutId - ID of the payout to retrieve.\n * @param accountId - ID of the Wix Payments account that owns the payout. The payout must\n * belong to this account. Retrieve account IDs from the Accounts API.\n * @public\n * @documentationMaturity preview\n * @requiredField accountId\n * @requiredField payoutId\n * @permissionId PAYMENTS.PAYOUT_READ\n * @applicableIdentity APP\n * @returns Retrieved payout.\n * @fqn wix.payments.v4.payouts.PayoutsService.GetPayout\n */\nexport async function getPayout(\n  payoutId: string,\n  accountId: string\n): Promise<\n  NonNullablePaths<\n    Payout,\n    | `_id`\n    | `accountId`\n    | `accountProfileId`\n    | `amount.value`\n    | `amount.currency`\n    | `status`\n    | `failureReason.code`\n    | `cashAdvanceIncluded`,\n    3\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    payoutId: payoutId,\n    accountId: accountId,\n  });\n\n  const reqOpts = ambassadorWixPaymentsPayoutsV4Payout.getPayout(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)?.payout!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { payoutId: '$[0]', accountId: '$[1]' },\n        singleArgumentUnchanged: false,\n      },\n      ['payoutId', 'accountId']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixPaymentsV4PayoutsPayoutsServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'api._api_base_domain_': [\n      {\n        srcPath: '/wixpay-payout',\n        destPath: '',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n    ],\n    'bo._base_domain_': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payouts',\n        destPath: '/v4/bo-payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payout-policies',\n        destPath: '/v4/bo-payout-policies',\n      },\n    ],\n    'wixbo.ai': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payouts',\n        destPath: '/v4/bo-payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payout-policies',\n        destPath: '/v4/bo-payout-policies',\n      },\n    ],\n    'wix-bo.com': [\n      {\n        srcPath: '/_api/wixpay-payout/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/payout-groups',\n        destPath: '/v4/payout-groups',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payouts',\n        destPath: '/v4/bo-payouts',\n      },\n      {\n        srcPath: '/_api/wixpay-payout/v4/bo-payout-policies',\n        destPath: '/v4/bo-payout-policies',\n      },\n    ],\n    'payment-webhooks.wixapps.net': [\n      {\n        srcPath: '/wix-payments/payout-callbacks/stripe',\n        destPath: '/payout-callbacks/stripe',\n      },\n      {\n        srcPath: '/wix-payments/payout-callbacks/adyen',\n        destPath: '/payout-callbacks/adyen',\n      },\n      {\n        srcPath: '/wix-payments/payout-callbacks/stone',\n        destPath: '/payout-callbacks/stone',\n      },\n      {\n        srcPath: '/wix-payments/payout-callbacks/paypal',\n        destPath: '/payout-callbacks/paypal',\n      },\n    ],\n    'cronulla-jobs._base_domain_': [\n      {\n        srcPath: '/wix-payments/wixpay-payout/internal-api/jobs',\n        destPath: '/internal-api/jobs',\n      },\n    ],\n    'manage.base44.com': [\n      {\n        srcPath: '/_api/wixpay-payout',\n        destPath: '',\n      },\n    ],\n    'payments.base44.com': [\n      {\n        srcPath: '/_api/wixpay-payout',\n        destPath: '',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/wixpay-payouts/v4/payouts',\n        destPath: '/v4/payouts',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_payments_payouts';\n\n/**\n * Retrieves a paginated list of payouts for the specified Wix Payments account.\n *\n * Supports optional filters by account profile and by creation date range.\n */\nexport function listPayouts(payload: object): RequestOptionsFactory<any> {\n  function __listPayouts({ host }: any) {\n    const serializedData = transformPaths(payload, [\n      {\n        transformFn: transformSDKTimestampToRESTTimestamp,\n        paths: [{ path: 'createdBefore' }, { path: 'createdAfter' }],\n      },\n    ]);\n    const metadata = {\n      entityFqdn: 'wix.payments.payouts.v4.payout',\n      method: 'GET' as any,\n      methodFqn: 'wix.payments.v4.payouts.PayoutsService.ListPayouts',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixPaymentsV4PayoutsPayoutsServiceUrl({\n        protoPath: '/v4/payouts',\n        data: serializedData,\n        host,\n      }),\n      params: toURLSearchParams(serializedData, true),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'payouts.createdDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __listPayouts;\n}\n\n/** Retrieves a single payout by ID. */\nexport function getPayout(payload: object): RequestOptionsFactory<any> {\n  function __getPayout({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.payments.payouts.v4.payout',\n      method: 'GET' as any,\n      methodFqn: 'wix.payments.v4.payouts.PayoutsService.GetPayout',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixPaymentsV4PayoutsPayoutsServiceUrl({\n        protoPath: '/v4/payouts/{payoutId}',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'payout.createdDate' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getPayout;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAAA;AAAA,EAAA,mBAAAC;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,0BAAkC;AAClC,uBAAqD;AACrD,IAAAC,oBAAqD;AACrD,6BAA+B;AAC/B,IAAAC,uBAA2B;AAI3B,SAAS,6CACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,yBAAyB;AAAA,MACvB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,gCAAgC;AAAA,MAC9B;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,+BAA+B;AAAA,MAC7B;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,uBAAuB;AAAA,MACrB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAOd,SAAS,YAAY,SAA6C;AACvE,WAAS,cAAc,EAAE,KAAK,GAAQ;AACpC,UAAM,qBAAiB,uCAAe,SAAS;AAAA,MAC7C;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,gBAAgB,GAAG,EAAE,MAAM,eAAe,CAAC;AAAA,MAC7D;AAAA,IACF,CAAC;AACD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,6CAA6C;AAAA,QAChD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,gBAAgB,IAAI;AAAA,MAC9C,mBAAmB,CAACC,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAAA,QACzC;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,UAAU,SAA6C;AACrE,WAAS,YAAY,EAAE,KAAK,GAAQ;AAClC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,6CAA6C;AAAA,QAChD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,iBAClB,uCAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,qBAAqB,CAAC;AAAA,QACxC;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;AD9FO,IAAK,eAAL,kBAAKC,kBAAL;AAEL,EAAAA,cAAA,aAAU;AAUV,EAAAA,cAAA,UAAO;AAKP,EAAAA,cAAA,YAAS;AAjBC,SAAAA;AAAA,GAAA;AAqCL,IAAK,oBAAL,kBAAKC,uBAAL;AAML,EAAAA,mBAAA,4BAAyB;AAKzB,EAAAA,mBAAA,oBAAiB;AAMjB,EAAAA,mBAAA,oBAAiB;AAKjB,EAAAA,mBAAA,6BAA0B;AAK1B,EAAAA,mBAAA,4BAAyB;AAKzB,EAAAA,mBAAA,uBAAoB;AAMpB,EAAAA,mBAAA,0BAAuB;AAKvB,EAAAA,mBAAA,mCAAgC;AAEhC,EAAAA,mBAAA,kCAA+B;AAK/B,EAAAA,mBAAA,4BAAyB;AAEzB,EAAAA,mBAAA,sBAAmB;AAEnB,EAAAA,mBAAA,4BAAyB;AAEzB,EAAAA,mBAAA,uBAAoB;AAKpB,EAAAA,mBAAA,gBAAa;AAKb,EAAAA,mBAAA,qBAAkB;AAlER,SAAAA;AAAA,GAAA;AA+HL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,UAAO;AAFG,SAAAA;AAAA,GAAA;AAuSL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;AA4JZ,eAAsBC,aACpB,WACA,SAeA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,kBAAkB,SAAS;AAAA,IAC3B,eAAe,SAAS;AAAA,IACxB,cAAc,SAAS;AAAA,IACvB,MAAM,SAAS;AAAA,IACf,QAAQ,SAAS;AAAA,EACnB,CAAC;AAED,QAAM,UAA+C,YAAY,OAAO;AAExE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,WAAW;AAAA,UACX,kBAAkB;AAAA,UAClB,eAAe;AAAA,UACf,cAAc;AAAA,UACd,MAAM;AAAA,UACN,QAAQ;AAAA,QACV;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,aAAa,SAAS;AAAA,IACzB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAuCA,eAAsBC,WACpB,UACA,WAcA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,UAA+C,UAAU,OAAO;AAEtE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI,GAAG;AAAA,EAC/D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAD;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,UAAU,QAAQ,WAAW,OAAO;AAAA,QAChE,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,YAAY,WAAW;AAAA,IAC1B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;","names":["getPayout","listPayouts","import_timestamp","import_rest_modules","payload","PayoutStatus","PayoutFailureCode","SortOrder","WebhookIdentityType","listPayouts","sdkTransformError","getPayout"]}

package/build/cjs/meta.d.ts

@@ -2,66 +2,82 @@ import { ListPayoutsRequest as ListPayoutsRequest$1, ListPayoutsResponse as List
 import '@wix/sdk-types';
 
 /**
- * A payout is one outgoing transfer of funds from a Wix Payments merchant account
- * to the merchant's bank account. The entity carries the amount, lifecycle status,
- * estimated arrival date, and (when applicable) failure information.
+ * A payout is an outgoing transfer of funds from a Wix Payments account to the
+ * merchant's bank account. Each payout has an amount, a lifecycle status, an
+ * estimated arrival date, and (when applicable) a failure reason.
  */
 interface Payout {
     /**
-     * Unique identifier of the payout. Immutable.
+     * Payout ID.
      * @format GUID
      */
     id?: string;
     /**
-     * ID of the Wix Payments account that owns this payout.
+     * ID of the Wix Payments account that owns the payout. Retrieve account IDs
+     * from the Accounts API.
      * @format GUID
      */
     accountId?: string;
     /**
-     * ID of the Wix Payments account profile this payout belongs to.
-     * A Wix Payments account has one or more profiles; each profile has its own
-     * balance and its own payouts. Most merchants have a single profile.
+     * ID of the Wix Payments account profile that owns the payout.
+     *
+     * A Wix Payments account has 1 or more profiles. Each profile has its own
+     * balance and its own payouts. Most merchants have 1 profile. Retrieve
+     * profile IDs from the Accounts API.
      * @format GUID
      */
     accountProfileId?: string;
     /**
-     * Date the payout was created, in advance of the underlying transfer being
-     * initiated at the bank rail. Once initiated, the funds typically reach the
-     * merchant's bank account within 3-5 business days, depending on the receiving bank.
+     * Date and time the payout was created.
+     *
+     * The payout is created before the underlying transfer is initiated at the
+     * bank. Once initiated, the funds typically reach the merchant's bank account
+     * within 3 to 5 business days, depending on the receiving bank.
      */
     createdDate?: Date | null;
-    /** Amount of funds transferred to the merchant's bank account. */
+    /** Amount of the transfer to the merchant's bank account. */
     amount?: Money;
     /**
-     * Lifecycle status of the payout. `SENT` means the bank rail accepted the transfer
-     * for delivery; `FAILED` means the receiving bank rejected the transfer. The rail
-     * does not provide a delivery acknowledgement, so `SENT` is not the same as
-     * "delivered to the merchant" — see the per-value documentation on `PayoutStatus`.
+     * Lifecycle status of the payout.
+     *
+     * `SENT` means the bank rail accepted the transfer for delivery. `FAILED` means
+     * the receiving bank rejected the transfer.
+     *
+     * A `SENT` status doesn't guarantee that the funds were delivered to the
+     * merchant. The bank rail doesn't provide a delivery acknowledgement, and a
+     * payout in `SENT` can later transition to `FAILED` if the receiving bank
+     * rejects the transfer. See the per-value documentation on `PayoutStatus` for
+     * details.
      */
     status?: PayoutStatusWithLiterals;
     /**
-     * Estimated date for when the funds should arrive at the merchant's bank, returned
-     * by the underlying bank rail when available. This is a prediction, not a guarantee —
-     * actual arrival depends on the receiving bank's processing and may be later.
+     * Estimated date for when the funds should arrive at the merchant's bank
+     * account, in `YYYY-MM-DD` format.
+     *
+     * The estimated arrival date is a prediction, not a guarantee. Actual arrival
+     * depends on the receiving bank's processing and may be later.
      * @format LOCAL_DATE
      */
     estimatedArrivalDateV2?: string | null;
     /**
-     * Set only when `status` is `FAILED`. Indicates why the bank rail rejected the transfer.
-     * The codes are a Wix Payments unified set; the original provider-specific reason is not exposed.
+     * Reason the bank rail rejected the transfer.
+     *
+     * Returned only when `status` is `FAILED`.
      */
     failureReason?: PayoutFailureReason;
     /**
-     * Reference returned by the bank rail (e.g. ACH trace number, SEPA reference) once
-     * the transfer is initiated. Use it for reconciliation against the merchant's bank
-     * statement. Empty when the rail has not yet returned a reference.
+     * Reference returned by the bank rail once the transfer is initiated. For
+     * example, an ACH trace number or a SEPA reference. Use this value to
+     * reconcile against the merchant's bank statement.
+     *
+     * Empty until the bank rail returns a reference.
      * @maxLength 500
      */
     bankTransferReference?: string | null;
     /**
-     * `true` if the payout's `amount` includes funds that originate from a Wix Capital
-     * advance the merchant has taken out. `false` if the amount is composed only of
-     * regular sales proceeds.
+     * Whether the payout `amount` includes funds from a Wix Capital cash advance
+     * taken out by the merchant. If `false`, the amount comes only from the
+     * merchant's sales proceeds.
      */
     cashAdvanceIncluded?: boolean;
 }
@@ -85,56 +101,56 @@ interface Money {
 }
 /** Lifecycle status of a payout. */
 declare enum PayoutStatus {
-    /** Default value. Not returned by the API. */
+    /** Unknown payout status. Not returned by the API. */
     UNKNOWN = "UNKNOWN",
     /**
-     * The bank rail accepted the transfer. Funds are en route to the merchant's bank,
-     * but acceptance is not the same as delivery — a `SENT` payout can still flip to
-     * `FAILED` if the receiving bank rejects the transfer (the rail's return window
-     * is up to 60 days for ACH and up to 13 months for SEPA).
+     * The bank rail accepted the transfer. Funds are en route to the merchant's
+     * bank account.
+     *
+     * Acceptance isn't the same as delivery. A `SENT` payout can still
+     * transition to `FAILED` if the receiving bank rejects the transfer. The
+     * bank rail's return window is up to 60 days for ACH and up to 13 months
+     * for SEPA.
      */
     SENT = "SENT",
     /**
-     * The transfer was rejected by the receiving bank. See `failure_reason` for the cause;
-     * the funds remain in the merchant's Wix Payments balance.
+     * The bank rail rejected the transfer. See `failureReason` for the cause.
+     * The funds remain in the merchant's Wix Payments balance.
      */
     FAILED = "FAILED"
 }
 /** @enumType */
 type PayoutStatusWithLiterals = PayoutStatus | 'UNKNOWN' | 'SENT' | 'FAILED';
-/**
- * Carries the reason a payout failed. Wraps the `PayoutFailureCode` enum to leave room
- * for future fields (e.g. a human-readable message); new clients should still read
- * `failure_reason.code` for the enum value.
- */
+/** Reason a payout failed. */
 interface PayoutFailureReason {
     /** Why the bank rail rejected the transfer. */
     code?: PayoutFailureCodeWithLiterals;
 }
 /**
- * Reasons a payout can fail. Values describe real-world bank-rail conditions and
- * are mapped from the underlying provider into a Wix Payments unified vocabulary.
+ * Possible reasons for a payout failure. Each value describes a real-world
+ * bank-rail condition.
  */
 declare enum PayoutFailureCode {
     /**
-     * Generic failure with no more specific reason available from the bank rail.
-     * Note: this value is also returned when no failure reason is known — clients
-     * cannot distinguish "unknown" from "generic" using this code alone.
+     * Generic failure with no more specific reason available from the bank
+     * rail. This value is also returned when no failure reason is known.
+     * Clients can't distinguish "unknown" from "generic" using this code alone.
      */
     GENERIC_PAYOUT_FAILURE = "GENERIC_PAYOUT_FAILURE",
     /**
-     * The merchant's bank account is closed. The merchant must provide new bank
-     * account details before further payouts can succeed.
+     * The merchant's bank account is closed. The merchant must provide new
+     * bank account details before further payouts can succeed.
      */
     ACCOUNT_CLOSED = "ACCOUNT_CLOSED",
     /**
-     * The merchant's bank account is frozen (e.g. due to a hold placed by the bank).
-     * The merchant must resolve the hold with their bank before further payouts can succeed.
+     * The merchant's bank account is frozen, for example due to a hold placed
+     * by the bank. The merchant must resolve the hold with their bank before
+     * further payouts can succeed.
      */
     ACCOUNT_FROZEN = "ACCOUNT_FROZEN",
     /**
-     * The merchant's bank account is restricted from receiving the transfer
-     * (e.g. account type or status does not permit incoming credits).
+     * The merchant's bank account is restricted from receiving the transfer.
+     * For example, the account type or status doesn't permit incoming credits.
      */
     BANK_ACCOUNT_RESTRICTED = "BANK_ACCOUNT_RESTRICTED",
     /**
@@ -143,38 +159,42 @@ declare enum PayoutFailureCode {
      */
     BANK_OWNERSHIP_CHANGED = "BANK_OWNERSHIP_CHANGED",
     /**
-     * The receiving bank could not process the transfer for an unspecified reason.
-     * A subsequent payout attempt may succeed.
+     * The receiving bank couldn't process the transfer for an unspecified
+     * reason. A subsequent payout attempt may succeed.
      */
     COULD_NOT_PROCESS = "COULD_NOT_PROCESS",
     /**
-     * The merchant's bank declined the debit authorisation associated with the transfer.
-     * The merchant must contact their bank to authorise Wix Payments payouts.
+     * The merchant's bank declined the debit authorisation associated with the
+     * transfer. The merchant must contact their bank to authorise Wix Payments
+     * payouts.
      */
     DEBIT_NOT_AUTHORIZED = "DEBIT_NOT_AUTHORIZED",
     /**
-     * The account holder name on file does not match what the receiving bank has on record.
-     * The merchant must correct the account holder name.
+     * The account holder name on file doesn't match the name the receiving
+     * bank has on record. The merchant must correct the account holder name.
      */
     INCORRECT_ACCOUNT_HOLDER_NAME = "INCORRECT_ACCOUNT_HOLDER_NAME",
     /** The city in the bank account details is invalid for the receiving bank. */
     INVALID_ACCOUNT_DETAILS_CITY = "INVALID_ACCOUNT_DETAILS_CITY",
-    /** The bank account number is invalid (wrong format or does not exist). */
+    /**
+     * The bank account number is invalid. The format is wrong or the account
+     * doesn't exist.
+     */
     INVALID_ACCOUNT_NUMBER = "INVALID_ACCOUNT_NUMBER",
-    /** The payout currency is not supported by the receiving bank account. */
+    /** The payout currency isn't supported by the receiving bank account. */
     INVALID_CURRENCY = "INVALID_CURRENCY",
-    /** The routing number (US) is invalid or does not match the receiving bank. */
+    /** The routing number (US) is invalid or doesn't match the receiving bank. */
     INVALID_ROUTING_NUMBER = "INVALID_ROUTING_NUMBER",
-    /** The sort code (UK) is invalid or does not match the receiving bank. */
+    /** The sort code (UK) is invalid or doesn't match the receiving bank. */
     INVALID_SORT_CODE = "INVALID_SORT_CODE",
     /**
-     * No bank account is on file for the merchant.
-     * The merchant must add bank details before payouts can succeed.
+     * No bank account is on file for the merchant. The merchant must add bank
+     * details before payouts can succeed.
      */
     NO_ACCOUNT = "NO_ACCOUNT",
     /**
-     * A technical error at the bank rail prevented the transfer.
-     * A subsequent payout attempt may succeed.
+     * A technical error at the bank rail prevented the transfer. A subsequent
+     * payout attempt may succeed.
      */
     TECHNICAL_ERROR = "TECHNICAL_ERROR"
 }
@@ -182,23 +202,30 @@ declare enum PayoutFailureCode {
 type PayoutFailureCodeWithLiterals = PayoutFailureCode | 'GENERIC_PAYOUT_FAILURE' | 'ACCOUNT_CLOSED' | 'ACCOUNT_FROZEN' | 'BANK_ACCOUNT_RESTRICTED' | 'BANK_OWNERSHIP_CHANGED' | 'COULD_NOT_PROCESS' | 'DEBIT_NOT_AUTHORIZED' | 'INCORRECT_ACCOUNT_HOLDER_NAME' | 'INVALID_ACCOUNT_DETAILS_CITY' | 'INVALID_ACCOUNT_NUMBER' | 'INVALID_CURRENCY' | 'INVALID_ROUTING_NUMBER' | 'INVALID_SORT_CODE' | 'NO_ACCOUNT' | 'TECHNICAL_ERROR';
 interface ListPayoutsRequest {
     /**
-     * ID of the Wix Payments account whose payouts to list.
+     * ID of the Wix Payments account whose payouts to list. Retrieve account
+     * IDs from the Accounts API.
      * @format GUID
      */
     accountId: string;
     /**
-     * Optional. When omitted, payouts across all profiles of the account are returned.
-     * When set, only payouts belonging to the specified account profile are returned.
+     * ID of the Wix Payments account profile to filter by.
+     *
+     * When omitted, payouts across all profiles of the account are returned.
+     * Retrieve profile IDs from the Accounts API.
      * @format GUID
      */
     accountProfileId?: string | null;
-    /** Optional. Returns only payouts created before this timestamp. */
+    /** Returns only payouts created before this date and time. */
     createdBefore?: Date | null;
-    /** Optional. Returns only payouts created after this timestamp. */
+    /** Returns only payouts created after this date and time. */
     createdAfter?: Date | null;
-    /** Optional. Sorting. Only `created_date` is supported; requests sorting by any other field are rejected with INVALID_ARGUMENT. */
+    /**
+     * Sort order for the result list.
+     *
+     * Supported `fieldName` values: `created_date` (snake_case, not auto-converted). At most 1 sort field is allowed.
+     */
     sort?: Sorting;
-    /** Optional paging. Offset-based. */
+    /** Offset-based paging. */
     paging?: Paging;
 }
 interface Sorting {
@@ -223,7 +250,7 @@ interface Paging {
     offset?: number | null;
 }
 interface ListPayoutsResponse {
-    /** List of payouts. */
+    /** List of retrieved payouts. */
     payouts?: Payout[];
     /** Paging metadata. */
     metadata?: PagingMetadata;
@@ -239,16 +266,17 @@ interface PagingMetadata {
     tooManyToCount?: boolean | null;
 }
 interface CreatePayoutRequest {
-    /** Payout. */
+    /** Payout to create. */
     payout?: Payout;
 }
 interface CreatePayoutResponse {
-    /** Payout. */
+    /** Created payout. */
     payout?: Payout;
 }
 interface GetPayoutRequest {
     /**
-     * ID of the Wix Payments account the payout belongs to.
+     * ID of the Wix Payments account that owns the payout. The payout must
+     * belong to this account. Retrieve account IDs from the Accounts API.
      * @format GUID
      */
     accountId: string;
@@ -259,12 +287,13 @@ interface GetPayoutRequest {
     payoutId: string;
 }
 interface GetPayoutResponse {
-    /** Payout. */
+    /** Retrieved payout. */
     payout?: Payout;
 }
 interface ListPayoutGroupsRequest {
     /**
-     * Wix Payments account identifier.
+     * ID of the Wix Payments account whose payout groups to list. Retrieve
+     * account IDs from the Accounts API.
      * @format GUID
      */
     accountId?: string;
@@ -312,7 +341,8 @@ interface PayoutGroup {
 }
 interface GetPayoutGroupRequest {
     /**
-     * Wix Payments account identifier.
+     * ID of the Wix Payments account that owns the payout group. Retrieve
+     * account IDs from the Accounts API.
      * @format GUID
      */
     accountId?: string;
@@ -334,12 +364,13 @@ interface GetPayoutGroupResponse {
 }
 interface GetPayoutGroupByPayoutIdRequest {
     /**
-     * Wix Payments account identifier.
+     * ID of the Wix Payments account that owns the payout. Retrieve account IDs
+     * from the Accounts API.
      * @format GUID
      */
     accountId?: string;
     /**
-     * Payout identifier.
+     * ID of the payout whose group to retrieve.
      * @format GUID
      */
     payoutId?: string;