Charge First Payment Automatically after NACH Registration

You can register a customer's mandate and charge them the first recurring payment as part of the same transaction. For this you have to pass the first_payment_amount parameter while creating the order.

The flow to complete an authorisation transaction using paper NACH differs from the other payment method's flow.

Create a customer.
Create an order by passing the customer_id and the method as nach. Razorpay generates a NACH form with the customer information pre-filled and ready to sign.
The customer can get the form in one of the following ways to sign it:
- You can download the form from the Dashboard and send it to the customer.
- A customer can download the form from the Hosted page (in the case of registration links).
The signed form can be uploaded in one of the following ways:
- Using the Standard Checkout page.
- Hosted page (in the case of registration links).
- The customer can send you the form and you can upload the form for the customer. The acceptable image formats and size are:
  - jpeg
  - jpg
  - png
  - Maximum accepted size is 6 MB.

Once the details are validated, the authorisation transaction is completed, and a token is generated. You can charge your customer as per your business model after the token status changes to confirmed.

1. Create an Authorization Transaction

You can create an authorisation transaction:

Using the
Razorpay Standard Checkout
.
Using a
Registration Link
.

1.1. Using Razorpay Standard Checkout

To create an authorisation transaction using the Razorpay Standard Checkout, 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 Razorpay order_id that is associated with the authorization transaction. The following endpoint creates an order.

POST

/orders

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/orders \
-H "Content-Type: application/json" \
-d '{
  "amount":0,
  "currency":"INR",
  "method":"nach",
  "customer_id": "cust_1Aa00000000001",
  "receipt": "Receipt No. 1",
  "notes": {
    "notes_key_1": "Beam me up Scotty",
    "notes_key_2": "Engage"
  },
  "token":{
    "first_payment_amount": 10000,
    "auth_type":"physical",
    "max_amount":10000000,
    "expire_at":1580480689,
    "notes": {
      "notes_key_1": "Tea, Earl Grey, Hot",
      "notes_key_2": "Tea, Earl Grey… decaf."
    },
    "bank_account":{
      "account_number":"11214311215411",
      "ifsc_code":"HDFC0000001",
      "beneficiary_name":"Gaurav Kumar",
      "account_type":"savings"
    },
    "nach":{
      "form_reference1":"Recurring Payment for Gaurav Kumar",
      "form_reference2":"Method Paper NACH",
      "description":"Paper NACH Gaurav Kumar"
    }
  }
}'

Download and Upload the Pre-filled NACH Form

Once the order is created, the generated pre-filled form must be downloaded, signed by your customer and uploaded back to Razorpay to complete the transaction.

You receive the following parameters as part of the response:

prefilled_form

The link from where you can download the pre-filled NACH form.

upload_form_url

The link where the NACH form should be uploaded once it is signed by the customer.

Request Parameters

amount

mandatory

integer Amount in currency subunits. For Paper NACH, the amount has to be 0.

currency

mandatory

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

method

mandatory

string The authorisation method. In this case the value will be nach.

customer_id

mandatory

string The unique identifier of the customer, who is to be charged. For example, cust_D0cs04OIpPPU1F.

receipt

optional

string A user-entered unique identifier for the order. For example, rcptid #1. This parameter should be mapped to the order_id sent by Razorpay.

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”.

token

Details related to the authorization transaction such as max amount and bank account information. Pass a value in the first_payment_amount parameter if you want to auto-charge the customer the first payment immediately after authorization.

first_payment_amount

optional

integer The amount, in paise, that should be auto-charged in addition to the authorization amount. For example, 100000.

auth_type

mandatory

string The payment method used to make the authorization payment. Here, it is physical.

bank_account

The customer's bank account details that is printed on the NACH form.

account_number

mandatory

string The customer's bank account number. For example 11214311215411.

ifsc_code

mandatory

string The customer's bank IFSC. For example UTIB0000001.

beneficiary_name

mandatory

string The customer's name. For example, Gaurav Kumar.

account_type

optional

string The customer's bank account type. Possible values:

savings (default)
current
cc (Cash Credit)
nre (SB-NRE)
nro (SB-NRO)

max_amount

optional

integer Use to set the maximum amount per debit request. The value can range from 500 - 1000000000 (1cr, default value).

expire_at

optional

integer The Unix timestamp that specifies when the registration link should expire. The value can range from the current date to 01-19-2038 (2147483647).

nach

Additional information to be printed on the NACH form that your customer will sign.

form_reference1

optional

string A user-entered reference that appears on the NACH form.

form_reference2

optional

string A user-entered reference that appears on the NACH form.

description

optional

string A user-entered description that appears on the hosted page. For example, Form for Gaurav Kumar.

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 A unique identifier of the order created. For example order_1Aa00000000001.

entity

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

amount

