1. Create the Authorisation Transaction

You can create an authorisation transaction using

Curlec APIs

Registration Link

Watch Out!

Bank downtime can affect success rates when processing recurring payments via debit cards.

1.1. Using Curlec APIs

To create an authorisation transaction using Curlec APIs, you need to:

1.1.1. Create a Customer

Curlec links recurring tokens to customers via a unique identifier. You can generate this identifier using the Customer API.

You can create

customers

with basic information such as email and contact and use them for various Curlec offerings. The following endpoint creates a customer.

POST

/customers

Request Parameters

name

mandatory

string The name of the customer. For example, Nur Aisyah.

mandatory

string The email ID of the customer. For example, nur.aisyah@example.com.

contact

mandatory

string The phone number of the customer. For example, 60345675444.

fail_existing

optional

boolean The request throws an exception by default if a customer with the exact details already exists. You can pass an additional parameter fail_existing to get the existing customer's details in the response. Possible values:

0: Retrieve details of the existing customer.
1 (default): Throws an exception error.

notes

optional

object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Response Parameters

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

entity

string The name of the entity. Here, it is customer.

name

string The name of the customer. For example, Nur Aisyah.

string The email ID of the customer. For example, nur.aisyah@example.com.

contact

string The phone number of the customer. For example, 60345675444.

notes

object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at

integer A Unix timestamp, at which the customer was created.

You can create an order once you create a customer for the payment authorisation.

1.1.2. Create an Order

You can use the

Orders API

to create a unique Curlec order_id that is associated with the authorisation transaction. The following endpoint creates an order.

POST

/orders

Request Parameters

amount

mandatory

integer Amount in currency subunits. For cards, the amount should be 100 (RM 1.00).

currency

mandatory

string The 3-letter ISO currency code for the payment. Currently, we only support MYR.

customer_id

mandatory

string The unique identifier of the customer. For example, cust_4xbQrmEoA5WJ01.

method

optional

string Payment method used to make the authorisation transaction. Here, it is card.

token

Details related to the authorisation such as max amount, frequency and expiry information.

max_amount

mandatory

integer The maximum amount that can be auto-debited in a single charge. The minimum value is 100 (RM1), and the maximum value is 100000000 (RM10,00,000).

expire_at

mandatory

integer The Unix timestamp that indicates when the authorisation transaction must expire. The card's expiry year is considered a default value.

frequency

mandatory

string The frequency at which you can charge your customer. Possible values:

weekly
monthly
yearly
as_presented

receipt

optional

string A user-entered unique identifier for the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Curlec.

notes

optional

object Key-value pair you can use to store additional information about the entity. Maximum 15 key-value pairs, 256 characters each. For example, "note_key": "Beam me up Scotty”.

Response Parameters

string A unique identifier of the order created. For example order_1Aa00000000002.

entity

string The entity that has been created. Here it is order.

amount

integer Amount in currency subunits. For cards, the amount should be 100 (RM 1.00).

amount_paid

integer The amount that has been paid.

amount_due

integer The amount that is yet to pay.

currency

string The 3-letter ISO currency code for the payment. Currently, we only support MYR.

receipt

string A user-entered unique identifier of the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Curlec.

method

string Payment method used to make the authorisation transaction. Here, it is card.

customer_id

string The unique identifier of the customer. For example, cust_4xbQrmEoA5WJ01.

status

string The status of the order.

notes

object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at

integer The Unix timestamp at which the order was created.

You can create a payment against the order_id after you create an order.

1.1.3. Create an Authorization Payment

Create a payment checkout form for customers to make Authorisation Transaction and register their mandate. You can use the Handler Function or Callback URL.

Watch Out!

The Callback URL is not supported for Recurring Payments created using the registration link.

<button id = "rzp-button1"> Pay </button>
  <script src = "https://checkout.razorpay.com/v1/checkout.js"> </script>
  <script>
    var options = {
      "key": "[YOUR_KEY_ID]",
      "order_id": "order_1Aa00000000001",
      "customer_id": "cust_1Aa00000000001",
      "recurring": "1",
      "handler": function (response) {
        alert(response.razorpay_payment_id);
        alert(response.razorpay_order_id);
        alert(response.razorpay_signature);
      },
      "notes": {
        "note_key 1": "Beam me up Scotty",
        "note_key 2": "Tea. Earl Gray. Hot."
      },
      "theme": {
        "color": "#F37254"
      }
    };
    var rzp1 = new Razorpay(options);
    document.getElementById('rzp-button1').onclick = function (e) {
      rzp1.open();
      e.preventDefault();
    }
  </script>

Additional Checkout Fields

You should send the following additional parameters along with the existing checkout options as a part of the authorisation transaction.

customer_id

mandatory

string Unique identifier of the customer created in the

first step

order_id

mandatory

string Unique identifier of the order created in the

second step

recurring

mandatory

string Indicates whether the recurring should be enabled or not. Possible values:

1: Recurring is enabled.
0: Recurring is not enabled.
preferred: Use this when you want to support recurring payments and one-time payment in the same flow.

