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:
- 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.
- 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:
- Once you have the order ID, pass it to the Add Payments endpoint.
- In the body params, pass payment details like the
createdDate
,amount
,paymentMethod
, and any other payment details. - When using Add Payments you can add up to 50 payment records to a single order with 1 API call.
Manage eCommerce order payments
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves information about payments and refunds associated with a specified order.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves information about payments and refunds associated with all specified orders.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Adds up to 50 payment records to an order.
Note: This does NOT perform the actual charging - the order is only updated with records of the payments.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Updates the status of an order's payment.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Updates multiple order payments with a specified status.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a payment or refund is added to an order, or when an existing payment is updated.
The response contains the ID of the updated order and details of its associated transactions, as well as IDs of the updated payments and refunds.