Search API library /

Generate a test token to explore our APIs

Wix Payments

Wix enables site owners to collect payments from online stores, bookings, events and more on their site.

Cashier Pay

Payment Event Webhook

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

Supported Wix Apps/Business Solutions: Wix Stores and Wix Bookings

Permissions

The API requires Cashier > Read Payments permission

Event Body

The event's data is received as a JSON Web Token (JWT). Make sure to verify that the data was received by Wix - read more about it in the Webhooks article.

Payload

NAME

TYPE

DESCRIPTION

eventType

string

One of UNDEFINED, TRANSACTION_STATUS_CHANGED, REFUND_STATUS_CHANGED.

Event type

transactionStatusChangedEvent

object

refundStatusChangedEvent

object

id

string

Unique event ID

eventTime

string

Event timestamp

wixAppId

string

ID of the Wix application that triggered this event.

Supported Wix Applications:

<ul><li>Wix Stores: 1380b703-ce81-ff05-f115-39571d94dfcd</li><li>Wix Bookings: 13d21c63-b5ec-5912-8397-c3a5ddb27a97</li></ul>

wixAppInstanceId

string

Unique ID assigned to each Wix app in each site

Payments

Payments

About This API

Use the Payments API to access all the transactions that were processed through Wix Business Solutions. Relevant apps include:

  • Stores
  • Bookings
  • Events
  • Music
  • Video
  • Hotels

Use this REST API to get a user’s transactions from their Wix site and integrate them into the user’s account in your platform.

Transaction Object

Attributes

NAME

TYPE

DESCRIPTION

provider

string

Transaction provider (required)

appInstanceId

string

App Instance ID (required)

paymentMethod

string

Transaction payment method (required)

cashierError

object

cashier transaction error (optional)

amount

object

amount and currency of transactions (required)

refundability

object

ability to do refund on transaction

order

object

view of connected order snapshot (required)

status

string

One of INITIALIZED, IN_PROCESS, APPROVED, PENDING, PENDING_MERCHANT, PENDING_BUYER, BUYER_CANCELED, TIMEOUT, REFUND, PARTIAL_REFUND, VOID, CHARGE_BACK, EXPIRED, DECLINED, FAILED, COMPLETED_FUNDS_HELD, TPA_CANCELED, OFFLINE, DISPUTE, UNDEFINED.

transaction status (required)

createdAt

string

Transaction creation date

type

string

One of SALE, RECURRING.

appId

string

Application ID (required)

paymentMethodData

object

Map with payment method data

transactionId

string

Transaction ID (required)

Transactions List

Use this REST API to collect some or all of a user’s transactions from their Wix site and integrate them into the user’s account in your platform.

Permissions

The API requires Wix Payments > Read Transactions permission

GET

https://cashier.wix.com/_api/payment-services-web/merchant/v2/transactions

Request Headers

This API requires an authentication header - pass the access token from the OAuth installation flow.

Query Params

NAME

TYPE

DESCRIPTION

from

string

Collect transactions created from this date forward, in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ). Dependent on the “to” parameter

to

string

Collect transactions created until this date, in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ). Dependent on the “from” parameter

fromUpdated

string

Collect transactions updated from this date forward, in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ). Dependent on the “toUpdated” parameter

toUpdated

string

Collect transactions updated until this date, in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZZ). Dependent on the “forUpdated” parameter

appInstanceId

string

Collect transactions completed from a specific app instance ID

paymentMethod

string

Collect transactions completed with a specific payment method

offset

integer

Offset for pagination query. For use with the “limit” parameter

limit

integer

Limit for pagination query. For use with the “offset” parameter

order

string

Sort date and amount fields using this format: field1:asc, field2:desc

status

array

Collect transactions with a specific transaction status

paymentProvider

string

Collect transactions completed by a specific payment provider (e.g., Paypal, Mercadopago, etc.)

currency

string

Collect transactions completed in a specific currency

Status/Error Codes

The response will include an HTTP status code.

Response Object

NAME

TYPE

DESCRIPTION

transactions

array<object>

List of transactions

pagination

object

total number of transactions with filters applied

Examples

Example of Transactions List request

curl -X GET \
   'https://cashier.wix.com/_api/payment-services-web/merchant/v2/transactions \
   -H 'Authorization: <AUTH>'