The eCommerce Order Transactions API concentrates records and details of payments and refunds associated with eCommerce orders.
With the Order Transactions API you can:
- Transaction: Global term for a transfer of funds - either a payment to the merchant or a refund to the buyer.
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:
with an .
- To retrieve transaction details about more than 1 order, call with an array of .
- Using the returned info, check payment and refund details in the relevant provider or gateway systems.
Retrieves transactions associated with a specified order.
Permission ScopesFor app development, you must have one of the following permission scopes:
Retrieves transactions associated with all specified orders.