### Start the Application Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/guides/Create Your Wix App.md Launches the Wix sample application, making it available for testing and integration. Ensure all dependencies are installed and the app is built before running. ```bash npm start ``` -------------------------------- ### Mark Wix App Installation as Finished Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/guides/Authentication.md Send this POST request to the bi-event endpoint to mark your app's installation as complete. This is necessary if your app requires further user setup. Until this is called, the app remains in 'Setup Incomplete' state. ```curl curl -X POST \ https://www.wixapis.com/apps/v1/bi-event \ -H 'Authorization: ' \ -d '{ "eventName": "APP_FINISHED_CONFIGURATION" }' ``` -------------------------------- ### Install Dependencies Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/guides/Create Your Wix App.md Installs all necessary packages for the Wix sample application. Run this command in the root directory of the cloned application. ```bash npm install ``` -------------------------------- ### Build the Application Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/guides/Create Your Wix App.md Compiles the application code, preparing it for deployment or local execution. This command should be run after installing dependencies. ```bash npm build ``` -------------------------------- ### Example Request Body for Payment Plugin Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/provider-platform/docs/payment-plugins.md This is an example of a request body that a Payment Plugin might receive from Wix for account connection. ```json { "credentials": { "clientId": "my_client", "clientSecret": "my_client_secret" }, "country": "US", "currency": "USD", "mode": "sandbox", "wixMerchantId": "000000-0000-0000-0000-000000000000" } ``` -------------------------------- ### Install REST Client Package Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/contacts/docs/dev_dependencies_internal.md Installs the npm package for the Ambassador Contacts v4 REST client. ```bash npm i --save @wix/ambassador-contacts-v4-contact ``` -------------------------------- ### Query Products API Request Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/account-level-apis/guides/AboutAPIKeys.md This example demonstrates how to query products from a specific site. It requires an API key and the site ID. ```bash curl POST \ 'https://www.wixapis.com/stores/v1/products/query' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json, text/plain, */*' \ -H 'Authorization: ' \ -H 'wix-site-id: ' -d '{ "query": { "filter":"{\"paymentStatus\":\"PAID\"}", "sort':"{\"number\": \"desc\"}", "paging": { "limit":"50" } }}' \ ``` -------------------------------- ### Link Example Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/wix-events/Rich Text.md Demonstrates how to include a hyperlink with rel and target attributes within a paragraph. ```html

This is a link

``` -------------------------------- ### Create 'Buy X Get Y Free' Coupon for Wix Stores Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/coupons/docs/usecases.md Use this JSON payload to create a 'Buy X Get Y Free' coupon that applies to any product in Wix Stores. The coupon is active upon creation and has a total usage limit. ```json { "specification": { "name": "BuyXGetY", "code": "ABC", "active": true, "startTime": 1554066000000, "usageLimit": 10, "expirationTime": 1554325199999, "scope": { "namespace": "stores" }, "limitedToOneItem": true, "buyXGetY": { "x": 3, "y": 2 } } } ``` -------------------------------- ### Product Details Response Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/stores-catalog/docs/queryingProductAvailability.md Example JSON response showing the structure of a product's options and choices, including their stock status. ```json { "productOptions": [ { "optionType": "drop_down", "name": "Size", "choices": [ { "value": "S", "description": "S", "inStock": true, "visible": true }, { "value": "M", "description": "M", "inStock": true, "visible": true }, { "value": "L", "description": "L", "inStock": true, "visible": true } ] }, { "optionType": "color", "name": "Color", "choices": [ { "value": "#FF0000", "description": "Red", "inStock": true, "visible": true }, { "value": "#00FF00", "description": "Green", "inStock": true, "visible": true }, { "value": "#00000FF", "description": "Blue", "inStock": true, "visible": true } ] } ] } ``` -------------------------------- ### Locations Testkit Environment Setup Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/locations/docs/README.md Set up the test environment for locations using the LocationsTestkit and GrpcManagedService. ```scala val locationsTestkit = new LocationsTestkit() val embeddedGrpcServer = new GrpcManagedService(port = grpcPort, locationsTestkit.locationsTestkit) ``` -------------------------------- ### Bold Text Example Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/wix-events/Rich Text.md Demonstrates how to format text as bold using the strong tag within a paragraph. ```html

