Overview

From the Control Panel, you can generate Withdrawal Orders reports from which you can review your withdrawal orders and settle or decline any pending orders. The Withdrawal Orders report contains the status of the orders, the financial details of the orders, and the details of the withdrawal request the order belongs to.

Generating a Withdrawal Orders Report

Refer to the Reports page that explains the basic format of the reports that can be generated using the Control Panel. The page also describes how to use the various settings and filters that allow you to generate a report with only the most relevant data, how to export your report, as well as create, schedule, and manage queries.

To generate an Withdrawal Order Report:

1. From the Menu bar, select Operations > Withdrawals > Orders.
2. Press Manage Page Settings to set which and how parameters are displayed in the report.
3. Select the date range of the report from the dropdown.
4. Press Filters if you wish to narrow the search parameters for your report.
5. Press Run Report. The report is displayed according to the settings and filters you have defined or selected.

Withdrawal Orders Report

The results are displayed in descending order according to date.

Above the Search Result section, the filters that were used in the search are presented, and these can be used to further refine your search.

Actions

The Actions dropdown above the report enables you to perform the following actions to the transactions in the report: Settle, Delete, Add to Batch, and Update Excecution Time.

The actual actions available for each transaction depends on the type and status of each individual transaction.

Settling Withdrawal Orders

When a customer submits a withdrawal request that includes several withdrawal orders and you want to settle specific withdrawal orders from within the request, you can specify which order to settle through the settleWithdrawalOrder method. The settleWithdrawalOrder method settles a single order according to the wdOrderID you send in the request. Nuvei then processes the request and returns a response.

To settle a withdrawal order:

1. In the first column of the report, select all the requests to be settled.
2. Above the report, press Settle and a confirmation box appears.
3. The confirmation box also contains a pre-checked checkbox asking if you wish to Auto Seal the request, which is the default option. If you do not wish to Auto Seal the request, clear the checkbox. For more information see Sealing a Request.
4. Press Yes, go ahead to confirm and all orders of the request are settled.

Deleting Withdrawal Orders

Your users or administrator can delete requests. When a request is declined, the status of the request in the Withdrawal page is changed to “declined” and the funds are not transferred. If your customer wants to transfer funds to his account, the customer must issue a new withdrawal request.

To delete a withdrawal order:

1. In the first column of the report, select all the requests to be settled.
2. Above the report, press Delete and a confirmation box appears.
3. The confirmation box also contains a pre-checked checkbox asking if you wish to Auto Seal the request, which is the default option. If you do not wish to Auto Seal the request, clear the checkbox. For more information see Sealing a Request.
4. Press Yes, go ahead to confirm that all the orders of the request are to be deleted.

Settling Transactions in Offline Batches

You can settle transactions through offline batch files from within the Control Panel. Nuvei periodically checks throughout the day if you have selected any orders to be processed through a batch file and if any orders are currently pending, and automatically attempts to settle the batch. If settling an order would generate an error, for example, if the order is already sealed, Nuvei returns an error for that order.

After you have added your orders to the batch, the next time Nuvei checks and locates the pending batch orders, Nuvei processes the batch file and updates the status of the order in the Order Search Report of the Control Panel.

To add files to a batch:

1. In the first column of the report, select all the requests to be settled.
2. Press Add to Batch and a confirmation window appears.
3. Press Yes, go ahead. A window is displayed that indicates that the orders were successfully added to the batch file.

Update Execution Time

Along with settling transactions as mentioned above, the Control Panel enables its users to delay settlement by updating its execution time. The execution time can be determined by a specific amount of time or a specific date and time in the future.

To update an execution time through the Withdrawal Order Search Report:

1. In the first column of the report, select all the requests for which you wish to update their execution times.
2. Above the report, press Update execution time and a confirmation box appears.
3. The confirmation box also displays the time zone setting and the current execution time, as well as three options for changing the execution time:
   1. Cancel execution time – Cancel the current default execution time set to the withdrawal order.
   2. Set order to be executed in – Delay the withdrawal order execution by a specified period of time (hours and minutes).
   3. Set order to be executed at – Set the withdrawal order to a specific date and time. Select the desired option. When selecting Set order to be executed in or Set order to be executed at, the amount of time and date/time, respectively, must be set.
