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:

• Retrieve transactions related to a single or multiple orders.
• Add payment records to an order.
• Listen to events when an order's transactions are updated.

Terminology

• Transaction: Global term for a transfer of funds - can be either a:
  • Payment: A transfer of funds from customer to merchant/seller when making a purchase.
  • Refund A reimbursing transfer of funds back to the buyer.

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.

Retrieve transactions related eCommerce orders

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 info about an order's transactions:

1. Call List Transactions For Single Order with an eCommerce order ID.
   • To retrieve transaction details about more than 1 order, call List Transactions For Multiple Orders with an array of eCommerce order IDs.
2. You can use the returned info to check payment and refund details in the relevant provider or gateway systems, pass the details on to your accounting or invoice apps, and more.

Add payment records to imported orders

If you are importing orders from other systems, you may want to add payment records to those orders. To add a payment record to an order that is already in the eCommerce system:

1. Once you have the order ID, pass it to the Add Payments endpoint.
2. In the body params, pass payment details like the createdDate, amount, paymentMethod, and any other payment details.
3. When using Add Payments you can add up to 50 payment records to a single order with 1 API call.