Bank Transfer on Hosted Checkout

You can now accept payments from customers in the form of online bank transfers, using the Razorpay Checkout form.

How it Works

Customer selects bank transfer as the payment method on Hosted Checkout.
A virtual bank account is created with bank account number and IFSC details and displayed to the customer.
Customer copies these details and make a netbanking payment from their online banking portal.

These virtual bank accounts are linked to the bank account you have registered with Razorpay. The money will be settled to your account as per the settlement schedule.

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.

You can choose:

Method 1: Create New Virtual Bank Account Per Order

This creates a new virtual bank account every time a customer selects bank transfer as the payment method on Hosted Checkout.

Integration

The bank transfer payment method will appear for the

payment gateway

and products such as Payment Links, Payment Pages and Subscriptions.

Complete the following steps to integrate this payment method on your Razorpay Hosted Checkout Integration:

Create Order.
Pass method and order_id to Hosted Checkout.
Subscribe to webhooks event.

Step 1: Create an Order

Order is an important step in the payment process.

An order should be created for every payment.
You can create an order using the
Orders API
. It is a server-side API call. Know how to
authenticate
Orders API.
The order_id received in the response should be passed to the checkout. This ties the order with the payment and secures the request from being tampered.

API Sample Code

Use this endpoint to create an order using the Orders API.

POST

/orders

curl -X POST https://api.razorpay.com/v1/orders
-U [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-H 'content-type:application/json'
-d '{
   "amount": 100,
   "currency": "MYR",
   "receipt": "qwsaq1",
   "partial_payment": true,
   "first_payment_min_amount": 230,
   "notes": {
     "key1": "value3",
     "key2": "value2"
   }
 }'

Request Parameters

amount

mandatory

integer The amount to be paid by the customer in sen. For example, if the amount is RM 500.00, enter 50000.

currency

mandatory

string The currency in which the payment should be made by the customer. Length must be of 3 characters.

receipt

optional

string Your receipt id for this order should be passed here. Maximum length is 40 characters.

notes

optional

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

partial_payment

optional

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

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

first_payment_min_amount

optional

integer Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of RM 7,000.00 is to be received from the customer in two installments of #1 - RM 5,000.00, #2 - RM 2,000.00 then you can set this value as 500000. This parameter should be passed only if partial_payment is true.

Know more about

Orders API

Response Parameters

Descriptions for the response parameters are present in the

Orders Entity

parameters table.

Error Response Parameters

The error response parameters are available in the

API Reference Guide

Step 2: Add `method` parameter to Hosted Checkout

Update your integration with the method and order parameters as shown below. This will display bank transfer as a payment method.

<form method="POST" action="https://api.razorpay.com/v1/checkout/embedded">
  <input type="hidden" name="key_id" value="<YOUR_KEY_ID/>">
  <input type="hidden" name="method[smartcollect]" value="true"/>// Adds bank transfer payment method
  <input type="hidden" name="order_id" value="order_FbJH3SKUvsyPTL"/> //Generated using Orders API at server-side
  <input type="hidden" name="name" value="Acme Corp"/>
  <input type="hidden" name="description" value="A Wild Sheep Chase"/>
  <input type="hidden" name="theme[color]" value="#3399cc"/>
  <input type="hidden" name="image" value="https://cdn.razorpay.com/logos/BUVwvgaqVByGp2_large.jpg"/>
  <input type="hidden" name="prefill[name]" value="Saurav Kumar"/>
  <input type="hidden" name="prefill[contact]" value="9123456780"/>
  <input type="hidden" name="prefill[email]" value="gaurav.kumar@example.com"/>
  <input type="hidden" name="notes[shipping address]" value="L-16, The Business Centre, 61 Wellfield Road, New Delhi - 110001"/>
  <input type="hidden" name="callback_url" value="https://example.com/payment-callback"/>
  <input type="hidden" name="cancel_url" value="https://example.com/payment-cancel"/>
  <button>Submit</button>
