UniPay Gateway Documentation

Are you ready?

In this tutorial, we are going to learn how to issue refunds as real-time batch transactions. For batch refunds to be performed successfully, follow these rules:
- You can issue up to 200 refunds at a time;
- All transactions that you are going to issue refunds for must belong to one sub-batch;
- Refunds can be issued for previously approved or partially approved transactions;
- When indicating a list of transaction IDs that are going to be used for batch refunds, every transaction ID must be started from a new row;
- For further identification of refund transactions issued in a batch, you are required to assign a particular note to it.
We will proceed as follows:
1. Locate the ID of the sub-batch that you are going to issue refunds for.
2. Run a query to obtain the IDs of all approved transactions associated with a particular sub-batch. As refunds can be made for active merchants only, you can obtain the IDs of the transactions using the query only for active merchants as well.
3. Issue refunds using a designated form and collect transactions IDs.
4. Get the result of the batch refund processing.
5. Use a query to get the IDs of the transactions that failed to be refunded in case if there were any issues during batch refund processing.
Let's learn how to locate a sub-batch using a How to locate a sub-batch for review tutorial to get a sub-batch ID (we will use 1234 for training purposes within this tutorial).
Log in to the system using your Username and Password and switch to the Administration -> System Perspective.

Note: To learn how to log in and select perspectives, use the prerequisite tutorial Logging in and navigating the application.
Let's learn how to execute a query to retrieve the IDs of the transactions that are going to be refunded. As stated above, transactions can be refunded only when they are approved or partially approved, thus, we will run the query for the transactions with the response codes A01 and A05.
Click IQbutton in the top section of the screen.
Choose DQM menu item from the list.
Locate Query groupbox

Enter a query:

 
select id from charge_transaction
where
sub_batch_fk = 1234
and response_code in ('A01', 'A05')
and remaining_amount > 0

Click Executebutton
You will see a list of the IDs available for this sub-batch. Copy the results.
Now, let's learn how to execute batch refunds.
You can execute batch refunds at the Transactions form, which is available at the following places:
- Perspective => Console => Transactions => List
- Perspective => Management => Merchant perspective => Processing => Transactions
- Perspective => Administration => Monitoring => Transactions
You can choose any place you like.
Click Refundbutton
Choose Card menu item from the list.
Choose Batch Refund menu item from the list.
Locate Transaction List groupbox on the opened form.
Locate Transaction ID textboxand enter the list of transactions IDs retrieved in step 10.
Locate Note textboxand enter your note that will be used as an identifier of refunded transactions (for example, batch refund issued). If you followed all the steps correctly, your screen will look similar to the screenshot.
Click Processbutton .
You will be automatically redirected on the Execution Log tab, where you will see the batch refund processing, including responses received for every transaction.
Click Nextbutton after the process is finished.
Locate Result groupbox to review the result summary of batch refund processing. In case when refunds have not been processed for some reason, you will see a list of the declined transaction IDs in Declined Transactions field.
Now, let's learn how to check the result of batch refund processing using a query. You will need to go to DQM form again. To do this, follow the steps from 2 to 6.

Enter a query:

 
select
id,
request_date,
merchant_account_code,
amount/100 amount,
response_code,
response_message,
original_reference_number original transactionId,
account_number_masked account number,
account_accessory_masked account accessory,
transaction_memo memo,
customer_account_code,
first_name,
last_name
from charge_transaction
where
request_date between '2018-11-01' and '2018-11-01'
and transaction_memo = 'batch refund issued'

Click Executebutton
You will see the result of the batch refund processing.
Congratulations, you are done!

You have learned how to issue batch refunds and now can do this by yourself.

Issuing batch refunds

Prerequisite Tutorials

Issuing batch refunds

Related Tutorials

Tags