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:

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.
Was this helpful?
Yes
No

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.

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.
  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.
Was this helpful?
Yes
No

Order Transactions Object

Manage eCommerce order payments

Properties
orderIdstringformat GUID

Order ID.


paymentsArray <Payment>maxItems 100

Record of payments made to the merchant.


refundsArray <Refund>maxItems 300

Record of refunds made to the buyer.

Was this helpful?
Yes
No

GetList Transactions For Single Order

Developer Preview

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:
Manage Stores - all permissions
Read eCommerce - all read permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/ecom/v1/payments/orders/{orderId}

Was this helpful?
Yes
No

PostList Transactions For Multiple Orders

Developer Preview

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:
Manage Stores - all permissions
Read eCommerce - all read permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/ecom/v1/payments/list-by-ids

Was this helpful?
Yes
No

PostAdd Payments

Developer Preview

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:
Manage Stores - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/ecom/v1/payments/orders/{orderId}/add-payment

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostUpdate Payment Status

Developer Preview

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:
Manage Stores - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/ecom/v1/payments/{paymentId}/orders/{orderId}/update-payment-transaction-status

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostBulk Update Payment Statuses

Developer Preview

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:
Manage Stores - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/ecom/v1/bulk/payments/update-payment-transaction-status

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

Order Transactions Updated

Developer Preview

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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read eCommerce - all read permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.order_transactions.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventobject

Event information.

Was this helpful?
Yes
No