Batch Refunds
Create and cancel refunds in bulk to your customers using Batch Refunds.
Use Batch refunds to make refunds in bulk using an XLSX or CSV file. Once you upload a file, it is picked up for processing after 70 minutes. You can cancel a batch upload in the 70 minutes before it is picked up for processing.
Feature Request
This is an on-demand feature. Please raise a request with our
to get this feature activated on your Curlec account.A batch file can be in any of these states:
created: This is the initial state of the file when it is uploaded. Once you upload a file, it stays in thecreatedstate for 70 minutes. You can cancel the upload during this time.processing: This state indicates that the batch file is getting processed.processed: This is the final state of the file. It indicates that all the rows in the batch file were processed, either successfully or unsuccessfully. Download the Batch Refund Report from the Dashboard to check the status of each refund.cancelled: You can only cancel batch uploads in thecreatedstate. You cannot cancel batch uploads in theprocessingorprocessedstates.
Curlec does not charge any processing fee for Normal refunds. However, the transaction fee levied by Curlec at the time of payment capture will not be reversed to your account.
To create a batch refund:
- .
- Go to Transactions → Batch Refunds and click Upload New Batch.
- .
- Add the required data to the sample file. Know more about .
- Upload the file to the Curlec Dashboard, check the preview to ensure details are correct, and click Submit Batch.
, add your data to this file and upload it for processing. We support CSV, XLS and XLSX file formats for the batch file. We do not support custom headers.
The below table lists the various headers in the sample batch file and briefly describes each.
Payment Id
mandatory
string The unique identifier for the payment that is to be refunded. For example, pay_F1JdjAyjRexm9T.
amount
mandatory
integer The amount, in sen, to be refunded. For example, pass 1000 to process a refund of MYR 10.00.
speed
optional
string The speed at which the refund should be processed. Possible value:normal - The refund is processed in 5-7 working days.
If no value is passed, the refund is processed using the
set on the Curlec Dashboard.You can cancel a batch upload from the Curlec Dashboard.
Handy Tips
You can only cancel batch uploads in the created states. You cannot cancel batch uploads in the processing and processed states.
To cancel a batch upload:
- .
- Go to Transactions → Batch Refunds.
- Click Cancel for the Batch Id that you want to cancel.
Though a batch file may have acquired processed state, all the refunds may not have been successful due to errors. For example, if an incorrect payment id is added to the file, the file might be processed, but the refund would have failed.
You can download the Batch Refund report to check the status of each data row.
To download the Batch Refund report:
- .
- Go to Transactions → Batch Refunds.
- Click Download for the required Batch Id to download the Batch Refund Report.
- If a payment was successfully refunded, the corresponding data row is populated with a
Refund Id. - If a payment was not successfully refunded, the corresponding data row is populated with an
Error CodeandError Description.
- If a payment was successfully refunded, the corresponding data row is populated with a
The below table describes each of the headers of the processed batch file:
Payment Id
string The unique identifier for the payment that is to be refunded. For example, pay_F1JdjAyjRexm9T.
Amount
integer The amount, in sen, to be refunded. For example, pass 1000 to process a refund of MYR 10.00.
Refund Id
string The unique identifier of the refund. For example, rfnd_EqWThTE7dd7utf.
Refunded Amount
integer The amount, in sen, refunded to the customer. For example, 1000 means MYR 10.00 was refunded to the customer.
status
string The status of the refund. Possible values:
processed: The refund was successfully processed by us.failure: The refund was not processed. You need to create the refund again.
speed
optional
string The speed at which the refund should be processed. Possible value:normal - The refund is processed in 5-7 working days.
If no value is passed, the refund is processed using the
Error Code
string The error code for the failure. For example, BAD_REQUEST_ERROR.
Error Description
string The reason for the error. For example, The refund amount provided is greater than the unrefunded amount.
Was this page helpful?