Prefill Checkout Fields

You can customize the Checkout and prefill the following fields in a Payment Link:

Payment Method
You can prefill the payment method for customers, based on their past payment preferences. For example, you can ensure when the customer opens the link, card appears selected as the payment method.
- You can prefill the bank name (If netbanking is the prefilled payment method)
Partial Payment fields
If you have enabled partial payments on the link, the following options will appear in the Checkout section. You can ensure when the customer opens the link, either of these options appear selected.
- Pay in Full
- Make payment in parts

Original vs Customized Checkout🔗

Given below is a comparison of Checkout with and without prefilled customer information.

Original Checkout

Customized Checkout with Prefilled Payment Method and Bank Name

Payment Method🔗

Prefill the payment method for customers based on their past payment preferences. For example, you can ensure when the customer opens the link, card appears selected as the payment method.

Sample Code🔗

 Request - payment method - Card Response Request - payment method - Bank Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/invoices/ \
-H 'Content-type: application/json' \
-d '{
  "type": "link",
  "amount": 6899,
  "receipt": "#9822",
  "description": "Cloud Computing",
  "expire_by": 1679257270,
  "partial_payment": 1,
  "customer": {
    "name": "Gaurav Kumar",
    "contact": "9999999998",
    "email": "gaurav.kumar@example.com"
  },
  #customization parameters start below#
  "options": {
    "checkout": {
      "prefill": {
        "method": "card"
      }
    }
  }
}'
Copy{
  "id": "inv_EHmsOlFYzPolAf",
  "entity": "invoice",
  "receipt": "#9822",
  "invoice_number": "#9822",
  "customer_id": "cust_EHlIVDGkntl8OW",
  "customer_details": {
    "id": "cust_EHlIVDGkntl8OW",
    "name": "Gaurav Kumar",
    "email": "gaurav.kumar@example.com",
    "contact": "9999999998",
    "gstin": null,
    "billing_address": null,
    "shipping_address": null,
    "customer_name": "Gaurav Kumar",
    "customer_email": "gaurav.kumar@example.com",
    "customer_contact": "9999999998"
  },
  "order_id": "order_EHmsOnp7hxkxDl",
  "line_items": [],
  "payment_id": null,
  "status": "issued",
  "expire_by": 1679257270,
  "issued_at": 1581937520,
  "paid_at": null,
  "cancelled_at": null,
  "expired_at": null,
  "sms_status": "pending",
  "email_status": "pending",
  "date": 1581937520,
  "terms": null,
  "partial_payment": true,
  "gross_amount": 6899,
  "tax_amount": 0,
  "taxable_amount": 0,
  "amount": 6899,
  "amount_paid": 0,
  "amount_due": 6899,
  "currency": "INR",
  "description": "Cloud Computing",
  "notes": [],
  "comment": null,
  "short_url": "https://rzp.io/i/D2cbiXG",
  "view_less": true,
  "billing_start": null,
  "billing_end": null,
  "type": "link",
  "group_taxes_discounts": false,
  "user": null,
  "created_at": 1581937520
}
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/invoices/ \
-H 'Content-type: application/json' \
-d '{
  "type": "link",
  "amount": 6899,
  "receipt": "#9821",
  "description": "Cloud Computing",
  "expire_by": 1679257270,
  "partial_payment": 1,
  "customer": {
    "name": "Gaurav Kumar",
    "contact": "9999999998",
    "email": "gaurav.kumar@example.com"
  },
  "options": {
    "checkout": {
      "prefill": {
        "method": "netbanking",
        "bank": "HDFC"
      }
    }
  }
}'
Copy{
  "id": "inv_EHmtdOg6zBvFRQ",
  "entity": "invoice",
  "receipt": "#9823",
  "invoice_number": "#9823",
  "customer_id": "cust_EHlIVDGkntl8OW",
  "customer_details": {
    "id": "cust_EHlIVDGkntl8OW",
    "name": "Gaurav Kumar",
    "email": "gaurav.kumar@example.com",
    "contact": "9999999998",
    "gstin": null,
    "billing_address": null,
    "shipping_address": null,
    "customer_name": "Gaurav Kumar",
    "customer_email": "gaurav.kumar@example.com",
    "customer_contact": "9999999998"
  },
  "order_id": "order_EHmtdQvKEZVJTG",
  "line_items": [],
  "payment_id": null,
  "status": "issued",
  "expire_by": 1679257270,
  "issued_at": 1581937591,
  "paid_at": null,
  "cancelled_at": null,
  "expired_at": null,
  "sms_status": "pending",
  "email_status": "pending",
  "date": 1581937591,
  "terms": null,
  "partial_payment": true,
  "gross_amount": 6899,
  "tax_amount": 0,
  "taxable_amount": 0,
  "amount": 6899,
  "amount_paid": 0,
  "amount_due": 6899,
  "currency": "INR",
  "description": "Cloud Computing",
  "notes": [],
  "comment": null,
  "short_url": "https://rzp.io/i/2LocWQD",
  "view_less": true,
  "billing_start": null,
  "billing_end": null,
  "type": "link",
  "group_taxes_discounts": false,
  "user": null,
  "created_at": 1581937591
}