1.2. Using a Registration Link

Registration Link is an alternate way of creating an authorisation transaction. You can create a registration link using the

API

Dashboard

Handy Tips

You do not have to create a customer if you choose the registration link method for creating an authorisation transaction.

When you create a registration link, an
invoice
is automatically issued to the customer. They can use this invoice to make the authorisation payment.
A registration link should always have an order amount (in subunits) the customer will be charged when making the authorisation payment. For cards, the amount should be <currency MY="1" IN="1" SG="1" /> in the case of cards.

Handy Tips

You can

use Webhooks to get notifications about successful payments

against a registration link.

1.2.1. Create a Registration Link

The following endpoint creates a registration link.

POST

/subscription_registration/auth_links

Request Parameters

customer

object Details of the customer to whom the registration link is sent.

name

mandatory

string Customer's name.

mandatory

string Customer's email address.

contact

mandatory

integer Customer's contact number.

type

mandatory

string In this case, the value is link.

amount

mandatory

integer The payment amount in the smallest currency sub-unit.

currency

mandatory

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

description

mandatory

string A description that appears on the hosted page. For example, 12:30 p.m. Thali meals (Nur Aisyah).

subscription_registration

Details of the authorisation transaction.

method

mandatory

string The authorisation method. Here it is card.

max_amount

mandatory

integer The maximum amount that can be auto-debited in a single charge. The minimum value is 100 (₹1), and the maximum value is 100000000 (₹10,00,000). For an amount higher than this or the RBI limit of ₹15,000 (1500000), the cardholder should provide an Additional Factor of Authentication (AFA) as per RBI guidelines.

expire_at

optional

integer The Unix timestamp till when you can use the token (authorisation on the payment method) to charge the customer subsequent payments. The card's expiry year is considered a default value.

frequency

mandatory

string The frequency at which you can charge your customer. Possible values:

weekly
monthly
yearly
as_presented

sms_notify

optional

boolean Indicates if SMS notifications are to be sent by Curlec. Possible values:

0: Notifications are not sent by Curlec.
1: Notifications are sent by Curlec (default value).

email_notify

optional

boolean Indicates if email notifications are to be sent by Curlec. Possible values:

0: Notifications are not sent by Curlec.
1: Notifications are sent by Curlec (default value).

expire_by

optional

integer The Unix timestamp indicates the expiry of the registration link.

receipt

optional

string A unique identifier entered by you for the order. For example, Receipt No. 1. You should map this parameter to the order_id sent by Curlec.

notes

optional

object This is a key-value pair that is used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Response Parameters

string The unique identifier of the invoice.

entity

string The entity that has been created. Here, it is invoice.

receipt

string A user-entered unique identifier of the invoice.

invoice_number

string Unique number you added for internal reference.

customer_id

string The unique identifier of the customer. For example, cust_BMB3EwbqnqZ2EI.

customer_details

Details of the customer.

string The unique identifier associated with the customer to whom the invoice has been issued.

name

string The customer's name.

string The customer's email address.

contact

integer The customer's phone number.

billing_address

string Details of the customer's billing address.

shipping_address

string Details of the customer's shipping address.

order_id

string The unique identifier of the order associated with the invoice.

line_items

string Details of the line item that is billed in the invoice. Maximum of 50 line items are allowed.

payment_id

string Unique identifier of a payment made against the invoice.

status

string The status of the invoice. Possible values:

draft
issued
partially_paid
paid
cancelled
expired
deleted

expire_by

integer The Unix timestamp at which the invoice will expire.

issued_at

integer The Unix timestamp at which the invoice was issued to the customer.

paid_at

integer The Unix timestamp at which the payment was made.

cancelled_at

integer The Unix timestamp at which the invoice was cancelled.

expired_at

integer The Unix timestamp at which the invoice expired.

sms_status

string The delivery status of the SMS notification for the invoice sent to the customer. Possible values:

pending
sent

email_status

string The delivery status of the email notification for the invoice sent to the customer. Possible values:

pending
sent

date

integer Timestamp, in Unix format, that indicates the issue date of the invoice.

terms

string Any terms to be included in the invoice. Maximum of 2048 characters.

partial_payment

boolean Indicates whether the customer can make a partial payment on the invoice. Possible values:

true: The customer can make partial payments.
false (default): The customer cannot make partial payments.

amount

integer Amount to be paid using the invoice. Must be in the smallest unit of the currency. For example, if the amount to be received from the customer is RM 299.95, pass the value as 29995.

amount_paid

integer Amount paid by the customer against the invoice.

amount_due

integer The remaining amount to be paid by the customer for the issued invoice.

currency

string The currency associated with the invoice.

description

string A brief description of the invoice.

notes

object Any custom notes added to the invoice. Maximum of 2048 characters.

short_url

string The short URL that is generated. This is the link that can be shared with the customer to receive payments.

type

string Here, it is invoice.

comment

string Any comments to be added in the invoice. Maximum of 2048 characters.

1.2.2. Send/Resend Notifications

The following endpoint sends/resends notifications with the short URL to the customer:

POST

/invoices/:id/notify_by/:medium