4. Press Yes, go ahead to confirm and the orders are updated.

Updating Externally Settled Transactions

Transactions can be settled externally, meaning not through the Control Panel, and then uploaded to the Control Panel to keep the account updated.

Transactions settled externally must be updated by downloading the list of transaction to an Excel file, manually updating the applicable information, and uploading the file back to the Control Panel.

To update the transactions:

1. On the top right of the page, press Export to download the results to an Excel file.
2. Create a separate Excel file to update changes:
   1. Insert the Site ID in the A1 cell.
   2. Using the rest of Column A, list all transaction OrderIDs that you wish to edit.
   3. Use Column B to update the status of each OrderID (SETTLED_EXTERNALLY or ERROR).
   4. Update the amounts of each OrderID in Column C.
   5. Update the currency in Column D.
      
      
      All information must be correct or an error will result.

3. Return to the Order Search page and press Upload.
4. Select the Excel file to upload and the Confirmation required window pops up.
5. Select Yes, go ahead to continue and the Processing results window pops up to notify you of the status of the update.
   The status is changed to ‘settled externally’.

Report Parameters

This section provides tables that describe the parameters that can be selected to be displayed in the report.

Request Information

Parameter	Description	Notes
Request Date	Determines according to which set of dates withdrawal orders are displayed in the report.
Request ID	Displays the Nuvei withdrawal order request ID.	Enter the request ID in this field when searching for a single withdrawal.
Request Status	Displays the current status of the request.
Request Payment Method	Allows the merchant to narrow the search based on the payment methods of the orders to be displayed in the report.	The dropdown menu in the Order Search page is specified for each merchant.
Request Amount	Allows the merchant to narrow the search based on a specified amount range of the requested orders.
Request Currency	Allows the merchant to narrow the search based on the currency in which the transaction was processed.	Currencies can be selected from the dropdown menu.
Request State	Allows the merchant to narrow the search based on the status of the order.	Statuses can be selected from the dropdown menu.
Request Last Modified	Allows the merchant to narrow the search based on the date and time of the most recent request.
Merchant Unique ID	Allows the merchant to narrow the search based on the unique ID of the given merchant.
Site	Allows the merchant to narrow the search based on site from where the transaction was generated.
Is Fast	Indicates whether the sub-integration process of the payment method is Fast Payout or not.

Consumer

Parameter	Description
User ID	Displays the consumer’s ID.
First Name	Displays the consumer’s first name.
Last Name	Displays the consumer’s last name.
Email	Displays the consumer’s email address.

Order Information

Parameter	Description	Notes
Date	Allows the merchant to search for orders from a predetermined time period.
Execution Time	The time that the order was executed.
Order ID	Allows the merchant to search for a specific order using its unique ID.
Order Status	Allows the merchant to search for a specific order based on one or more specific statuses (Approved, Deleted, etc.)	These can be selected from the checkboxes is the dropdown menu.
Order Payment Method	Allows the merchant to search for a specific order based on one or more specific payment methods.	These can be selected from the checkboxes is the dropdown menu.
Order Amount	Allows the merchant to narrow the search based on a specified amount range of the orders.
Currency	Allows the merchant to narrow the search based on the currency in which the transaction was processed.	Currencies can be selected from the dropdown menu.
Num of PMs	This represents the range of the amount of payment methods that the customer has register with the merchant.	This information is useful for splitting up withdrawals among multiple payment methods.
Net Deposit	Allows to see results of specific net deposit amounts.
Order Last Modified	Displays the dates that withdrawal orders were last modified.
Reason	If the Gateway declined the withdrawal request, this displays the reason.
GW Status	Shows the status of the withdrawal from within the Gateway.
GW Trx ID	Allows the merchant to search for a specific transaction based on the ID given to the transaction by the Gateway.
Fee Amount	Shows fee the amount for the given request.
Operator Name	The name of the operator involved in the requested withdrawal.