Rename Labels in Checkout Section

You can change the labels for the fields related to partial payments.

When you enable partial payments for a Payment Link, the following fields appear in the payment request page:

Pay in full
Make payments in parts
Pay some now and the remaining later
Minimum first amount

You can replace the labels for these fields with custom labels that are specific to your business use case. You may even display labels in a different language.

Original vs Customized Checkout Section🔗

Given below is a comparison of the Checkout section before and after the fields are renamed.

Original Checkout Partial Payment Field Labels	Customized Checkout Partial Payment Field Labels

Sample Code🔗

Razorpay supports the display of labels in different languages.

 Request Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/invoices/ \
-H 'Content-type: application/json' \
-d '{
  "amount": 680000,
  "currency": "INR",
  "description": "Cloud Computing Course Fees",
  "type": "link",
  "partial_payment": 1,
  "receipt": "9977",
  "expire_by": 1679244401,
  "customer": {
    "name": "Gaurav Kumar",
    "contact": "9999999998",
    "email": "gaurav.kumar@example.com"
  },
  #customization parameters start below#
  "options": {
    "checkout": {
      "partial_payment": {
        "min_amount_label": "Minimum Money to be paid",
        "partial_amount_label": "Pay in parts",
        "partial_amount_description": "Pay atleast ₹100",
        "full_amount_label": "Pay the entire amount"
      }
    }
  }
}'
Copy{
  "id": "inv_E5UrRUQoICxMhe",
  "entity": "invoice",
  "receipt": "9977",
  "invoice_number": "9977",
  "customer_id": "cust_DnGpal0KVNz3Tj",
  "customer_details": {
    "id": "cust_DnGpal0KVNz3Tj",
    "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_E5UrRWpV1oqSIx",
  "line_items": [],
  "payment_id": null,
  "status": "issued",
  "expire_by": 1679244401,
  "issued_at": 1579253996,
  "paid_at": null,
  "cancelled_at": null,
  "expired_at": null,
  "sms_status": "pending",
  "email_status": "pending",
  "date": 1579253996,
  "terms": null,
  "partial_payment": true,
  "gross_amount": 680000,
  "tax_amount": 0,
  "taxable_amount": 0,
  "amount": 680000,
  "amount_paid": 0,
  "amount_due": 680000,
  "currency": "INR",
  "description": "Cloud Computing Course Fees",
  "notes": [],
  "comment": null,
  "short_url": "https://rzp.io/i/j9akcbY",
  "view_less": true,
  "billing_start": null,
  "billing_end": null,
  "type": "link",
  "group_taxes_discounts": false,
  "user": null,
  "created_at": 1579253996
}

Request Parameters🔗

List of request parameters to be used with the Create Payment Link API to rename labels of fields related to partial payments.

options mandatory

array Options to rename the labels for partial payment fields in the checkout form. Parent parameter under which the checkout and partial_payment child parameters must be passed.

checkout mandatory

array The parameter for the Checkout section. partial_payment is its child parameter.

partial_payment.min_amount_label optional: string Changes the label for the Minimum first amount field.
partial_payment.partial_amount_label optional: string Changes the label for the Make payment in parts field.
partial_payment.partial_amount_description optional: string Changes the label for the Pay some now and the remaining later field.
partial_payment.full_amount_label optional: string Changes the label for the Pay in full field.