About the Order Transactions API

The eCommerce Order Transactions API concentrates records and details of payments and refunds associated with eCommerce orders.

With the Order Transactions API you can:

Terminology

  • Transaction: Global term for a transfer of funds - either a payment to the merchant or a refund to the buyer.
Was this helpful?
Yes
No

Sample Use Case & Flow: Order Transactions

This article shares a possible use case your app could support, as well as an example flow. You're certainly not limited to this use case, but it can be a helpful jumping off point as you plan your app's implementation.

Your app can retrieve details about payments and refunds associated with an order. For example, you can check for payments that were made by credit-card, payments made by gift card, or orders that were not successfully refunded.

To retrieve order transactions:

  1. Call List Transactions For Single Order with an eCommerce order ID.
  2. Using the returned info, check payment and refund details in the relevant provider or gateway systems.
Was this helpful?
Yes
No

Order Transactions Object

Attributes
orderIdstringformat GUID
Order ID.

paymentsArray <Payment>
Record of payments made to the merchant.

refundsArray <Refund>
Record of refunds made to the buyer.
Was this helpful?
Yes
No

GetList Transactions For Single Order

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves transactions associated with a specified order.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage eCommerce - all permissions
Read eCommerce - all read permissions
Manage Orders
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/ecom/v1/payments/orders/{orderId}

Was this helpful?
Yes
No

PostList Transactions For Multiple Orders

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves transactions associated with all specified orders.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage eCommerce - all permissions
Read eCommerce - all read permissions
Manage Orders
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/ecom/v1/payments/list-by-ids

Was this helpful?
Yes
No