Implement Thematic Changes in Payment Links Checkout Section

Customise the Checkout UI in the Payment Links payment request page using Razorpay APIs. Hide the top bar and prevent customers from choosing a different payment method.

POST /v1/payment_links

Curl

curl -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": "SGD",
  "accept_partial": true,
  "first_min_partial_amount": 100,
  "reference_id": "#423212",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "<name>",
    "contact": "<phone>",
    "email": "<email>"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": true,
  "options": {
    "checkout": {
      "theme": {
        "hide_topbar": true
      }
    }
  }
}'

Success

{
  "accept_partial": true,
  "amount": 1000,
  "amount_paid": 0,
  "callback_method": "",
  "callback_url": "",
  "cancelled_at": 0,
  "created_at": 1596187814,
  "currency": "SGD",
  "customer": {
    "contact": "<phone>",
    "email": "<email>",
    "name": "<name>"
  },
  "description": "Payment for policy no #23456",
  "expire_by": 0,
  "expired_at": 0,
  "first_min_partial_amount": 100,
  "id": "plink_FL3Oncr7XxXFf6",
  "notes": null,
  "notify": {
    "email": true,
    "sms": true
  },
  "payments": null,
  "reference_id": "#423212",
  "reminder_enable": true,
  "reminders": [],
  "short_url": "https://rzp.io/i/j45EmLE",
  "source": "",
  "source_id": "",
  "status": "created",
  "updated_at": 1596187814,
  "user_id": ""
}

Available in🇮🇳 India🇸🇬 Singapore🇺🇸 United States

Use this endpoint to modify the top bar theme element of the Checkout UI on the payment request page. This restricts customers from navigating to the initial screen of Checkout and selecting a different payment method.

Curl

curl -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": "SGD",
  "accept_partial": true,
  "first_min_partial_amount": 100,
  "reference_id": "#423212",
  "description": "Payment for policy no #23456",
  "customer": {
    "name": "<name>",
    "contact": "<phone>",
    "email": "<email>"
  },
  "notify": {
    "sms": true,
    "email": true
  },
  "reminder_enable": true,
  "options": {
    "checkout": {
      "theme": {
        "hide_topbar": true
      }
    }
  }
}'

Success

{
  "accept_partial": true,
  "amount": 1000,
  "amount_paid": 0,
  "callback_method": "",
  "callback_url": "",
  "cancelled_at": 0,
  "created_at": 1596187814,
  "currency": "SGD",
  "customer": {
    "contact": "<phone>",
    "email": "<email>",
    "name": "<name>"
  },
  "description": "Payment for policy no #23456",
  "expire_by": 0,
  "expired_at": 0,
  "first_min_partial_amount": 100,
  "id": "plink_FL3Oncr7XxXFf6",
  "notes": null,
  "notify": {
    "email": true,
    "sms": true
  },
  "payments": null,
  "reference_id": "#423212",
  "reminder_enable": true,
  "reminders": [],
  "short_url": "https://rzp.io/i/j45EmLE",
  "source": "",
  "source_id": "",
  "status": "created",
  "updated_at": 1596187814,
  "user_id": ""
}

Request Parameters

amount · integer · required

Amount to be paid using the Payment Link. Must be in the smallest unit of the currency. For example, if you want to receive a payment of , you must enter the value 30000. In the case of three decimal currencies, such as KWD, BHD and OMR, to refund a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to refund a payment of 295, pass the value as 295.

Watch Out!

As per payment guidelines, you should pass the last decimal number as 0 for three decimal currency payments. For example, if you want to refund a customer 99.991 KD for a transaction, you should pass the value for the amount parameter as 99990 and not 99991.

currency · string

A three-letter ISO code for the currency in which you want to accept the payment. For example, INR. Refer to the list of supported currencies.

Handy Tips

Razorpay has added support for zero decimal currencies, such as JPY, and three decimal currencies, such as KWD, BHD, and OMR, allowing businesses to accept international payments in these currencies. Know more about Currency Conversion (May 2024).

accept_partial · boolean

Indicates whether customers can make partial payments using the Payment Link. Possible values:

• true: Customer can make partial payments.
• false (default): Customer cannot make partial payments.

first_min_partial_amount · integer · required

Minimum amount, in currency subunits, that must be paid by the customer as the first partial payment. Default value is 100. Default currency is INR. For example, if an amount of is to be received from the customer in two installments of #1 - , #2 - , then you can set this value as 500000. Must be passed along with accept_partial parameter.

upi_link · boolean · required

Must be set to true for creating UPI Payment Link. If the upi_link parameter is not passed or passed with value as false, a Standard Payment Link will be created. Possible values:

• true: Creates a UPI Payment Link.
• false: Creates a Standard Payment Link.

description · string

A brief description of the Payment Link. The maximum character limit supported is 2048.

reference_id · string

Reference number tagged to a Payment Link. Must be a unique number for each Payment Link. The maximum character limit supported is 40.

customer · json object

Customer details

name · string

The customer’s name.

email · string

The customer’s email address.

contact · string

The customer’s phone number.

expire_by · integer

Timestamp, in Unix, at which the Payment Link will expire. By default, a Payment Link will be valid for six months from the date of creation. Please note that the expire by date cannot exceed more than six months from the date of creation.

notify · array

Defines who handles Payment Link notification.

sms · boolean

Defines who handles the SMS notification. Possible values:

• true: Razorpay handles the notification.
• false: You handle the notification.

email · boolean

Defines who handles the email notification. Possible values:

• true: Razorpay handles the notification.
• false: You handle the notification.

notes · 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": "Payment Link for Groceries.”.

callback_url · string

If specified, adds a redirect URL to the Payment Link. Once customers completes the payment, they are redirected to the specified URL.

Handy Tips

If the callback_url is passed, it must be passed in the correct format. That is, it should contain a URL.

callback_method · string · required

If callback_url parameter is passed, callback_method must be passed with the value get.

reminder_enable · boolean

Used to send reminders for the Payment Link. Possible values:

• true: To send reminders.
• false: To disable reminders.

options · array

Options to show or hide the top bar. Parent parameter under which the checkout and theme child parameters must be passed.

checkout · array · required

The parameter for the Checkout section.

theme · array

Modifies the thematic elements of Checkout.

hide_topbar · boolean · required

Used to display or hide the top bar on the Checkout. This bar shows the selected payment method, phone number and gives the customer the option to navigate to the initial Checkout screen and change the payment method. Possible values are:

• true: Hides the top bar.
• false (default): Displays the top bar.

Response Parameters

accept_partial · boolean

Indicates whether customers can make partial payments using the Payment Link. Possible values:

• true: Customer can make partial payments.
• false (default): Customer cannot make partial payments.

amount · integer

Amount to be paid using the Payment Link. Must be in the smallest unit of the currency. For example, if you want to receive a payment of , you must enter the value 30000. In the case of three decimal currencies, such as KWD, BHD and OMR, to refund a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to refund a payment of 295, pass the value as 295.

Watch Out!

As per payment guidelines, you should pass the last decimal number as 0 for three decimal currency payments. For example, if you want to refund a customer 99.991 KD for a transaction, you should pass the value for the amount parameter as 99990 and not 99991.

amount_paid · integer

Amount paid by the customer.

callback_url · string

If specified, adds a redirect URL to the Payment Link. Once the customer completes the payment, they are redirected to the specified URL.

callback_method · string

If callback_url parameter is passed, callback_method must be passed with the value get.

cancelled_at · integer

Timestamp, in Unix, at which the Payment Link was cancelled by you.

created_at · integer

Timestamp, in Unix, indicating when the Payment Link was created.

currency · string

Defaults to INR. We accept payments in international currencies.

Handy Tips

Razorpay has added support for zero decimal currencies, such as JPY, and three decimal currencies, such as KWD, BHD, and OMR, allowing businesses to accept international payments in these currencies. Know more about Currency Conversion (May 2024).

customer · json object

Customer details.

name · string

The customer’s name.

email · string

The customer’s email address.

contact · string

The customer’s phone number.

description · string

A brief description of the Payment Link.

expire_by · integer