integer Amount in currency subunits. For emandate, the amount should be 0.

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 INR.

receipt

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

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.

token

Details related to the authorisation such as max amount and bank account information.

auth_type

string Emandate type used to make the authorisation payment. Possible values:

netbanking
debitcard
aadhaar

max_amount

integer The maximum amount in paise a customer can be charged in a transaction. The value can range from 500 to 100000000. The default value is 9999900 (₹99,999).

expire_at

integer The Unix timestamp to indicate till when you can use the token (authorisation on the payment method) to charge the customer subsequent payments. The default value is 10 years for emandate. This value can range from the current date to 31-12-2099 (4102444799).

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”.

bank_account

Customer's bank account details that should be pre-filled on the checkout.

account_number

string Customer's bank account number.

account_type

string Customer's bank account type. Possible values:

savings (default value)
current

ifsc_code

string Customer's bank IFSC. For example UTIB0000001.

beneficiary_name

string Name of the beneficiary. For example, Gaurav Kumar.

Download and Upload the Pre-filled NACH Form

Once the order is created, the pre-filled form must be downloaded, signed by your customer and uploaded back to Razorpay to complete the transaction.

You receive the following parameters as part of the response:

prefilled_form

The link from where you can download the pre-filled NACH form.

upload_form_url

The link where the NACH form should be uploaded once it is signed by the customer.

Authorisation transaction + auto-charge first payment:

You can register a customer's mandate and charge them the first recurring payment as part of the same transaction. Refer to the

Paper NACH section under Registration and Charge First Payment Together

for more information.

You can create a payment against the order_id after it is created.

1.1.3. Create an Authorization Payment

You should create an authorization payment after you create an order.

To create an authorization payment:

Download the Paper NACH form and send it to the customers.
Ask the customers to fill the form and either
Upload via Checkout
or send it to you to upload the form using the
create NACH File API
.

1.1.3.1 Upload the NACH File via Checkout

Create a payment checkout form for customers to upload the NACH form and make the Authorisation Transaction. 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

boolean Determines whether the recurring payment is enabled or not. Possible values:

1: Recurring payment is enabled.
0: Recurring payment is not enabled.

1.1.3.2 Upload the NACH File via API

You can upload the signed NACH forms that are collected from your customers using the create NACH File API, . Razorpay's OCR-enabled NACH engine submits the form to NPCI on successful verification and you will receive a success or a failure response.

Feature Request

This is an on-demand feature. Please raise a request with our

Support team

to get this feature activated on your Curlec account.

Use the following endpoint to upload the signed Paper NACH form via the API.

POST

/payments/create/nach/file

Use the following API to upload the NACH file sent by the customer.

Error Reasons

The below table lists the errors that may appear while uploading the NACH file, the reason, explanation and next steps:

1.2. Using a Registration Link

Registration Link is an alternate way of creating an authorization 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 authorization transaction.

When you create a registration link, an
invoice
is automatically issued to the customer. They can use this invoice to make the authorization payment.
A registration link should always have an order amount (in paise) the customer will be charged when making the authorization payment. This amount should be 0 in the case of Paper NACH.

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 for recurring payments.

POST

/subscription_registration/auth_links

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET>
-X POST https://api.razorpay.com/v1/subscription_registration/auth_links
-H "Content-Type: application/json" \
-d '{
  "customer":{
    "name":"Gaurav Kumar",
    "email":"gaurav.kumar@example.com",
    "contact":"9123456780"
  },
  "amount":0,
  "currency":"INR",
  "type":"link",
  "description":"12 p.m. Meals",
  "subscription_registration":{
    "method":"nach",
    "auth_type":"physical",
    "bank_account":{
      "beneficiary_name":"Gaurav Kumar",
      "account_number":"11214311215411",
      "account_type":"savings",
      "ifsc_code":"HDFC0001233"
    },
    "nach":{
      "form_reference1":"Recurring Payment for Gaurav Kumar",
      "form_reference2":"Method Paper NACH"
    },
    "expire_at":1947483647,
    "max_amount":50000
  },
  "receipt":"Receipt No. 1",
  "sms_notify":1,
  "email_notify":1,
  "expire_by":1647483647,
  "notes":{
    "note_key 1":"Beam me up Scotty",
    "note_key 2":"Tea. Earl Gray. Hot."
  }
}'

Download and Upload the Pre-filled NACH Form

Once the registration link is created, the customer should complete these steps:

Download the pre-filled form using the Download NACH Form option on the Razorpay hosted page.
Sign the form.
Upload the signed form using the Upload NACH Form option on the Razorpay hosted page.

Request Parameters

customer

Details of the customer to whom the registration link will be sent.

name

mandatory

string. Customer's name.

mandatory

string. Customer's email address.

contact

mandatory

string. Customer's phone number.

type

