Overview
The Bulk Upload interface allows merchants to upload a CSV file with existing transactions and then perform the following bulk actions on them: Refund, Settle, Void, Payout, Add to List, and Remove from List.
The interface is available to merchants with the following roles: Management and Operations_Actions.
The interface is relevant only for transactions that were processed through Nuvei and for the following related transactions type: Sale, Auth, and Settle.
File Upload Guidelines
For Refund, Settle, Void, and Payout, press the Download Sample CSV File link to download a sample CSV file so you can see how the CSV files should be prepared.
The sample file includes:
- Transaction ID – This is the Nuvei Transaction ID.
- Amount – The amout of the Transacton ID on which you are going to perform the action. You do not need to specify the currency.
- Copy of Client Unique ID – The value is TRUE or FALSE.
- Entering TRUE means that Nuvei retrieves the Client Unique ID associated with the original transaction.
- FALSE means that the field remains empty.
When uploading your CSV file, you should follow these guidelines:
- Each CSV file should include only one kind of action type.
- User can upload only one file at the time.
File Validations
Refund, Settle, Void, Payout
When your CSV file is uploaded to the server, it is validated for the following:
- The file extension is CSV and the format is comma delimited.
- The file should not include more than 200 transactions.
- A negative amount in the Action Amount column.
- Any empty cells in the first 3 columns.
- Duplicate Transaction IDs.
- Text in the Transaction ID and Amount columns.
Add to List and Remove from List
When your CSV file is uploaded to the server, it is validated for the following:
- The file extension is CSV and the format is comma delimited.
- The file should not include more than 200 rows.
- The same format that appears in the sample file per user parameter.
Uploading Bulk Files
To upload transactions in bulk:
- From the Menu bar, select Operations > Bulk Upload. The Bulk Upload page is displayed.
- Select the relevant action from the Action Type dropdown.
- If you select Action Type Add to List or Remove from List, then you must also select values from the following dropdown:
- List Type – Indicates if the transaction was added/removed from negative/positive list (see Actions).
- User Parameters – The parameter on which you wish to perform the action.
- Billing Address
- Billing Phone
- IP
- Shipping Address
- Reason – The reason for the action
- [Optional] Client Name
- In the Upload CSV File section, either press to select your file to upload or drag the files to the box area.
A window opens to show the upload progress.
When the validation of the files completes, a table of the uploaded transactions is presented.
You can press Export at any time to download this table to CSV, Excel, or PDF.
Uploaded CSV File Records Table
Action Types – Refund, Settle, Void, Payout
The following table describes the columns that are shown in the table for the following action types: Refund, Settle, Void, and Payout.
Table Column | Description | Notes |
---|---|---|
Transaction ID | The transaction ID on which the action is performed. | |
Validation | This checks if:
Failure Success | A failure reason of “Invalid transaction ID” means that either:
|
Result | The transaction result. Possible values: Approve Decline Error Filter error | Presented only after pressing Submit. |
Amount | The transaction amount. | |
Action Amount | The amount with which you are going to perform the action. | |
New Transaction ID | The action Transaction ID (related transaction). | Presented only after pressing Submit. |
Client Unique ID | The ID of the transaction in the merchant’s system. | This value must be unique. Presented only after pressing Submit. |
Validation Column
The following tables summarizes the validation logic of comparing the Action Amount column to the Amount column.
Case | Refund | Settle | Payout |
---|---|---|---|
Action Amount > Amount | Service returns failure | Service returns failure | Service returns Success |
Action Amount < Amount | Service returns Success | Service returns Success | Service returns Success |
Action Amount = Amount | Service returns Success | Service returns Success | Service returns Success |
Action Amount is empty | Service returns Success. | Service returns Success. | Service returns Success. |
Nuvei refunds the transaction for the transaction amount. | Nuvei settles the transaction for the transaction amount. | Nuvei performs a payout the transaction for the transaction amount. |
For Void, the Control Panel ignores the Amount column in the CSV file and presents the amount returned from the service (transaction amount).
Action Amount Column
The Action Amount column allows the merchant to change any failed validation when the reason for the validation failure is related to the amount as described in the above table.
Once you have used the Action Amount column to fix any validation errors, you must press Validate.
After a few moments, the Validation column is updated.
Press Submit to process the transactions. Transactions that were successfully given a new Transacdtion ID are updated in the Transaction Report.
Action Types – Add to List, Remove from List
These actions are relevant at the user level, and allow either adding or removing the selected parameter in bulk to/from the whitelist or blacklist.
The following table describes the columns that are shown in the table for the following action types: Add to List and Remove from List.
Table Column | Description |
---|---|
Value | The value entered in the Excel by the merchant. |
Validation | This checks if the value entered is valid. |
Invalidation Reason | The reason the value is invalid (if relevant). |
Value Column
The Value column allows the merchant to change any failed validation.
Once you fix any validation errors, you must press Validate.
After a few moments, the Validation column is updated.
Press Submit to process the transactions.