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

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.

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

This endpoint requires the Wix Payments > Read Transactions permission scope.

GET

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

Query Params

NAME
TYPE
DESCRIPTION
from

string

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

to

string

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

fromUpdated

string

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

toUpdated

string

Collect transactions updated until this date, in ISO8601 format (yyyy-MM-ddTHHundefinedss.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

Response Object

List Transactions Response

NAME
TYPE
DESCRIPTION
transactions

Array<object>

List of transactions

pagination

object

total number of transactions with filters applied

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Example of Transactions List request

Request

curl

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

Response

json

1{
2 "transactions": [
3 {
4 "transactionId": "e61aa3b9-aa7d-4abf-b1f2-8e8f940edab0",
5 "status": "APPROVED",
6 "provider": "stripe",
7 "paymentMethod": "creditCard",
8 "appId": "1380b703-ce81-ff05-f115-39571d94dfcd",
9 "appInstanceId": "a5e169bc-2825-4e40-8b82-ebde14ac1210",
10 "order": {
11 "id": "2b013aca-cab2-4e69-9a56-86addc91509e",
12 "description": {
13 "items": [
14 {
15 "id": "4743b456-3705-3c7c-1483-08dc7e83805d",
16 "name": "Mikado method",
17 "quantity": 1
18 }
19 ],
20 "billingAddress": {
21 "firstName": "Yaroslav",
22 "company": null,
23 "address": "Kiev, Pankinska 94",
24 "city": "Kiev",
25 "state": "Kiev",
26 "zipPostalCode": "00000",
27 "countryCode": "UKR",
28 "phone": "+0000000000",
29 "fax": "",
30 "email": "[iaroslavk@example.com|mailto:iaroslavk@wix.com]"
31 },
32 "additionalCharges": {
33 "tax": 0,
34 "shipping": 0,
35 "discount": 0
36 }
37 }
38 },
39 "amount": {
40 "amount": 1,
41 "currency": "USD"
42 },
43 "paymentMethodData": {
44 "installments": "1"
45 },
46 "refundability": {
47 "isRefundable": false,
48 "reason": {
49 "value": "FORBIDDEN"
50 },
51 "flowType": "NA"
52 },
53 "createdAt": "2019-02-25T13!https://emoji.slack-edge.com/T02T01M9Y/30/dfa75940bec6ff46.png!25.361Z",
54 "type": "SALE",
55 "providerTransactionId": "",
56 "providerFields": {}
57 },
58 {
59 "transactionId": "5f21e8ae-3b4c-4c43-b5f9-131aec1bca57",
60 "status": "OFFLINE",
61 "provider": "NA",
62 "paymentMethod": "offline",
63 "appId": "1380b703-ce81-ff05-f115-39571d94dfcd",
64 "appInstanceId": "a5e169bc-2825-4e40-8b82-ebde14ac1210",
65 "order": {
66 "id": "b9c4d273-032e-4a4d-b386-8a62f83c476a",
67 "description": {
68 "items": [
69 {
70 "id": "4743b456-3705-3c7c-1483-08dc7e83805d",
71 "name": "Mikado method",
72 "quantity": 1
73 }
74 ],
75 "billingAddress": {
76 "firstName": "Yaroslav",
77 "company": null,
78 "address": "Kiev, Pankinska 94",
79 "city": "Kiev",
80 "state": "Kiev",
81 "zipPostalCode": "00000",
82 "countryCode": "UKR",
83 "phone": "+0000000000",
84 "fax": "",
85 "email": "[iaroslavk@example.com|mailto:iaroslavk@wix.com]"
86 },
87 "additionalCharges": {
88 "tax": 0,
89 "shipping": 0,
90 "discount": 0
91 }
92 }
93 },
94 "amount": {
95 "amount": 1,
96 "currency": "USD"
97 },
98 "paymentMethodData": {
99 "installments": "1"
100 },
101 "refundability": {
102 "isRefundable": false,
103 "reason": {
104 "value": "FORBIDDEN"
105 },
106 "flowType": "NA"
107 },
108 "createdAt": "2019-02-25T13:29:21.764Z",
109 "type": "SALE",
110 "providerTransactionId": "5f21e8ae-3b4c-4c43-b5f9-131aec1bca57",
111 "providerFields": {}
112 }
113 ],
114 "pagination": {
115 "offset": 0,
116 "limit": 0,
117 "total": 2
118 }
119}