mandatory

string. In this case, the value is link.

currency

mandatory

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

amount

mandatory

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

description

mandatory

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

subscription_registration

Details of the authorization payment.

first_payment_amount

optional

integer The amount, in paise, the customer should be auto-charged in addition to the authorization amount. For example, 100000.

method

mandatory

string The NACH type used to make the authorization payment. Here, it is physical.

auth_type

mandatory

string The authorization method used to make the authorization transaction. Here, it is nach.

bank_account

The customer's bank account details.

beneficiary_name

mandatory

string The name on the beneficiary. For example, Gaurav Kumar.

account_number

mandatory

integer The customer's bank account number. For example, 11214311215411.

account_type

mandatory

string The customer's bank account type. Possible values:

savings
current

ifsc_code

mandatory

string The customer's bank IFSC. For example, HDFC0000001.

max_amount

optional

integer Use to set the maximum amount, in paise, per debit request. This value can range from 500 - 1000000000. The default value is 1cr.

expire_at

optional

integer The Unix timestamp till when you can use the token (authorization on the payment method) to charge the customer subsequent payments. The default value is 10 years for emandate. This value can range from the current date to 31-12-2099 (4101580799).

nach

Additional information to be printed on the NACH form that your customer will sign.

form_reference1

optional

string A user-entered reference that appears on the NACH form.

form_reference2

optional

string A user-entered reference that appears on the NACH form.

description

optional

string A user-entered description that appears on the hosted page. For example, Form for Gaurav Kumar.

sms_notify

optional

boolean Indicates if SMS notifications are to be sent by Razorpay. Can have the following values:

0 - Notifications are not sent by Razorpay.
1 - Notifications are sent by Razorpay(default value).

email_notify

optional

boolean Indicates if email notifications are to be sent by Razorpay. Can have the following values:

0 - Notifications are not sent by Razorpay.
1 - Notifications are sent by Razorpay (default value).

expire_by

optional

integer The timestamp, in Unix, till when the registration link should be available to the customer to make the authorization transaction.

receipt

optional

string A unique identifier entered by you for the order. For example, Receipt No. 1. This parameter should be mapped to the order_id sent by Razorpay.

notes

optional

object This is a 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 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

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.

2. Fetch and Manage Tokens

Once you capture a payment, Curlec Checkout returns a razorpay_payment_id. You can use this ID to fetch the token_id, which is used to create and charge subsequent payments.

You can retrieve the token_id in the following ways:

API
Dashboard

Know more about

Tokens

2.1. Fetch Token by Payment ID

Use the below endpoint to fetch the token_id using a payment_id.

GET

/payments/:id

Handy Tips

You can also retrieve the token_id via the

payment.authorized webhook

Path Parameter

mandatory

string The unique identifier of the payment to be retrieved. For example, pay_1Aa00000000002.

Response Parameters

string Unique identifier of the payment.

entity

string Indicates the type of entity. Here, it is payment.

amount

integer The payment amount represented in smallest unit of the currency passed. For example, amount = 100 translates to 100 subunits, that is RM 1.00.

currency

string The currency in which the payment is made.

status

string The status of the payment. Possible values:

created
authorized
captured
refunded
failed

order_id

string The unique identifier of the order.

invoice_id

string The unique identifier of the invoice.

international

boolean Indicates whether the payment is done via an international card or a domestic one.

method

string The payment method used for making the payment. Possible values:

card

amount_refunded

integer The amount refunded in smallest unit of the currency passed.

refund_status

string The refund status of the payment. Possible values:

null
partial
full

captured

boolean Indicates if the payment is captured.

description

string Description of the payment, if any.

string Customer email address used for the payment.

contact

integer Customer contact number used for the payment.

customer_id

string The unique identifier of the customer.

token_id

string The unique identifier of the token.

notes

json object Contains user-defined fields, stored for reference purposes.

fee

integer Fee charged by Curlec.

error_code

string Error that occurred during payment. For example, BAD_REQUEST_ERROR.

error_description

string Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP.

error_source

string The point of failure. For example, customer.

error_step

string The stage where the transaction failure occurred. The stages can vary depending on the payment method used to complete the transaction. For example, payment_authentication.

error_reason

string The exact error reason. For example, incorrect_otp.

created_at

integer Timestamp, in UNIX format, on which the payment was created.

2.2. Fetch Tokens by Customer ID

Use the below endpoint to fetch tokens linked to a customer.

A customer can have multiple tokens tied to them. These tokens can be used to create subsequent payments for multiple products or services.

Watch Out!

This endpoint will not fetch the details of expired and unused tokens.

GET

/customers/:id/tokens

Path Parameter

mandatory

string The unique identifier of the customer for whom tokens are to be retrieved. For example, cust_1Aa00000000002.

Response Parameters

entity