</form>

Request Parameter

method[smartcollect]

mandatory

boolean Display bank transfer payment method on Checkout. Possible values:

true: Bank transfer payment method is displayed on Checkout.
false: Bank transfer payment method is not displayed on Checkout.

You must subscribe to the virtual_account.credited webhook event on the Razorpay Dashboard to receive notifications whenever customers make payments using bank transfers. Learn how to

setup webhooks

Sample Payload

{
  "entity": "event",
  "account_id": "acc_BFQ7uQEaa7j2z7",
  "event": "virtual_account.credited",
  "contains": [
    "payment",
    "virtual_account",
    "bank_transfer"
  ],
  "payload": {
    "payment": {
      "entity": {
        "id": "pay_DETA2KrOlhqQzF",
        "entity": "payment",
        "amount": 50000,
        "currency": "INR",
        "status": "captured",
        "order_id": "order_DBJOWzybf0sJbb",
        "invoice_id": null,
        "international": false,
        "method": "bank_transfer",
        "amount_refunded": 0,
        "amount_transferred": 0,
        "refund_status": null,
        "captured": true,
        "description": "NA",
        "card_id": null,
        "bank": null,
        "wallet": null,
        "vpa": null,
        "email": "gaurav.kumar@example.com",
        "contact": "+919000090000",
        "customer_id": "cust_1Aa00000000004",
        "notes": [],
        "fee": 731,
        "tax": 112,
        "error_code": null,
        "error_description": null,
        "created_at": 1567675983
      }
    },
    "virtual_account": {
      "entity": {
        "id": "va_DET8z3wBxfPB5L",
        "name": "Acme Corp",
        "entity": "virtual_account",
        "status": "active",
        "description": "Virtual Account to test webhook",
        "amount_expected": null,
        "notes": {
          "Important": "Notes for Internal Reference"
        },
        "amount_paid": 50000,
        "customer_id": "cust_1Aa00000000004",
        "close_by": null,
        "closed_at": null,
        "created_at": 1567675923,
        "receivers": [
          {
            "id": "ba_DET8z5Z5ghv4hW",
            "entity": "bank_account",
            "ifsc": "RATN0VAAPIS",
            "bank_name": "RBL Bank",
            "name": "Acme Corp",
            "account_number": "1112220006712324"
          }
        ]
      }
    },
    "bank_transfer": {
      "entity": {
        "id": "bt_DETA2KSUJ3uCM9",
        "entity": "bank_transfer",
        "payment_id": "pay_DETA2KrOlhqQzF",
        "mode": "NEFT",
        "bank_reference": "156767598340",
        "amount": 50000,
        "payer_bank_account": {
          "id": "ba_DETA2UuuKtKLR1",
          "entity": "bank_account",
          "ifsc": "KKBK0000007",
          "bank_name": "Kotak Mahindra Bank",
          "name": "Gaurav Kumar",
          "account_number": "765432123456789"
        },
        "virtual_account_id": "va_DET8z3wBxfPB5L"
      }
    }
  },
  "created_at": 1567675983
}

Method 2: Create New Virtual Bank Account Per Customer

This ensures that each customer will be allocated a unique virtual bank account, whenever they use bank transfer method on Hosted Checkout. This method requires specific integration steps, which are mentioned in the following section.

Integration

The bank transfer payment method will appear for the

payment gateway

and products such as Payment Links, Invoices and Subscriptions.

Complete the following steps to integrate this payment method on your Razorpay Hosted Checkout Integration:

Create a Customer.
Create an Order.
Pass method, customer_id and order_id to Hosted Checkout.
Subscribe to webhooks event.

Step 1: Create a Customer

You must create a customer using the Customers ID. You can also do same using the Razorpay Dashboard.

The following endpoint creates or add a customer with basic details such as name and contact details. You can use this API for various Curlec Solution offerings.

POST

/customers

Request Parameters

name

optional