This is bolded text

``` -------------------------------- ### Numbered List Example Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/wix-events/Rich Text.md Shows how to create a numbered list using the ol and li tags within a paragraph. ```html

This is a numbered list:

  1. First
  2. Second
  3. Third
``` -------------------------------- ### Cursor Paging Request Example Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/guides/API Query Language.md Shows how to use a 'next' cursor from a previous response to request the subsequent page of results in cursor paging. ```json { "query": { "cursorPaging": { "cursor": "eyJmaWx0ZXIiOnsiJGFuZCI6W3sibGFuZ3VhZ2UiOnsiJGluIjpbImVuIiwiaGUiXX19LHsic3RhdHVzIjoicHVibGlzaGVkIn1dfSwidmFsdWUiOnsiaXNQaW5uZWQiOmZhbHNlLCJmaXJzdFB1Ymxpc2hlZERhdGUiOiIyMDIyLTA2LTAyVDA2OjQ2OjAyLjgwM1oifSwib3JkZXIiOnsiaXNQaW5uZWQiOi0xLCJmaXJzdFB1Ymxpc2hlZERhdGUiOi0xLCJpZCI6LTF9fQ" } } } ``` -------------------------------- ### Cursor Paging Response Example Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/guides/API Query Language.md Illustrates a typical response object when using cursor paging, including metadata and cursor strings for navigation. ```json { "pagingMetadata": { "count": 10, "offset": 0, "cursors": { "next": "eyJmaWx0ZXIiOnsiJGFuZCI6W3sibGFuZ3VhZ2UiOnsiJGluIjpbImVuIiwiaGUiXX19LHsic3RhdHVzIjoicHVibGlzaGVkIn1dfSwidmFsdWUiOnsiaXNQaW5uZWQiOmZhbHNlLCJmaXJzdFB1Ymxpc2hlZERhdGUiOiIyMDIyLTA2LTAyVDA2OjQ2OjAyLjgwMloifSwib3JkZXIiOnsiaXNQaW5uZWQiOi0xLCJmaXJzdFB1Ymxpc2hlZERhdGUiOi0xLCJpZCI6LTF9fQ==" } } } ``` -------------------------------- ### Compound Filter with $or Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/bookings---bookings-service/com/wix/bookings/api/v1/docs/sort_and_filter.md This example shows a compound query that returns entities where 'status' is 'NEW' and either 'Quantity' is less than 30 or 'itemName' starts with 'P'. ```JSON { "query": { "filter":{ "status": "NEW", "$or": [{"Quantity": {"$lt": 30}}, {"itemName": {"$startsWith": "P"}}] } } } ``` -------------------------------- ### Paging List Results with Offset (SDK) Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/guides/Pagination.md Specify offset-based paging options in the SDK call's options object, using 'limit' and 'offset'. Example shows fetching 20 items starting from the beginning. ```javascript { "options": { "paging": { "limit": 20, "offset": 0 }, } } ``` -------------------------------- ### Create Site Folder API Request Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/account-level-apis/guides/AboutAPIKeys.md Use this example to create a new folder for Wix sites. It requires an API key and account ID for authentication. ```bash curl POST \ 'https://www.wixapis.com/site-folders/v2/folders \ -H 'Authorization: ' \ -H 'wix-account-id: ' { "folder": {"name": "My Folder", "parentId": "root"}} \ ``` -------------------------------- ### API Request Headers Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/account-level-apis/guides/AboutAPIKeys.md This example shows the required headers for making API requests using an API key. Ensure you include the Authorization, wix-account-id, and wix-site-id headers as needed. ```bash curl \ ‘’ \ -H 'Authorization: ' \ -H 'wix-account-id: ' \ -H 'wix-site-id: ' \ ``` -------------------------------- ### On Ready Event Listener for SDK Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/app-management/EmbeddedScriptSDK.md This code ensures that the SDK is fully initiated before registering listeners. It uses a fallback mechanism with `window.onWixDevelopersAnalyticsReady` if the SDK is not immediately available. ```javascript function registerListener(){ window.wixDevelopersAnalytics.register('head', (eventName, eventParams) => console.log('wix dev head', eventName, eventParams)); } window.wixDevelopersAnalytics ? registerListener() : window.onWixDevelopersAnalyticsReady = function() { registerListener(); } ``` -------------------------------- ### Sort by Slot Start Date Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/bookingsavailabilitycalendar/docs/cal-avail-sort-and-filter.md Use this JSON object to specify sorting by the slot's start date in ascending order. Currently, only sorting by `slot.startDate` is supported. ```json "sort" : { "fieldName":"sortField1", "order":"ASC" } ``` -------------------------------- ### Get or Create Conversation Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/conversations/docs/example-flows.md Use this JSON payload to get an existing conversation or create a new one for a given contact. Set the 'participantId.contactId' to the contact's ID. ```json { "participantId": { "contactId": "4e600edc-db48-5260-9d04-7ea5c3e5fffd" } } ``` -------------------------------- ### Initiate Payment Request with Credentials On File Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/provider-platform/docs/making-payments.md Use this cURL command to initiate a payment request to Wix, including credentials on file for off-session payments. Ensure all required fields like merchant IDs, transaction details, and payment method information are correctly populated. ```bash curl -X POST https://psp.example.com/sale \ -H 'Content-Type: application/json' \ -H 'JWT=ai0zIQqt71bmnkgEJ1CRJchjKJup' \ -d '{ \ "wixMerchantId": "333333-3333-3333-3333-333333333333", \ "wixTransactionId": "000000-0000-0000-0000-000000000000", \ "paymentMethod": "creditCard", \ "merchantCredentials": { \ "client_id": "MerchantClientId", \ "client_secret": "MerchantClientSecret" \ }, \ "order": { \ "id": "11111111-1111-1111-1111-111111111111", \ "description": { \ "totalAmount": 1000, \ "currency": "USD", \ "items": [ \ { \ "id": "it_1", \ "name": "Digital camera", \ "quantity": 1, \ "price": 1000, \ "description": "Portable digital camera", \ "category": "physical" \ } \ ], \ "buyerInfo": { \ "buyerId": "ffc0a971-60cb-4c63-8016-39b1bce41e8d", \ "buyerLanguage": "en" \ } \ }, \ "returnUrls": { \ "successUrl": "https://merchant.com/success", \ "errorUrl": "https://merchant.com/error", \ "cancelUrl": "https://merchant.com/cancel", \ "pendingUrl": "https://merchant.com/pending" \ } \ }, \ "installments": 1, \ "mode": "live", \ "paymentMethodData": { \ "card": { \ "number": "4111111111111111", \ "year": 2030, \ "month": 12, \ "cvv": "777", \ "holderName": "John Smith" \ } \ }, \ "setupCredentialsOnFile": { \ "offSession": true \ } \ }' ``` -------------------------------- ### Example Response: List Marketing Tags Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/marketing-tags/docs/Flow.md An example JSON response from the List Marketing Tags endpoint, showing the structure of embedded tags including their IDs, types, enabled status, and associated domain information. ```json {"tags": [ { "id": "994ba324-682c-4d81-abd6-84e4be44ba3c", "type": "GOOGLE_ADS", "enabled": true, "google_ads": { "domain": "old-domain.com", "tracking_id": "AW-672490861" } }, { "id": "123ba321-678c-4d81-abd6-84e4be44ba3c", "type": "FACEBOOK_PIXEL", "enabled": true, "facebook_pixel": { "domain": "old-domain.com", "tracking_id": "123456789" } } ]} ``` -------------------------------- ### Query Products API Request Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/guides/AboutAPIKeys.md Example request to retrieve a list of products from a Wix site using the Stores API. Requires an API key and site ID. ```sh curl POST \ 'https://www.wixapis.com/stores/v1/products/query' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json, text/plain, */*' \ -H 'Authorization: ' \ -H 'wix-site-id: ' \ -d '{ "query": { "filter": "{\"paymentStatus\":\"PAID\"}", "sort": "{\"number\": \"desc\"}", "paging": { "limit": "50" } } }' ``` -------------------------------- ### Initialize Site Properties Testkit Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/site-properties/docs/README.md Set up the Site Properties testkit instance. Ensure the port matches the registered service port and configure API Gateway testkit and notification enablement as needed. ```scala val sitePropertiesTestkit = new SitePropertiesFullTestkit( port = 9904, // doesn't have to be 9904 but to be equal to the port you register the service apiGatewayFullTestkit = apiGatewayTestkit, // needs ApiGatewayFullTestkit to get the context and identities enableNotifications = true // if greyhound notifications on changes needed ) ``` -------------------------------- ### Filter by Namespace Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/site-list/docs/filter-and-sort.md Filter sites by their namespace, for example, 'WIX'. ```json { namespace: 'WIX' } ``` -------------------------------- ### Initialize Members gRPC Client (Bootstrap) Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/members/docs/Migration-Guide.md Example for initializing a gRPC client for Members service during bootstrap. Requires a Clients object and specifies the gRPC channel and authority. ```scala @Bean def membersNgClient(clients: Clients): MembersWithCallScope.MembersGrpcClient = MembersWithCallScope.stub(clients.grpcChannel(GrpcProxyUrl), _.withAuthority("com.wixpress.members.members-ng-api")) ``` -------------------------------- ### Get a cart Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/cart/docs/intro.md Retrieves the details of a specific shopping cart. ```APIDOC ## GET /wix-ecommerce/cart ### Description Retrieves the details of a specific shopping cart. ### Method GET ### Endpoint /wix-ecommerce/cart ``` -------------------------------- ### Initial Search Request with Cursor Paging Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/guides/Pagination.md Use `cursorPaging` with a `limit` to retrieve the first set of search results. This example requests 10 payment links. ```json { "search": { "cursorPaging": { "limit": 10 } } } ``` -------------------------------- ### Create 'Buy X Get Y Free' Coupon for Wix Events Tickets Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/coupons/docs/usecases.md Configure a 'Buy X Get Y Free' coupon for all tickets in Wix Events using this JSON. The coupon details include its code, activation status, usage limits, and validity dates. ```json { "specification": { "name": "BuyXGetY", "code": "ABC", "active": true, "startTime": 1554066000000, "usageLimit": 10, "expirationTime": 1554325199999, "scope": { "namespace": "events", "group": { "name": "ticket" } }, "limitedToOneItem": true, "buyXGetY": { "x": 3, "y": 2 } } } ``` -------------------------------- ### Subscription Pricing Model Example Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/pricing-plans/docs/PublicIntro.md Illustrates a subscription-based pricing model with recurring monthly payments for a 1-year duration. Use this for plans with recurring billing cycles. ```javascript "pricing": { "subscription": { "cycleDuration": { // Payment recurs every month "count": 1, "unit": "MONTH" }, // for 12 times "cycleCount": 12 }, "prices": [{ "duration": { "cycleFrom": 1, "numberOfCycles": 12 }, "price": { "subtotal": "25", "discount": "0", "total": "25", "currency": "USD" } }] }, ... "currentCycle": { "index": 3, "startedDate": "2022-03-01T13:45:53.129Z", "endedDate": "2022-04-01T13:45:53.129Z" }, ``` -------------------------------- ### Create 'Buy X Get Y Free' Coupon for Specific Wix Bookings Service Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/coupons/docs/usecases.md This JSON payload configures a 'Buy X Get Y Free' coupon for a specific service within Wix Bookings. It includes details like the coupon code, active status, usage limits, and validity period. ```json { "specification": { "name": "BuyXGetY", "code": "ABC", "active": true, "startTime": 1554066000000, "usageLimit": 10, "expirationTime": 1554325199999, "scope": { "namespace": "bookings", "group": { "name": "service", "entityId": "e599b709-1a8b-478a-ae80-26192944aef5" } }, "limitedToOneItem": true, "buyXGetY": { "x": 3, "y": 2 } } } ``` -------------------------------- ### Initiate Payment with Network Reference Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/provider-platform/docs/making-payments.md Initiate a payment transaction with Wix using a network reference for the payment method. This is used for recurring payments or when payment details are stored. ```bash curl -X POST https://psp.example.com/sale \ -H 'Content-Type: application/json' \ -H 'JWT=ai0zIQqt71bmnkgEJ1CRJchjKJup' \ -d '{ "wixMerchantId": "333333-3333-3333-3333-333333333333", "wixTransactionId": "000000-0000-0000-0000-000000000000", "paymentMethod": "creditCard", "merchantCredentials": { "client_id": "MerchantClientId", "client_secret": "MerchantClientSecret" }, "order": { "id": "11111111-1111-1111-1111-111111111111", "description": { "totalAmount": 1000, "currency": "USD", "items": [ { "id": "it_1", "name": "Digital camera", "quantity": 1, "price": 1000, "description": "Portable digital camera", "category": "physical" } ], "buyerInfo": { "buyerId": "ffc0a971-60cb-4c63-8016-39b1bce41e8d", "buyerLanguage": "en" } }, "returnUrls": { "successUrl": "https://merchant.com/success", "errorUrl": "https://merchant.com/error", "cancelUrl": "https://merchant.com/cancel", "pendingUrl": "https://merchant.com/pending" } }, "installments": 1, "mode": "live", "paymentMethodData": { "reference": { "token": "PMR-e89b-12d3-a456-42665" } }, "offSession": true }' ``` -------------------------------- ### Underlined Text Example Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/wix-events/Rich Text.md Demonstrates how to format text as underlined using the u tag within a paragraph. ```html

