Introduction
Developer Preview
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.
The Order Transactions API allows you to manage records and details of payments and refunds associated with your orders.
With the Order Transactions API you can:
- Retrieve transactions related to one or more 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.
To use the Order Transactions API, import { orderTransactions }
from the wix-ecom-backend
module:
javascript | Copy Codeimport { orderTransactions } from 'wix-ecom-backend';
Permissions information
Functions in the Order Transactions API are restricted and only run if you elevate permissions using the wix-auth
elevate()
function.
Warning: Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.
Was this helpful?