Timestamp, in Unix, when the Payment Link will expire. By default, a Payment Link will be valid for six months from the date of creation. Please note that the expire by date cannot exceed more than six months from the date of creation.

expired_at · integer

Timestamp, in Unix, at which the Payment Link expired.

first_min_partial_amount · integer

Minimum amount that must be paid by the customer as the first partial payment. For example, if an amount of is to be received from the customer in two installments of #1 - , #2 - , then you can set this value as 500000.

id · string

Unique identifier of the Payment Link. For example, plink_ERgihyaAAC0VNW.

upi_link · boolean

Indicates whether the Payment Link is a UPI Payment Link.

• true: A UPI Payment Link has been created.
• false: It is a Standard Payment Link.

notes · object

Set of key-value pairs that you can use to store additional information. You (Businesses) can enter a maximum of 15 key-value pairs, with each value having a maximum limit of 256 characters.

notify · array

Defines who handles Payment Link notification.

sms · boolean

Defines who handles the SMS notification.

• true: Razorpay handles the notification.
• false: Businesses handle the notification.

email · boolean

Defines who handles the email notification.

• true: Razorpay handles the notification.
• false: Businesses handle the notification.

payments · array

Payment details such as amount, payment id, Payment Link id and more are stored in this array. It is populated only after a payment is successfully captured by the customer. Only captured payments will be shown here. Until then, the value is null.

amount · integer

The amount paid by the customer using the Payment Link.

created_at · integer

Timestamp, in Unix, indicating when the payment was made.

method · string

The payment method used to make the payment. Possible values:

• netbanking
• card
• wallet
• upi
• emi
• bank_transfer

payment_id · string

Unique identifier of the payment made against the Payment Link.

plink_id · string

Unique identifier of the Payment Link. For example, plink_ERgihyaAAC0VNW.

status · string

The payment state. Possible value is captured.

updated_at · integer

Timestamp, in Unix, indicating when the payment was updated.

reference_id · string

Reference number tagged to a Payment Link. Must be a unique number for each Payment Link. The maximum character limit supported is 40.

short_url · string

The unique short URL generated for the Payment Link.

status · string

Displays the current state of the Payment Link. Possible values:

• created
• partially_paid
• expired
• cancelled
• paid

updated_at · integer

Timestamp, in Unix, indicating when the Payment Link was updated.

reminder_enable · boolean

Used to send reminders for the Payment Link. Possible values:

• true: To send reminders.
• false: To disable reminders.

user_id · string

A unique identifier for the user role through which the Payment Link was created. For example, HD1JAKCCPGDfRx.

Errors

The api {key/secret} provided is invalid

Code: 4xx

There is a mismatch between the API credentials passed in the API call and the API credentials generated on the Dashboard.

Solution: Make sure that:

• The API Keys are active and entered correctly.
• There are no white-spaces before or after the keys.

The {input field} is required

Code: 4xx

A mandatory field is empty.

Solution: Ensure all mandatory fields and values are present.

wrong input fields sent.

Code: 400

When wrong input fields are sent during Payment Link creation.

Solution: Ensure that the input fields are added correctly. Refer to these request parameters on how to add correct input fields.

payment link creation with reference ID already attempted

Code: 400

An existing reference id has been passed.

Solution: Ensure that a unique reference id is used for all Payment Links.

timestamp must be atleast 15 minutes in future

Code: 400

The epoch time passed is less than 15 minutes from the current time.

Solution: The close_by time should be more than 15 minutes from the current time.

Invalid access: Cannot create a payment link in live mode, as live mode is disabled for merchant.

Code: 400

Occurs when you try to create a Payment Link in Live mode, but live mode is disabled for you

Solution: Raise a request to our support team to get live mode enabled for you.

Invalid access: Cannot create a payment link, as Merchant is Suspended.

Code: 400

Occurs when you try to create a Payment Link when you have been suspended.

Solution: Raise a request to our support team to be reinstated.

value: the length must not be greater than 255.

Code: 400

When the notes length is greater than 255 characters during Payment Link creation.

Solution: Please create a payment link with notes values less than 255 characters.