> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetGpvPayout # Package: earnings # Namespace: RevShareGpvPayouts # Method link: https://dev.wix.com/docs/api-reference/account-level/studio-workspace/earnings/gpv-payout-v1/get-gpv-payout.md ## Permission Scopes: SCOPE.PARTNERS.REVSHARE: SCOPE.PARTNERS.REVSHARE ## Introduction Retrieves a GPV payout by ID. Reads are scoped to the caller's partner account. --- ## REST API ### Schema ``` Method: getGpvPayout Description: Retrieves a GPV payout by GUID. Reads are scoped to the caller's partner account. URL: https://www.wixapis.com/partners/revshare/v1/gpv-payouts/{gpvPayoutId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: gpvPayoutId Method parameters: param name: gpvPayoutId | type: none | required: true Return type: GetGpvPayoutResponse - name: gpvPayout | type: GpvPayout | description: The requested GpvPayout. - name: id | type: string | description: GpvPayout GUID. | read-only: true | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the GpvPayout is updated. To prevent conflicting changes, the current revision must be passed when updating the GpvPayout. | read-only: true | validation: format int64 - name: createdDate | type: string | description: Date and time the payout record was created in Wix's systems. This is record bookkeeping, not the day the volume was processed. For that, use `transactionDate`. | read-only: true | validation: format date-time - name: updatedDate | type: string | description: Date and time the payout record was last updated, for example when more volume accrued for the day. Not the day the volume was processed. For that, use `transactionDate`. | read-only: true | validation: format date-time - name: transactionDate | type: string | description: Day the payout is attributed to. Wix maintains a single GpvPayout per `transactionDate`, updating it as volume accrues, so payouts are returned as a flat list of days. Group them client-side if you need monthly totals. | validation: format date-time - name: gpv | type: number | description: Total gross payment volume (GPV) processed across the partner's sites for the transaction date, in USD. Labeled `Client sales` in the Wix Studio dashboard. | validation: format double - name: amount | type: number | description: Amount earned by the partner for this payout, in USD. Calculated as `gpv` multiplied by `paymentRevenueSharePercent`, divided by 100. | validation: format double - name: paymentRevenueSharePercent | type: number | description: Revenue-share rate applied to `gpv` to calculate `amount`. The value is a fractional percent: `0.05` means 0.05% (not 5%), so `amount` = `gpv` * `paymentRevenueSharePercent` / 100. Wix sets the rate automatically based on daily GPV: `0.05` (0.05%) when daily GPV is at or below `2000` USD, and `0.1` (0.1%) when daily GPV is above `2000` USD. | validation: minimum 0, maximum 100, format double - name: sitesGpv | type: array | description: The sites whose GPV contributed to this payout, up to 200 sites, each with the volume it contributed. The Wix Studio dashboard shows only the number of sites and the first few site names, so this breakdown is more detailed than the dashboard's. | validation: maxItems 200 - name: metaSiteId | type: string | description: GUID of the site. | validation: format GUID - name: gpvInUsd | type: number | description: Gross payment volume processed on the site, in USD. - name: siteName | type: string | description: Name of the site, captured when Wix last calculated this payout. A payout's day is recalculated while volume is still accruing, so a site renamed during that window can show the newer name; once the day is settled the name stops changing. Truncated to 200 UTF-16 code units, so a name using emoji or a non-Latin script can be cut shorter than 200 visible characters. The cut never splits a surrogate pair, but it can split a longer sequence such as an emoji built from several joined characters. Best effort - it may be empty, and it's always empty on payouts created before Wix started capturing it. Use `metaSiteId` as the stable key. | read-only: true | validation: maxLength 200 - name: invoiceId | type: string | description: GUID of the invoice this payout was included in. Empty until the payout is invoiced. This is the reference code of the partner's invoice. To resolve it, query the Materialized Invoices API for the materialized invoice whose `invoicesRefCodes` contains this value, and read that invoice's `status` to see whether it was paid. ``` ### Examples ### Get Gpv Payout Retrieves a single GPV payout by ID ```curl curl -X GET \ 'https://www.wixapis.com/v1/gpv-payouts/8046df3c-7575-4098-a5ab-c91ad8f33c47' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.revshareGpvPayouts.revshareGpvPayouts.getGpvPayout(gpvPayoutId) Description: Retrieves a GPV payout by GUID. Reads are scoped to the caller's partner account. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: gpvPayoutId Method parameters: param name: gpvPayoutId | type: string | description: GUID of the GpvPayout to retrieve. | required: true | validation: format GUID Return type: PROMISE - name: _id | type: string | description: GpvPayout GUID. | read-only: true | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the GpvPayout is updated. To prevent conflicting changes, the current revision must be passed when updating the GpvPayout. | read-only: true | validation: format int64 - name: _createdDate | type: Date | description: Date and time the payout record was created in Wix's systems. This is record bookkeeping, not the day the volume was processed. For that, use `transactionDate`. | read-only: true - name: _updatedDate | type: Date | description: Date and time the payout record was last updated, for example when more volume accrued for the day. Not the day the volume was processed. For that, use `transactionDate`. | read-only: true - name: transactionDate | type: Date | description: Day the payout is attributed to. Wix maintains a single GpvPayout per `transactionDate`, updating it as volume accrues, so payouts are returned as a flat list of days. Group them client-side if you need monthly totals. - name: gpv | type: number | description: Total gross payment volume (GPV) processed across the partner's sites for the transaction date, in USD. Labeled `Client sales` in the Wix Studio dashboard. - name: amount | type: number | description: Amount earned by the partner for this payout, in USD. Calculated as `gpv` multiplied by `paymentRevenueSharePercent`, divided by 100. - name: paymentRevenueSharePercent | type: number | description: Revenue-share rate applied to `gpv` to calculate `amount`. The value is a fractional percent: `0.05` means 0.05% (not 5%), so `amount` = `gpv` * `paymentRevenueSharePercent` / 100. Wix sets the rate automatically based on daily GPV: `0.05` (0.05%) when daily GPV is at or below `2000` USD, and `0.1` (0.1%) when daily GPV is above `2000` USD. | validation: minimum 0, maximum 100 - name: sitesGpv | type: array | description: The sites whose GPV contributed to this payout, up to 200 sites, each with the volume it contributed. The Wix Studio dashboard shows only the number of sites and the first few site names, so this breakdown is more detailed than the dashboard's. | validation: maxItems 200 - name: metaSiteId | type: string | description: GUID of the site. | validation: format GUID - name: gpvInUsd | type: number | description: Gross payment volume processed on the site, in USD. - name: siteName | type: string | description: Name of the site, captured when Wix last calculated this payout. A payout's day is recalculated while volume is still accruing, so a site renamed during that window can show the newer name; once the day is settled the name stops changing. Truncated to 200 UTF-16 code units, so a name using emoji or a non-Latin script can be cut shorter than 200 visible characters. The cut never splits a surrogate pair, but it can split a longer sequence such as an emoji built from several joined characters. Best effort - it may be empty, and it's always empty on payouts created before Wix started capturing it. Use `metaSiteId` as the stable key. | read-only: true | validation: maxLength 200 - name: invoiceId | type: string | description: GUID of the invoice this payout was included in. Empty until the payout is invoiced. This is the reference code of the partner's invoice. To resolve it, query the Materialized Invoices API for the materialized invoice whose `invoicesRefCodes` contains this value, and read that invoice's `status` to see whether it was paid. ``` ### Examples ### Get GPV Payout Retrieves a single GPV payout by ID ```javascript import { wixPartnersRevshareV1GpvPayout } from "@wix/dev"; const gpvPayoutId = "8046df3c-7575-4098-a5ab-c91ad8f33c47"; async function getGpvPayout() { const response = await wixPartnersRevshareV1GpvPayout.getGpvPayout(gpvPayoutId); } /* Promise resolves to: { "gpvPayout": { "_id": "8046df3c-7575-4098-a5ab-c91ad8f33c47", "revision": "4", "_createdDate": "2025-02-01T03:12:08.451Z", "_updatedDate": "2025-02-12T06:45:22.119Z", "transactionDate": "2025-01-01T00:00:00.000Z", "gpv": 8450.75, "amount": 8.45, "paymentRevenueSharePercent": 0.1, "sitesGpv": [ { "metaSiteId": "f1a2b3c4-d5e6-4789-9abc-1234567890ab", "siteName": "Northgate Dental", "gpvInUsd": 6200.5 }, { "metaSiteId": "a9b8c7d6-e5f4-4321-8765-0fedcba98765", "gpvInUsd": 2250.25 } ], "invoiceId": "3c2b1a09-8f7e-4d6c-9b5a-1e2f3a4b5c6d" } } */ ``` ### getGpvPayout (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { revshareGpvPayouts } from '@wix/revshare-gpv-payouts'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { revshareGpvPayouts }, // Include the auth strategy and host as relevant }); async function getGpvPayout(gpvPayoutId) { const response = await myWixClient.revshareGpvPayouts.getGpvPayout(gpvPayoutId); }; ``` ---