Payments

Recurring Payments

Batch Operations

Batch Operations

Create Recurring Payments using the batch upload feature from the Curlec Dashboard.

You can

create registration links

and

charge tokens

in bulk using the batch feature available from the Curlec Dashboard. You can check the status of the bulk action in the respective batch reports.

Batch Statuses

The following table lists the various states of a batch file:

Create Registration Links

You can create registration links in bulk using the Batch Upload feature.

Handy Tips

  • You can upload batch files in either in the .xlsx or the .csv format.
  • The maximum file size is 55MB and 5,00,000 rows.
  • Ensure you enter the amount in RM. For example, if the amount is RM 1,000, you should enter the value as 100000.
  • The links are processed in the same sequence as listed in the file.
  • Do not modify the column headers. Modifying the column headers causes the batch upload to fail.

To create a registration link:

  1. Log in to the

    Curlec Dashboard

    .
  2. Under PAYMENT PRODUCTS, navigate to Subscriptions → Batch Upload → Upload New Batch → Batch Registration Links.
  3. Download the

    sample file

    .
  4. Add the required data. Know more about the Batch Fields from the

    below table

    .
  5. Upload the file to the Dashboard.
  6. Select the relevant notification options, SMS and/or Email.
  7. Click Create.

Batch Fields

The following table lists the fields required to create a registration link:

name

optional

The customer's name. For example, Nur Aisyah.

email

mandatory

The customer's email address. For example, nur.aisyah@example.com.

phone

mandatory

The customer's contact number. For example, 60345675444.

amount

mandatory if method = card/upi

The registration amount you want to charge the customer in paise.

  • For Card, the minimum value is 100 (that is RM 1).

currency

mandatory if amount is provided

The 3-letter ISO currency code for the payment. Currently, only MYR is allowed.

method

mandatory

The payment method to be authorized. This can be:

  • card

receipt

optional

A user-entered unique identifier for the order. For example, Receipt No. 1. This parameter should be mapped to the order_id sent by Curlec.

description

mandatory

A user-entered description for the registration link. For example, 12 p.m. Meals.

link_expiry_by

optional

Date and time of expiry for the registration link. Supported format DD/MM/YYYY. For example, 17/12/2020.

notes[custom 1]

optional

Key-value pair that can be used to store additional information about the entity. You can add up to 5 custom notes in the following format:

  • notes[portfolio id]
  • notes[transaction id]

Batch Report

After a batch file is processed, you can download the batch report from the Curlec Dashboard. Click the batch_id to view details of how many rows were uploaded, how many rows were processed successfully and how many rows failed.

Click Download Report to download the report. This report has the following additional fields that give you information about the authorisation link or the reason for failure.

Status

The status of the authorisation link. Possible values:

  • success
  • failed

authorization_link_id

The unique identifier for the authorisation link. For example, inv_E7vb0PqKa4VpBc.

authorization_link

The short URL for the authorisation link. For example, https://rzp.io/i/Abcd5.

link_status

The status of the authorisation link. For example, issued.

created_at

Timestamp, in Unix format, when the authorisation link was created. For example, 1580134092.

Error Code

The error code for the failure. For example, BAD_REQUEST_ERROR.

Error Description

The reason for the error. For example:

  • Bank code provided is invalid.
  • expire_by should be at least 15 minutes after current time
  • The ifsc code field is required.

Charge Tokens

To charge tokens using the batch upload feature, you will first need the list of

Tokens

for which recurring payments are to be created.

Handy Tips

  • You can upload batch files in either in the .xlsx or the .csv format.
  • The maximum file size is 55MB and 5,00,000 rows.
  • Ensure you enter the amount in RM. For example, if the amount is RM 1,000, you should enter the value as 100000.
  • The links are processed in the same sequence as listed in the file.
  • Do not modify the column headers. Modifying the column headers causes the batch upload to fail.

Once you have the list of tokens you can either:

Charge Tokens Immediately

To charge tokens immediately:

  1. Log in to

    Curlec Dashboard

    .
  2. Under PAYMENT PRODUCTS, navigate to Subscriptions → Batch Upload → Upload New Batch → Batch Recurring Payments.
  3. Download the

    sample file

    .
  4. Add the required data. Know more about the Batch Fields from the

    below table

    .
  5. Upload the file to the Curlec Dashboard.
  6. Select Process Now.
  7. Click Create.

Schedule a Charge on Tokens

You can schedule to charge tokens in bulk.

To schedule to charge tokens:

  1. Log in to

    Curlec Dashboard

    .
  2. Under PAYMENT PRODUCTS, navigate to Subscriptions → Batch Upload → Upload New Batch → Batch Recurring Payments.
  3. Download the

    sample file

    .
  4. Add the required data. Know more about the Batch Fields from the

    below table

    .
  5. Upload the file to the Curlec Dashboard.
  6. Select Schedule for Later and select the date and time you want to charge the tokens. The schedule time should be at least 1 hour from the current time.
  7. Click Create.

Charge Token Batch Fields

The following table lists the fields required to charge a token:

token

mandatory

The unique identifier for the token. For example, token_1Aa00000000001.

customer_id

mandatory

The unique identifier of the customer. For example, cust_1Aa00000000001.

amount

mandatory

The amount, in RM, you want to charge the customer. For example, enter 69999 for RM 699.99.

currency

mandatory

The 3-letter ISO currency code for the payment. Currently, only MYR is allowed.

receipt

optional

A user-entered unique identifier for the order. For example, Receipt No. 1. This parameter should be mapped to the order_id sent by Curlec.

description

optional

A user-entered description for the payment. For example, 12 p.m. Meals.

notes[custom 1]

optional

Key-value pair that can be used to store additional information about the entity. You can add up to 5 custom notes in the following format:

  • notes[portfolio id]
  • notes[transaction id]

Processed Batch Fields

Once a batch file is processed, you can download the processed file from the Dashboard. Click the batch_id to view details of how many rows were uploaded, how many rows were processed successfully and how many rows failed.

Click Download Report to download the processed file. This file has the following additional fields that give you information about the authorization link or the reason for failure.

order_id

The unique identifier linked to the order for the payment. For example, order_E16Yt72tHs34li.

payment_id

The unique identifier for the payment. For example, pay_E16YtBnEk38fAm.

Error Code

The error code for the failure. For example, BAD_REQUEST_ERROR.

Error Description

The reason for the error. For example, Payment amount exceeds the maximum amount allowed.

Related Information

Was this page helpful?

ON THIS PAGE