Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Payment Event Webhook

This webhook is triggered whenever a payment transaction is updated (including refunds) via specific Wix business solutions.

Permissions

This webhook requires the Read Payments permission scope.

Event Body

Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.

Event Data

NAME
TYPE
DESCRIPTION
eventType

string

Supported values: UNDEFINED, TRANSACTION_STATUS_CHANGED, REFUND_STATUS_CHANGED, RECURRING_PAYMENT_STATUS_CHANGED, TRANSACTION_UPDATED.

Event type.

ONE OF:
transactionStatusChangedEvent

object

refundStatusChangedEvent

object

transactionUpdatedEvent

object

recurringPaymentStatusChangedEvent

object

managingWixAppId

string

ID of Wix app that mediated between Wix Payments and the Wix app that triggered the event (if relevant).

id

string

Unique event ID.

eventTime

string

Event timestamp

wixAppId

string

ID of the Wix app that triggered this event.

wixAppInstanceId

string

Unique ID assigned to each Wix app in each site.

Was this helpful?

Example 1

The data payload will include the following as an encoded JWT:

Event Body

json

1{
2 "data": {
3 "eventType": "<event-type>",
4 "instanceId": "<app-instance-id>",
5 "data": "<stringified-JSON>"
6 }
7}

The parsed data will include:

Sample Data

json

1
2{
3 "wixAppId": "1380b703-ce81-ff05-f115-39571d94dfcd",
4 "wixAppInstanceId": "13eb02d1-c5a6-deb6-c525-bc6de1d361f8",
5 "eventTime": "2019-06-11T14:43:09.907Z",
6 "eventType": "TRANSACTION_STATUS_CHANGED",
7 "id": "b139411a-3f7a-43f8-915d-61b40f5a0172",
8 "transactionStatusChangedEvent": {
9 "order": {
10 "additionalCharges": {"tax": 10.71},
11 "wixAppOrderId": "fb008df2-fb96-4b59-bf7b-6d1258f19480",
12 "createdAt": "2019-06-11T14:43:09.019Z",
13 "id": "40abdafc-0952-4bbd-b339-572cb2960ba8",
14 "items": [ {
15 "id": "437a5caf-e2db-3538-c7c9-8628070ab4c6",
16 "name": "Horse Power By Anderson Bean -Men's Cognac Filet fo Fish Cowboy Boots Size:10 | Width:D",
17 "price": 205,
18 "quantity": 1
19 }],
20 "itemsTotalCount": 1,
21 "shippingAddress": {
22 "addressLine2": "00000 Some Street Rd",
23 "city": "Chicago",
24 "country": "US",
25 "postalCode": "00000",
26 "subdivision": "IL"
27 },
28 "shippingAddressContacts": {
29 "email": "johndoe@example.com",
30 "firstName": "John",
31 "lastName": "Doe",
32 "phone": "012345678"
33 }
34 },
35 "transaction": {
36 "amount": {
37 "amount": 215.71,
38 "currency": "USD"
39 },
40 "billingAddress": {
41 "addressLine2": "00000 Some Street Rd",
42 "city": "Chicago",
43 "country": "US",
44 "postalCode": "00000",
45 "subdivision": "IL"
46 },
47 "billingAddressContacts": {
48 "email": "johndoe@example.com",
49 "firstName": "John",
50 "lastName": "Doe",
51 "phone": "012345678"
52 },
53 "createdAt": "2019-06-11T14:43:09.061Z",
54 "creditCardPaymentMethodData": {
55 "maskedCreditCard": "2710",
56 "network": "MASTERCARD"
57 },
58 "id": "6a196649-67d2-4353-8d81-fc0fabdbc54d",
59 "paymentMethod": "creditCard",
60 "paymentProvider": "com.square",
61 "status": "APPROVED"
62 }
63 }
64}
Example 2