string The entity being created. Here, it is a collection.

count

integer The number of tokens to be fetched.

items

Details related to token such as token id and bank information.

string The unique identifier linked to an item. In this example, it is token_id.

entity

string The entity being created. Here, it is a token.

token

string The token is being fetched.

bank

string Card issuing bank details.

wallet

string Provides wallet information.

method

string The payment method used to make the transaction.

card

Details related to card used to make the transaction.

entity

string The entity being created. Here, it is card.

name

string Name of the cardholder.

last4

integer Last 4 digits of the card.

network

string Name of the payment processor. Here it is Visa.

type

string Card type (debit or credit). In this example, it is credit.

issuer

string Name of the card-issuing bank.

international

string Card usage restriction. Possible values:

true: Supports international transactions.
false: International transactions are not supported.

emi

string Card EMI status. Possible values.

true: The card is on EMI.
false: The card is not on EMI.

sub_type

string Type of the customer.

expiry_month

integer Month on which the card expires.

expiry_year

integer Year on which the card expires.

flows

The transaction flow details.

otp

string Whether the OTP function is enabled or not. Possible values:

true: The OTP function is enabled.
false: The OTP function is not enabled.

recurring

string Whether the recurring for this payment method is enabled or not. Possible Values:

true: Recurring is enabled.
false: Recurring is not enabled.

recurring

string This represents whether recurring is enabled for this token or not. Possible values:

true: Recurring is enabled.
false: Recurring is not enabled.

recurring_details

object Details of the recurring transaction.

status

string This represents the status of the recurring transaction. Possible values:

initiated
confirmed
rejected
cancelled
paused

failure_reason

string This provides the reason why the recurring transaction failed.

auth_type

string The authorisation type details.

mrn

string The unique identifier issued by the payment gateway during customer registration. This can be Gateway Reference Number or Gateway Token.

used_at

integer The VPA usage timestamp.

created_at

integer The token creation timestamp.

expired_at

integer The token expiry date timestamp.

dcc_enabled

string Indicates whether the option to change currency is enabled or not. Possible values.

true: The option to change currency is enabled
false: The option to change currency is not enabled.

2.3. Delete Tokens

The following endpoint deletes a token.

DELETE

/customers/:customer_id/tokens/:token_id

Path Parameter

customer_id

mandatory

string The unique identifier of the customer with whom the token is linked. For example, cust_1Aa00000000002.

token_id

mandatory

string The unique identifier of the token that is to be deleted. For example, token_1Aa00000000001.

Response Parameters

deleted

boolean Indicates whether the token is deleted. Possible values:

true: The token is deleted successfully.
false: The token was not deleted.

3. Create Subsequent Payments

You should perform the following steps to create and charge your customer subsequent payments:

3.1. Create an Order to Charge the Customer

You have to create a new order every time you want to charge your customers. This order is different from the one created during the authorisation transaction.

The following endpoint creates an order.

POST

/orders

Request Parameters

amount

mandatory

integer Amount in currency subunits. For cards, the minimum value is 100 (RM 1.00).

currency

mandatory

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

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 of 15 key-value pairs, 256 characters each. For example, "note_key": "Beam me up Scotty”.

payment_capture

mandatory

boolean Determines whether the payment status should be changed to captured automatically or not. Possible values:

true: Payments are captured automatically.
false: Payments are not captured automatically. You can manually capture payments using the
Manually Capture Payments API
.

Response Parameters

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

entity

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

amount

integer Amount in currency subunits.

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, rcptid #1.

status

string The status of the order.

notes

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

created_at

integer The Unix timestamp at which the order was created.

3.2. Create a Recurring Payment

Once you have generated an order_id, use it with the token_id to create a payment and charge the customer. The following endpoint creates a payment to charge the customer.

POST

/payments/create/recurring

Request Parameters

amount

mandatory

integer The amount you want to charge your customer. This should be the same as the order amount.

order_id

mandatory

string The unique identifier of the order created. For example, order_1Aa00000000002.

customer_id

mandatory

string The unique identifier of the customer you want to charge. For example, cust_1Aa00000000002.

token

mandatory

string The token_id generated when the customer successfully completes the authorisation payment. Different payment instruments for the same customer have different token_id.

recurring

mandatory

boolean Determines whether recurring payment is enabled or not.

description

optional

string A user-entered description for the payment. For example, Creating recurring payment for Nur Aisyah

notes

optional

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

Response Parameters

razorpay_payment_id

string The unique identifier of the payment that is created. For example, pay_1Aa00000000001.

razorpay_order_id

string The unique identifier of the order that is created. For example, order_1Aa00000000001.

razorpay_signature

string The signature generated by the Razorpay. For example, 9ef4dffbfd84f1318f6739a3ce19f9d85851857ae648f114332d8401e0949a3d.