Skip to main content
Commerce Engine Transactions typically represent requests for funds sent to a payment processor. The Transaction object encapsulates information about the financial transaction processed through Commerce Engine. The Transaction request includes a Payment Method, customer Account information (including Billing Address), one or more Products or billing plans, a price amount and currency, as well as additional metadata used by the system. Transactions are either initiated by the Reseller (Service Provider) via the Commerce Engine API for one-time purchases or generated by the Commerce Engine system as part of a recurring subscription. During processing, some Transactions may be cancelled before being submitted to a payment processor (for example, because the Commerce Engine fraud screening score is above a certain threshold), the rest are forwarded to a payment processor. Commerce Engine processes Transaction objects with your payment processor and updates their status during the process. Every capture attempt sent to the Payment processor (including attempts based on retry logic) is sent as a new Transaction. The current Transaction status is displayed within the Transaction while previous statuses are logged and can be accessed via the API or Commerce Engine reports. In case when the payment capture is done by an external system, like for Acceptance Payments, the fund capture need to be registered into the system after it was received, in order to keep the subscription in a good state. The transaction is used also for recording card validation requests. The transaction object serves as the charge to the customer and is therefore used to reconcile settlements received from the payment processor with the aggregated data available in the Transaction Reports. Transactions can be migrated from previous customers billing systems to serve as historical data. Use Commerce Engine Portal to search for Transactions, view details and activities associated with a single Transaction, or view aggregated results using Transaction reports. You may also issue refunds as appropriate or necessary against captured Transactions. The Transactions list page displays transactions by ID, Customer, Payment Type, Amount, Status, and Created Date. A summary of all the transactions included on the search results page is displayed at the bottom of the page and is grouped by currency. This summary includes the totals of all transactions per displayed currency and provides additional totals, such as amounts refunded, authorized, cancelled, captured, and voided. You can choose to download a full or partial Transaction search results list of up to 10,000 Transactions by clicking the Download button. The list is downloadable as a csv file and can be viewed in a program such as Notepad or Excel. For guidance how to search for transactions, see Filtering Transactions.

​
Refunds of Transactions

The Refund object provides a way to reverse a charge, refunding money to the customer. A refund can only be executed against an existing, successfully captured transaction. Refunds can be issued for any valid amount (in the currency of the original transaction) up to the as-yet un-refunded balance of the original transaction. Refunds themselves transfer funds from the Resellers (Service Providers) to the customers. Note however that it is the Refund object, not the Transaction object, that encapsulates information on refunds to your customers. The Transaction object will appear as Refunded status to inform that a refund was processed against the Transaction. There are three refund strategies:
  • Refund the full amount against the whole transaction
  • Refund against Specific Transaction Items (products) in the Transaction
  • Remaining balance approach that lets you refund based on the amount left from the original Transaction
Refund requests are queued into batch jobs that are sent to payment processors periodically throughout the day. If you view a Refund before its batch job is completely processed, the Refunds field will list its status as Pending. After the refund is processed the status will change to Complete. Parent topic:Billing