This is underlined text

``` -------------------------------- ### Connect Account Request (Numeric and Boolean Credentials) Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/provider-platform/docs/connecting-account.md Wix sends a POST request including credentials with numeric and boolean values, represented as strings. ```bash curl -X POST https://psp.example.com/connect \ -H 'Content-Type: application/json' \ -H 'Digest: JWT=ai0zIQqt71bmnkgEJ1CRJchjKJup' \ -d '{ "credentials": { "client_id": "MerchantClientId", "client_secret": "MerchantClientSecret", "price_includes_tax": "true", "tax_percentage": "20" }, "country": "US", "currency": "USD", "mode": "live", "wixMerchantId": "000000-0000-0000-0000-000000000000" }' ``` -------------------------------- ### Create Folder API Request Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/guides/AboutAPIKeys.md Example request to create a new folder for Wix sites using the Site Folders API. Requires an API key and account ID. ```sh curl POST \ 'https://www.wixapis.com/site-folders/v2/folders' \ -H 'Authorization: ' \ -H 'wix-account-id: ' \ -d '{ "folder": { "name": "My Folder", "parentId": "root" } }' ``` -------------------------------- ### Italic Text Example Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/wix-events/Rich Text.md Demonstrates how to format text as italic using the em tag within a paragraph. ```html

This is italic text

