Kavi® Commerce Help

Chapter 9. Upload Transactions

Overview

The Upload Transactions tool is only available in manual processing mode. When you are taking the place of the gateway, you must manually respond to all pending transaction requests submitted to Kavi® Commerce by other applications. The Upload Transactions page helps you respond to these requests quickly and in bulk by processing updates made to a spreadsheet of manual transaction information.

If you need to quickly complete a single transaction, use the Complete a Transaction tool instead.

Preparing transaction data for upload

The upload file must contain transaction information in a Comma-Separated (CSV) format. The easiest way to ensure that your file is in the proper format is to first download the transaction information in the CSV format provided by the Download Transactions tool. Make changes directly to the downloaded file, then be sure to save it back to the CSV format, including the file extension (.csv). This will ensure that when the file is ready for upload, it will be properly formatted for the Upload Transactions tool.

Required Upload Columns

Only three columns are required when uploading completed transactions. All other transaction columns are ignored.

The required columns are:

item_key

This is the unique ID assigned to each transaction by Kavi Commerce.

order_id

This is the displayed ID for a transaction, and will generally match the ID of the associated item from the originating application. So, if this transaction was created by Kavi Billing, the Order ID will match the Bill ID of the bill associated with this transaction.

status

The status shows whether the transaction request succeeded or failed. To learn more about the different status types, see the Transaction Status Descriptions table.

After downloading all pending transactions and processing them manually, enter the new status in the status column for each transaction. The new status must be directly related to the previous status.

Examples

These new status changes are valid:

  • pending_authorize to authorized

  • pending_authorized to failed_authorize

  • pending_charge to charged

  • pending_charge to failed_charge

  • pending_return to returned

  • pending_return to failed_return

These new status changes are NOT valid:

pending_charge to authorized

Transactions cannot go back to a previous status in the transaction life-cycle.

returned to charged

A refunded transaction will always have the status returned even if it has some remaining charged balance.

The status names are lower-cased and connected by an underscore. This is the format used to store the transaction status in the database, and is the format recognized by the Upload Transactions page.

Use the Upload Transactions tool to:

Complete pending manual processing mode transactions in bulk.

Back to top

How to Upload Transactions

Upload Transactions File

After you've selected your upload file, enter your email address. It may take some time before all the information in the uploaded file can be saved to the database. An email will be sent to the email address you enter once the upload is complete, and will include details about any errors that were not caught by the validation step. Make sure that someone is watching for that email so that any errors can be quickly corrected.

Data Validated

The validation step will show you how many good rows of your CSV file will be saved to the database, and how many rows contained errors. The error message will point out how to correct the error before you save the transaction data. It is always best to correct errors in your file before saving the data to avoid any confusion later about which rows needed corrections and which completed successfully.

Done

You have just successfully uploaded transactions!

Back to top