Api

Payments

Payment Links

Prefill Checkout Fields

Prefill payment methods, bank names and partial payment-related fields for Payment Links using Razorpay APIs.

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.

 Curl PHP Node.JS Python Go Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/payment_links/ \
-H 'Content-type: application/json' \
-d '{
  "amount": 1000,
  "currency": "INR",
  "accept_partial": true,
  "first_min_partial_amount": 100,
  "reference_id": "#417",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "Gaurav Kumar",
    "contact": "+919999999999",
    "email": "gaurav.kumar@example.com"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": true,
  #customization parameters start below#
  "options": {
    "checkout": {
      "prefill": {
        "method": "card",
        "card[name]": "Gaurav Kumar",
        "card[number]": "4111111111111111",
        "card[expiry]": "12/21",
        "card[cvv]": "123"
      }
    }
  }
}'

Copy$api = new Api($key_id, $secret);

$api->paymentLink->create(array('amount'=>500, 'currency'=>'INR', 'accept_partial'=>true, 'first_min_partial_amount'=>100, 'description' => 'For XYZ purpose', 'customer' => array('name'=>'Gaurav Kumar', 'email' => 'gaurav.kumar@example.com', 'contact'=>'+919999999999'),  'notify'=>array('sms'=>true, 'email'=>true) ,'reminder_enable'=>true , 'options'=>array('checkout'=>array('prefill'=>array('method'=>'card', 'card[name]'=>'Gaurav Kumar', 'card[number]'=>'4111111111111111', 'card[expiry]'=>'12/21', 'card[cvv]'=>'123')))));

Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.paymentLink.create({
  amount: 1000,
  currency: "INR",
  accept_partial: true,
  first_min_partial_amount: 100,
  reference_id: "#417",
  description: "Payment for policy no #23456",
  customer: {
    name: "Gaurav Kumar",
    contact: "919999999999",
    email: "gaurav.kumar@example.com"
  },
  notify: {
    sms: true,
    email: true
  },
  reminder_enable: true,
  options: {
    checkout: {
      prefill: {
        method: "card",
        "card[name]": "Gaurav Kumar",
        "card[number]": 4111111111111111,
        "card[expiry]": "12/21",
        "card[cvv]": 123
      }
    }
  }
})

Copyimport razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.payment_link.create({
  "amount": 1000,
  "currency": "INR",
  "accept_partial": true,
  "first_min_partial_amount": 100,
  "reference_id": "#417",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "Gaurav Kumar",
    "contact": "+919999999999",
    "email": "gaurav.kumar@example.com"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": true,
  "options": {
    "checkout": {
      "prefill": {
        "method": "card",
        "card[name]": "Gaurav Kumar",
        "card[number]": "4111111111111111",
        "card[expiry]": "12/21",
        "card[cvv]": "123"
      }
    }
  }
})

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

data := map[string]interface{}{
  "amount": 1000,
  "currency": "INR",
  "accept_partial": true,
  "first_min_partial_amount": 100,
  "reference_id": "#417",
  "description": "Payment for policy no #23456",
  "customer": map[string]interface{}{
    "name": "Gaurav Kumar",
    "contact": "+919999999999",
    "email": "gaurav.kumar@example.com",
  },
  "notify": map[string]interface{}{
    "sms": true,
    "email": true,
  },
  "reminder_enable": true,
  "options": map[string]interface{}{
    "checkout": map[string]interface{}{
      "prefill": map[string]interface{}{
        "method": "card",
        "card[name]": "Gaurav Kumar",
        "card[number]": "4111111111111111",
        "card[expiry]": "12/21",
        "card[cvv]": "123",
      },
    },
  },
}
body, err := client.PaymentLink.Create(data, nil)

Copy{
  "accept_partial": true,
  "amount": 1000,
  "amount_paid": 0,
  "callback_method": "",
  "callback_url": "",
  "cancelled_at": 0,
  "created_at": 1596190090,
  "currency": "INR",
  "customer": {
    "contact": "+919999999999",
    "email": "gaurav.kumar@example.com",
    "name": "Gaurav Kumar"
  },
  "deleted_at": 0,
  "description": "Payment for policy no #23456",
  "expire_by": 0,
  "expired_at": 0,
  "first_min_partial_amount": 100,
  "id": "plink_FL42siKlvMzVe8",
  "notes": null,
  "notify": {
    "email": true,
    "sms": true
  },
  "payments": null,
  "reference_id": "#417",
  "reminder_enable": true,
  "reminders": [],
  "short_url": "https://rzp.io/i/lWKFRcp",
  "source": "",
  "source_id": "",
  "status": "created",
  "updated_at": 1596190090,
  "user_id": ""
}

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

array Prefills the payment method and related details on Checkout.

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
upi

bank use when method=netbanking

string Prefills the customer's bank code. The value must be entered in upper case. For example, "HDFC".

card[number] use when method=card

string Unformatted card number.

card[name] use when method=card

string The name of the cardholder.

card[expiry] use when method=card

string Expiry month and year for card in MM/YY format.

wallet use when method=wallet

string Wallet code.

vpa use when method=upi

string UPI ID for making the payment on the UPI app.

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, as explained in the checkout theme section.

Partial Payment Fields🔗

If you have enabled partial payments on the link, the following options will appear in the Checkout section. You can preselect one of these options when sending the link to the customer.

Pay in Full
Make payment in parts

 Request Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/payment_links/ \
-H 'Content-type: application/json' \
-d '{
  "amount": 1000,
  "currency": "INR",
  "accept_partial": true,
  "first_min_partial_amount": 100,
  "reference_id": "#419",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "Gaurav Kumar",
    "contact": "+919999999999",
    "email": "gaurav.kumar@example.com"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": true,
  #customization parameters start below#
  "options": {
    "checkout": {
      "prefill": {
        "select_partial": true
      }
    }
  }
}'
Copy{
  "accept_partial": true,
  "amount": 1000,
  "amount_paid": 0,
  "callback_method": "",
  "callback_url": "",
  "cancelled_at": 0,
  "created_at": 1596190312,
  "currency": "INR",
  "customer": {
    "contact": "+919999999999",
    "email": "gaurav.kumar@example.com",
    "name": "Gaurav Kumar"
  },
  "description": "Payment for policy no #23456",
  "expire_by": 0,
  "expired_at": 0,
  "first_min_partial_amount": 100,
  "id": "plink_FL46mXQEVvDFT7",
  "notes": null,
  "notify": {
    "email": true,
    "sms": true
  },
  "payments": null,
  "reference_id": "#199912",
  "reminder_enable": true,
  "reminders": [],
  "short_url": "https://rzp.io/i/kxCgQgm",
  "source": "",
  "source_id": "",
  "status": "created",
  "updated_at": 1596190312,
  "user_id": ""
}

Request Parameters🔗

List of parameters to be sent with Create Payment Link API to set partial payment/full payment as default.

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

array Prefills the partial payment related fields.

select_partial use when accept_partial=true

boolean Enable Make payment in parts by default on Checkout. Possible values:

true - Make payment in parts option enabled by default.
false - Make payment in parts option disabled by default.

select_full use when accept_partial=true

boolean Enable Pay in full by default on Checkout. Possible values:

true - Pay in full option enabled by default.
false - Pay in full option disabled by default.

ON THIS PAGE

Partial Payment Fields

Request Parameters