GET

List Transactions For Single Order


Retrieves information about payments and refunds associated with a specified order.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Read eCommerce - all read permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/ecom/v1/payments/orders/{orderId}

Path Params
orderIdstringRequired

Order ID.

Response Object
orderTransactionsOrderTransactions

Order ID and its associated transactions.

List Transactions For Single Orders
Request
cURL
curl -X GET 'https://www.wixapis.com/ecom/v1/payments/orders/8d009fbe-6600-4c7a-ad23-37e9f0477947' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "orderTransactions": { "orderId": "8d009fbe-6600-4c7a-ad23-37e9f0477947", "payments": [ { "id": "a335aebd-4688-437e-84c3-ebe947779bc1", "giftcardPaymentDetails": { "giftCardPaymentId": "ff3c2b57-2dc4-47de-a261-9ae00251a60b", "giftCardId": "", "appId": "d80111c5-a0f4-47a8-b63a-65b54d774a27", "voided": false }, "createdDate": "2023-09-01T20:20:26.451Z", "updatedDate": "2023-09-01T20:20:26.451Z", "amount": { "amount": "25.0", "formattedAmount": "C$25.00" }, "refundDisabled": false }, { "id": "62fdfea7-896d-438d-9b88-4d7c1a4674ac", "regularPaymentDetails": { "gatewayTransactionId": "42a6c722-b27d-49fc-9a18-827115c4bd66", "paymentMethod": "Stripe", "providerTransactionId": "pi_3NmFQZINImlhPEm01iyAurzL", "offlinePayment": false, "status": "REFUNDED" }, "createdDate": "2023-09-01T20:21:26.451Z", "updatedDate": "2023-09-03T12:30:12.853Z", "amount": { "amount": "17.99", "formattedAmount": "C$17,99" }, "refundDisabled": false } ], "refunds": [ { "id": "3cfa83af-94fe-4e02-a7c7-3a969557f697", "transactions": [ { "paymentId": "62fdfea7-896d-438d-9b88-4d7c1a4674ac", "amount": { "amount": "17.99", "formattedAmount": "C$17,99" }, "refundStatus": "SUCCEEDED", "gatewayRefundId": "9656f197-74de-4d9a-bac2-85155614ef5e", "providerRefundId": "re_3NmFQZINImlhPEm011HglMxH", "externalRefund": false } ], "details": { "items": [ { "lineItemId": "00000000-0000-0000-0000-000000000001", "quantity": 1 } ], "shippingIncluded": true }, "createdDate": "2023-09-03T12:30:12.853Z" } ] } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?