POST

List Transactions For Multiple Orders


Retrieves information about payments and refunds associated with all specified orders.

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
POST
https://www.wixapis.com/ecom/v1/payments/list-by-ids

Body Params
orderIdsArray <string>RequiredminItems 1maxItems 100minLength 1maxLength 100

Order IDs for which to retrieve transactions.

Response Object
orderTransactionsArray <OrderTransactions>

List of order IDs and their associated transactions.

List Transactions For Multiple Orders

Retrieves transactions of the 2 requested order IDs

Request
cURL
curl -X POST \ 'https://www.wixapis.com/ecom/v1/payments/list-by-ids' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ --data-binary '{ "orderIds": [ "4bab5870-7943-4a9e-8d4e-96719b3e4f38", "6ae38b2e-455b-4e20-b418-01fca82edaa8" ] }'
Response
JSON
{ "orderTransactions": [ { "orderId": "4bab5870-7943-4a9e-8d4e-96719b3e4f38", "payments": [ { "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-03T12:29:21.284Z", "updatedDate": "2023-09-03T12:30:12.853Z", "amount": { "amount": "17.99", "formattedAmount": "17,99 €" }, "refundDisabled": false } ], "refunds": [ { "id": "3cfa83af-94fe-4e02-a7c7-3a969557f697", "transactions": [ { "paymentId": "62fdfea7-896d-438d-9b88-4d7c1a4674ac", "amount": { "amount": "17.99", "formattedAmount": "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" } ] }, { "orderId": "6ae38b2e-455b-4e20-b418-01fca82edaa8", "payments": [ { "id": "e2f17179-db73-46ef-8d8a-06de7158e43b", "regularPaymentDetails": { "gatewayTransactionId": "6bba8866-a3af-4404-9522-61be070e4715", "paymentMethod": "Stripe", "providerTransactionId": "pi_3NiMZkLpihTBGDpG0DewjotR", "offlinePayment": false, "status": "APPROVED" }, "createdDate": "2023-08-23T19:18:46.135Z", "updatedDate": "2023-08-23T19:18:46.135Z", "amount": { "amount": "0.5", "formattedAmount": "0,50 €" }, "refundDisabled": false } ], "refunds": [] } ] }
Errors

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

Did this help?