string Customer's name. Alphanumeric value with period (.), apostrophe ('), forward slash (/), at (@) and parentheses are allowed. The name must be between 3-50 characters in length. For example, Nur Aisyah.

contact

optional

string The customer's phone number. A maximum length of 15 characters including country code. For example, +60748901142.

optional

string The customer's email address. A maximum length of 64 characters. For example, gaurav.kumar@example.com.

fail_existing

optional

string Possible values:

0: If a customer with the same details already exists, fetches details of the existing customer.
1 (default): If a customer with the same details already exists, throws an error.

notes

optional

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

Request Parameters

string Unique identifier of the customer. For example, cust_1Aa00000000004.

name

string Customer's name. Alphanumeric, with period (.), apostrophe ('), forward slash (/), at (@) and parentheses allowed. The name must be between 3-50 characters in length. For example, Gaurav Kumar.

contact

string The customer's phone number. A maximum length of 15 characters including country code. For example, +919876543210.

string The customer's email address. A maximum length of 64 characters. For example, gaurav.kumar@example.com.

gstin

string GST number linked to the customer. For example, 29XAbbA4369J1PA.

notes

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

created_at

integer UNIX timestamp, when the customer was created. For example, 1234567890.

Pass the customer_id available in the response to Checkout.

Step 2: Create an Order

Order is an important step in the payment process.

An order should be created for every payment.
You can create an order using the
Orders API
. It is a server-side API call. Know how to
authenticate
Orders API.
The order_id received in the response should be passed to the checkout. This ties the order with the payment and secures the request from being tampered.

API Sample Code

Use this endpoint to create an order using the Orders API.

POST

/orders

curl -X POST https://api.razorpay.com/v1/orders
-U [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-H 'content-type:application/json'
-d '{
   "amount": 100,
   "currency": "MYR",
   "receipt": "qwsaq1",
   "partial_payment": true,
   "first_payment_min_amount": 230,
   "notes": {
     "key1": "value3",
     "key2": "value2"
   }
 }'

Request Parameters

amount

mandatory

integer The amount to be paid by the customer in sen. For example, if the amount is RM 500.00, enter 50000.

currency

mandatory

string The currency in which the payment should be made by the customer. Length must be of 3 characters.

receipt

optional

string Your receipt id for this order should be passed here. Maximum length is 40 characters.

notes

optional

partial_payment

optional

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

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

first_payment_min_amount

optional

Know more about

Orders API

Response Parameters

Descriptions for the response parameters are present in the

Orders Entity

parameters table.

Error Response Parameters

The error response parameters are available in the

API Reference Guide

Step 3: Pass `customer_id` and `order_id` to Hosted Checkout

You must pass the customer_id and order_id generated in the previous steps to Checkout, as shown below:

<form method="POST" action="https://api.razorpay.com/v1/checkout/embedded">
  <input type="hidden" name="key_id" value="<YOUR_KEY_ID/>">
  <input type="hidden" name="method[smartcollect]" value="true"/>//Adds bank transfer payment method
  <input type="hidden" name="customer_id" value="cust_DYE3nsq7nr9UQF"/>//Customer identifier generated in Step 1
  <input type="hidden" name="order_id" value="order_FbKLglkm5uGOjS"/>/Order identifier generated in Step 2
  <input type="hidden" name="name" value="Acme Corp"/>
  <input type="hidden" name="description" value="A Wild Sheep Chase"/>
  <input type="hidden" name="theme[color]" value="#3399cc"/>
  <input type="hidden" name="image" value="https://cdn.razorpay.com/logos/BUVwvgaqVByGp2_large.jpg"/>
  <input type="hidden" name="prefill[name]" value="Saurav Kumar"/>
  <input type="hidden" name="prefill[contact]" value="9123456780"/>
  <input type="hidden" name="prefill[email]" value="gaurav.kumar@example.com"/>
  <input type="hidden" name="notes[shipping address]" value="L-16, The Business Centre, 61 Wellfield Road, New Delhi - 110001"/>
  <input type="hidden" name="callback_url" value="https://example.com/payment-callback"/>
  <input type="hidden" name="cancel_url" value="https://example.com/payment-cancel"/>
  <button>Submit</button>