Request Parameters🔗

List of request parameters to be used with the Create Payment Link API to create a prefilled, custom Payment Link.

options mandatory

array Options to customize Checkout. Parent parameter under which the checkout and prefill child parameters must be passed.

checkout mandatory

array The parameter for the checkout section. prefill is its child parameters. Pass the prefill parameters under this child parameter.

prefill.method optional: string Pre-selection of the payment method for the customer. Will only work if contact and email are also pre-filled. Possible values are:
- card
- netbanking
- wallet
- emi
- upi
prefill.bank optional: string Used to prefill the customer's bank code. The value must be entered in upper case. For example, "HDFC". To be used only when the method selected is netbanking.
prefill.wallet optional: string Wallet code. Required if value of the method is wallet. To be used only when the method selected is wallet.
prefill.vpa optional: string UPI handle for making the payment on the UPI app. To be used only when the method selected is upi.

Restrict Customer from Selecting Another Payment Method🔗

When you use prefill, the customer is directly led to that specific payment method on Checkout. However, they can use the back icon on the top bar and choose another method. You can restrict the customer from selecting another payment method by hiding the top bar. This can be done by setting the hide_topbar parameter to true under the theme parent parameter.

 Request Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/invoices/ \
-H 'Content-type: application/json' \
-d '{
  "type":"link",
  "amount":6899,
  "receipt":"#9869",
  "description":"Cloud Computing",
  "expire_by": 1579257270,
  "partial_payment":1,
  "customer":{
    "name":"Gaurav Kumar",
    "contact":"9999999998",
    "email":"gaurav.kumar@example.com"
  },
  #customization parameters start below#
  "options":{
    "checkout":{
      "theme":{
        "hide_topbar": true
      }
    }
  }
}'
Copy{
  "id":"inv_DkUZ3qvjS6Nt4S",
  "entity":"invoice",
  "receipt":"#9869",
  "invoice_number":"#9869",
  "customer_id":"cust_DjLt84my82blgz",
  "customer_details":{
    "id":"cust_DjLt84my82blgz",
    "name":"Gaurav Kumar",
    "email":"gaurav.kumar@example.com",
    "contact":"9999999998",
    "gstin":null,
    "billing_address":null,
    "shipping_address":null,
    "customer_name":"Gaurav Kumar",
    "customer_email":"gaurav.kumar@example.com",
    "customer_contact":"9999999998"
  },
  "order_id":"order_DjLt86lTzUOAx4",
  "line_items":[],
  "payment_id":null,
  "status":"issued",
  "expire_by":1579257270,
  "issued_at":1574418915,
  "paid_at":null,
  "cancelled_at":null,
  "expired_at":null,
  "sms_status":"pending",
  "email_status":"pending",
  "date":1574418915,
  "terms":null,
  "partial_payment":true,
  "gross_amount":6899,
  "tax_amount":0,
  "taxable_amount":0,
  "amount":6899,
  "amount_paid":0,
  "amount_due":6899,
  "currency":"INR",
  "description":"Cloud Computing",
  "notes":[

  ],
  "comment":null,
  "short_url":"https://rzp.io/i/bClD2m",
  "view_less":true,
  "billing_start":null,
  "billing_end":null,
  "type":"link",
  "group_taxes_discounts":false,
  "created_at":1574418915
}

Partial Payment Fields🔗

If you have enabled partial payments on the link, the following options will appear in the Checkout section. You can ensure when the customer opens the link, either of these options will appear selected.

Pay in Full
Make payment in parts