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.
- Update the status of a single payment or multiple payments.
- Listen to events when an order's transactions are updated.
- The Order Transactions API records payments and refunds. It doesn't charge or refund funds. Adding a payment record or updating a payment status has no effect on the actual money movement.
- To issue a refund, use Refund Payments in the Order Billing API. The refund is then recorded in the order's transactions.
- After a payment record is added or updated, the order's
paymentStatus is recalculated asynchronously. Reading the order immediately afterward may still show the previous payment status.
- Transaction: Global term for a transfer of funds. This can be either one of:
- Payment: A transfer of funds from customer to merchant/seller when making a purchase.
- Refund: A reimbursing transfer of funds back to the buyer.
- Chargeback: A payment reversal initiated by the buyer's bank or card issuer, recorded on the relevant payment.