</form>

Request Parameter

method[smartcollect]

mandatory

boolean Display bank transfer payment method on Checkout. Possible values:

true: Bank transfer payment method is displayed on Checkout.
false: Bank transfer payment method is not displayed on Checkout.

customer_id

mandatory

string Unique identifier of the customer to whom the virtual account has been allocated.

Generated in Step 1

order_id

mandatory

string Unique identifier of the order.

Generated in Step 2

Read More:

List of parameters for Hosted Checkout

You must subscribe to the virtual_account.credited webhook event on the Razorpay Dashboard to receive notifications whenever customers make payments using bank transfers. Learn how to

setup webhooks

Sample Payload

{
  "entity": "event",
  "account_id": "acc_BFQ7uQEaa7j2z7",
  "event": "virtual_account.credited",
  "contains": [
    "payment",
    "virtual_account",
    "bank_transfer"
  ],
  "payload": {
    "payment": {
      "entity": {
        "id": "pay_DETA2KrOlhqQzF",
        "entity": "payment",
        "amount": 50000,
        "currency": "INR",
        "status": "captured",
        "order_id": "order_DBJOWzybf0sJbb",
        "invoice_id": null,
        "international": false,
        "method": "bank_transfer",
        "amount_refunded": 0,
        "amount_transferred": 0,
        "refund_status": null,
        "captured": true,
        "description": "NA",
        "card_id": null,
        "bank": null,
        "wallet": null,
        "vpa": null,
        "email": "gaurav.kumar@example.com",
        "contact": "+919000090000",
        "customer_id": "cust_1Aa00000000004",
        "notes": [],
        "fee": 731,
        "tax": 112,
        "error_code": null,
        "error_description": null,
        "created_at": 1567675983
      }
    },
    "virtual_account": {
      "entity": {
        "id": "va_DET8z3wBxfPB5L",
        "name": "Acme Corp",
        "entity": "virtual_account",
        "status": "active",
        "description": "Virtual Account to test webhook",
        "amount_expected": null,
        "notes": {
          "Important": "Notes for Internal Reference"
        },
        "amount_paid": 50000,
        "customer_id": "cust_1Aa00000000004",
        "close_by": null,
        "closed_at": null,
        "created_at": 1567675923,
        "receivers": [
          {
            "id": "ba_DET8z5Z5ghv4hW",
            "entity": "bank_account",
            "ifsc": "RATN0VAAPIS",
            "bank_name": "RBL Bank",
            "name": "Acme Corp",
            "account_number": "1112220006712324"
          }
        ]
      }
    },
    "bank_transfer": {
      "entity": {
        "id": "bt_DETA2KSUJ3uCM9",
        "entity": "bank_transfer",
        "payment_id": "pay_DETA2KrOlhqQzF",
        "mode": "NEFT",
        "bank_reference": "156767598340",
        "amount": 50000,
        "payer_bank_account": {
          "id": "ba_DETA2UuuKtKLR1",
          "entity": "bank_account",
          "ifsc": "KKBK0000007",
          "bank_name": "Kotak Mahindra Bank",
          "name": "Gaurav Kumar",
          "account_number": "765432123456789"
        },
        "virtual_account_id": "va_DET8z3wBxfPB5L"
      }
    }
  },
  "created_at": 1567675983
}

Try It Out

To understand how your customers can transfer money to you:

Launch our demo Standard Checkout.
Provide your phone number and email address.
Select Bank Transfer as your payment method.
Click Copy Details to copy the account number, IFSC and Beneficiary Name.
Go to your preferred netbanking portal, enter the copied details and initiate an online bank transfer.

Live Payment

This initiates a live payment. The amount will be refunded within 5-7 days.