``` -------------------------------- ### Connect Account Request (Basic) Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/provider-platform/docs/connecting-account.md Wix sends a POST request to the Payment Plugin's connect endpoint with merchant-provided credentials, country, currency, and mode. ```bash curl -X POST https://psp.example.com/connect \ -H 'Content-Type: application/json' \ -H 'Digest: JWT=ai0zIQqt71bmnkgEJ1CRJchjKJup' \ -d '{ "credentials": { "client_id": "MerchantClientId", "client_secret": "MerchantClientSecret" }, "country": "US", "currency": "USD", "mode": "live", "wixMerchantId": "000000-0000-0000-0000-000000000000" }' ``` -------------------------------- ### Example of Triggered Notification Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/notifications/docs/createNotification.md Shows how a notification appears to a recipient after dynamic placeholders have been replaced with actual values. ```text Title: Item delivered: television. Message: Sally Jones has received a television delivery. ``` -------------------------------- ### Initiate Partial Refund (Second Refund) Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/provider-platform/docs/refunding-payments.md Wix initiates a second partial refund for the same transaction. The process mirrors the first refund initiation, with a different refundAmount. ```bash curl -X POST https://psp.example.com/refund \ -H 'JWT=ai0zIQqt71bmnkgEJ1CRJchjKJup' \ -H 'Content-Type: application/json' \ -d '{ \ "wixTransactionId": "11111111-1111-1111-1111-111111111111", \ "wixRefundId": "33333333-3333-3333-3333-333333333333" \ "pluginTransactionId": "000000-0000-0000-0000-000000000000", \ "merchantCredentials": { \ "client_id": "MerchantClientId", \ "client_secret": "MerchantClientSecret" \ }, \ "refundAmount": 400, \ "mode": "live", \ "reason": "REQUESTED_BY_CUSTOMER" \ }' ``` -------------------------------- ### Initialize Members gRPC Client (Loom) Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/members/docs/Migration-Guide.md Example for initializing a gRPC client for Members service using Loom. Ensure the correct authority is set. ```scala val membersNgClient = MembersWithCallScope.stub(grpcChannel, _.withAuthority("com.wixpress.members.members-ng-api")) ``` -------------------------------- ### Bulleted List Example Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/wix-events/Rich Text.md Shows how to create a bulleted list using the ul and li tags within a paragraph. ```html

