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).