Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

submitEventRequest

SubmitEventRequest

Updates the status of a transaction or refund.

The `submitEvent()` function returns a Promise that resolves to `void` when the status of a transaction or refund is updated.

Use this function with the [Payment Provider SPI](https://www.wix.com/velo/reference/spis/wix-payments/payment-provider/introduction) and [HTTP functions](/wix-http-functions) 
to allow payment providers to send your site updates about refunds and transactions.

The status of a transaction or refund is updated based on the properties included in the argument passed to this
function. See the code examples for details.

Learn more about implementing a [Payment Provider Custom Extension](https://support.wix.com/en/article/velo-tutorial-payment-provider-custom-extension-beta).

import wixPaymentProviderBackend from 'wix-payment-provider-backend';
/*
 * Sample submitEventRequest value for a transaction:
 * {
 *   event : {
 *     transaction: {
 *       wixTransactionId: '3e01dda6-134e-4cc9-a37f-ed2bf756c684',
 *       pluginTransactionId: '22001-123123'
 *     }  
 *   }
 * }
 */

export async function updateTransaction(submitEventRequest) {
  try {
    await wixPaymentProviderBackend.submitEvent(submitEventRequest);
    console.log('Transaction updated successfully.');
    return ;
  } catch (error) {
    console.error(error);
    // Handle the error
  }

}

/* Promise resolves to void */

Update the status of a transaction or refund

// submitEventRequest value for a successful transaction:
{
  event: {
    transaction : {
      wixTransactionId: '3e01dda6-134e-4cc9-a37f-ed2bf756c684',
      pluginTransactionId: 'e89b-12d3-a456-42665'
    }
  }
}

Transaction approved

// submitEventRequest value for a declined transaction:

{
  event: {
    transaction: {
      wixTransactionId: '3e01dda6-134e-4cc9-a37f-ed2bf756c684',
      pluginTransactionId: 'e89b-12d3-a456-42665',
      reasonCode: 3012,
      errorCode: 'INSUFFICIENT_FUNDS',
      errorMessage: 'Insufficient funds'
    }
  }
}

Transaction declined

// submitEventRequest value for a pending payment

{
  event: {
    transaction: {
      wixTransactionId: '3e01dda6-134e-4cc9-a37f-ed2bf756c684',
      pluginTransactionId: 'e89b-12d3-a456-42665',
      reasonCode: 5005
    }
  }
}

Transaction pending

// submitEventRequest value for a canceled transaction:

{
   event: {
     transaction: {
       wixTransactionId: '3e01dda6-134e-4cc9-a37f-ed2bf756c684',
       pluginTransactionId: 'e89b-12d3-a456-42665',
       reasonCode: 3030,
       errorCode: 'BUYER_CANCELED',
       errorMessage: 'Buyer canceled the transaction.'
    }
  }
}

Transaction canceled

// submitEventRequest value for a successful refund that was initiated from a site's dashboard:

{
  'event': {
    'refund': {
      'wixTransactionId': '3e01dda6-134e-4cc9-a37f-ed2bf756c684',
      'pluginRefundId': '123123-123123123',
      'amount': '1000',
      'wixRefundId': 'baeb40f5-a48a-4424-cec2-253c9772ad42'
    }
  }
}

Refund succeeded, initiated from a site's dashboard

// submitEventRequest value for a failed refund that was initiated from a site's dashboard:

{
  event: {
    refund: {
      wixTransactionId: '3e01dda6-134e-4cc9-a37f-ed2bf756c684',
      pluginRefundId: '1231231-55432',
      amount: '1000',
      wixRefundId: 'baeb40f5-a48a-4424-cec2-253c9772ad42',
      reasonCode: 3025,
      errorCode: 'INSUFFICIENT_FUNDS_FOR_REFUND',
      errorMessage: 'Insufficient funds for refund.'
    }
  }
}

Refund succeeded, initiated by a payment provider

submitEvent

void

# Introduction
<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
  <b>Developer Preview</b>
  <br/>
  <span>APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</div>

The Payment Provider Backend API allows you to report transaction and refund events when implementing the Payment Provider Custom Extension. 
Use it together with the [Payment Provider SPI](https://www.wix.com/velo/reference/spis/wix-payments/payment-provider/introduction).

Learn more about implementing a [Payment Provider Custom Extension](https://support.wix.com/en/article/velo-tutorial-payment-provider-custom-extension-beta).

submitEvent( )