This is a bulleted list:

  • One
  • Two
  • Three
``` -------------------------------- ### Example Trigger Payload Schema Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/triggered-events/docs/internal-creating-new-trigger.md This JSON schema defines the structure for a trigger payload, including properties like form ID, form name, and submitter ID. It specifies data types, formats (like UUID), titles for user display, default values, examples, and identifies a 'submitterId' as a 'contact' identity type. It also marks all properties as required and allows additional properties. ```json { "$schema": "http://json-schema.org/draft-07/schema", "type": "object", "title": "Visitor submits a form Payload Schema", "description": "The schema of the payload that is part of the triggered event", "default": {}, "examples": [ { "formId": "60d2cd50-1047-4164-884d-8c24fbda84bb", "formName": "My Cool Form", "submitterId": "1234-abcd-1234-abcd" } ], "properties": { "formId": { "$id": "#/properties/formId", "type": "string", "format": "uuid", "title": "Form ID", "description": "The form identifier", "default": "", "examples": ["60d2cd50-1047-4164-884d-8c24fbda84bb"] }, "formName": { "$id": "#/properties/formName", "type": "string", "title": "Form Name", "description": "The form display name", "default": "", "examples": ["My Form"] }, "submitterId": { "$id": "#/properties/submitterId", "type": "string", "format": "uuid", "title": "Submitter Id", "description": "The Id of the contact which submitted the form", "default": "", "identityType": "contact" } }, "required": ["formId", "formName", "submitterId"], "additionalProperties": true } ``` -------------------------------- ### Initiate Partial Refund (Successful) Source: https://github.com/wix-incubator/wix-rest-docs/blob/master/all/guides/provider-platform/docs/refunding-payments.md Wix calls the Refund Transaction API to initiate a partial refund. This example shows a successful partial refund of $5 US. ```bash curl -X POST https://psp.example.com/refund \ -H 'JWT=ai0zIQqt71bmnkgEJ1CRJchjKJup' \ -H 'Content-Type: application/json' \ -d '{ "wixTransactionId": "11111111-1111-1111-1111-111111111111", "wixRefundId": "33333333-3333-3333-3333-333333333333" "pluginTransactionId": "000000-0000-0000-0000-000000000000", "merchantCredentials": { "client_id": "MerchantClientId", "client_secret": "MerchantClientSecret" }, "refundAmount": 500, "mode": "live", "reason": "REQUESTED_BY_CUSTOMER" } }' ```