Path Parameters

mandatory

string The unique identifier of the invoice linked to the registration link for which you want to send the notification. For example, inv_1Aa00000000001.

medium

mandatory

string Determines through which medium you want to resend the notification. Possible values:

sms
email

Response Parameters

success

boolean Indicates whether the notifications were sent successfully. Possible values:

true: The notifications were successfully sent via SMS, email or both.
false: The notifications were not sent.

1.2.3. Cancel a Registration Link

The following endpoint cancels a registration link.

POST

/invoices/:id/cancel

Handy Tips

You can only cancel registration link in the issued state.

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-X POST https://api.razorpay.com/v1/invoices/inv_1Aa00000000001/cancel

{
    "id": "inv_FHrfRupD2ouKIt",
    "entity": "invoice",
    "receipt": "Receipt No. 1",
    "invoice_number": "Receipt No. 1",
    "customer_id": "cust_BMB3EwbqnqZ2EI",
    "customer_details": {
        "id": "cust_BMB3EwbqnqZ2EI",
        "name": "Nur Aisyah",
        "email": "nur.aisyah@example.com",
        "contact": "60345675444",
        "gstin": null,
        "billing_address": null,
        "shipping_address": null,
        "customer_name": "Nur Aisyah",
        "customer_email": "nur.aisyah@example.com",
        "customer_contact": "60345675444"
    },
    "order_id": "order_FHrfRw4TZU5Q2L",
    "line_items": [],
    "payment_id": null,
    "status": "cancelled",
    "expire_by": 4102444799,
    "issued_at": 1595491479,
    "paid_at": null,
    "cancelled_at": 1595491488,
    "expired_at": null,
    "sms_status": "sent",
    "email_status": "sent",
    "date": 1595491479,
    "terms": null,
    "partial_payment": false,
    "gross_amount": 100,
    "tax_amount": 0,
    "taxable_amount": 0,
    "amount": 100,
    "amount_paid": 0,
    "amount_due": 100,
    "currency": "MYR",
    "currency_symbol": "RM",
    "description": "Registration Link for Nur Aisyah",
    "notes": {
        "note_key 1": "Beam me up Scotty",
        "note_key 2": "Tea. Earl Gray. Hot."
    },
    "comment": null,
    "short_url": "https://rzp.io/i/QlfexTj",
    "view_less": true,
    "billing_start": null,
    "billing_end": null,
    "type": "link",
    "group_taxes_discounts": false,
    "created_at": 1595491480,
    "idempotency_key": null
}

Path Parameter

mandatory

string The unique identifier for the invoice linked to the registration link that you want to cancel. For example, inv_1Aa00000000001.

Response Parameters

string The unique identifier of the invoice.

entity

string The entity that has been created. Here, it is invoice.

receipt

string A user-entered unique identifier of the invoice.

invoice_number

string Unique number you added for internal reference.

customer_id

string The unique identifier of the customer. For example, cust_BMB3EwbqnqZ2EI.

customer_details

Details of the customer.

string The unique identifier associated with the customer to whom the invoice has been issued.

name

string The customer's name.

string The customer's email address.

contact

integer The customer's phone number.

billing_address

string Details of the customer's billing address.

shipping_address

string Details of the customer's shipping address.

order_id

string The unique identifier of the order associated with the invoice.

line_items

string Details of the line item that is billed in the invoice. Maximum of 50 line items are allowed.

payment_id

string Unique identifier of a payment made against the invoice.

status

string The status of the invoice. Possible values:

draft
issued
partially_paid
paid
cancelled
expired
deleted

expire_by

integer The Unix timestamp at which the invoice will expire.

issued_at

integer The Unix timestamp at which the invoice was issued to the customer.

paid_at

integer The Unix timestamp at which the payment was made.

cancelled_at

integer The Unix timestamp at which the invoice was cancelled.

expired_at

integer The Unix timestamp at which the invoice expired.

sms_status

string The delivery status of the SMS notification for the invoice sent to the customer. Possible values:

pending
sent

email_status

string The delivery status of the email notification for the invoice sent to the customer. Possible values:

pending
sent

date

integer Timestamp, in Unix format, that indicates the issue date of the invoice.

terms

string Any terms to be included in the invoice. Maximum of 2048 characters.

partial_payment

boolean Indicates whether the customer can make a partial payment on the invoice. Possible values:

true: The customer can make partial payments.
false (default): The customer cannot make partial payments.

amount

integer Amount to be paid using the invoice. Must be in the smallest unit of the currency. For example, if the amount to be received from the customer is RM 299.95, pass the value as 29995.

amount_paid

integer Amount paid by the customer against the invoice.

amount_due

integer The remaining amount to be paid by the customer for the issued invoice.

currency

string The currency associated with the invoice.

description

string A brief description of the invoice.

notes

object Any custom notes added to the invoice. Maximum of 2048 characters.

short_url

string The short URL that is generated. This is the link that can be shared with the customer to receive payments.

type

string Here, it is invoice.

comment

string Any comments to be added in the invoice. Maximum of 2048 characters.