API Test Keys
Offers on Payment Links
POST
/v1/payment_links
Click to copy
Use this endpoint to provide offers on Payment Links. Razorpay Offers provides discounts or cashback on Payment Links issued to customers. You can restrict the payment methods on which the Offers are applied and limit their usage to a defined time period.
Watch Out!
Ensure you do not enable partial payments on Payment Links on which offer is being applied.
Know more about how to show
via Razorpay Dashboard.Is this page helpful?
1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \2-X POST https://api.razorpay.com/v1/payment_links3-H 'content-type: application/json'4-d '{5"amount": 3400,6"currency": "INR",7"accept_partial": false,8"reference_id": "#425",9"description": "Payment for policy no #23456",10"customer": {11"name": "Gaurav Kumar",12"contact": "+919000090000",13"email": "gaurav.kumar@example.com"14},15"notify": {16"sms": true,17"email": true18},19"reminder_enable": false,20"options": {21"order": {22"offers": [23"offer_F4WMTC3pwFKnzq",24"offer_F4WJHqvGzw8dWF"25]26}27}28}'
Success
1{2"accept_partial": false,3"amount": 3400,4"amount_paid": 0,5"cancelled_at": 0,6"created_at": 1600183040,7"currency": "INR",8"customer": {9"contact": "+919000090000",10"email": "gaurav.kumar@example.com",11"name": "Gaurav Kumar"12},13"description": "Payment for policy no #23456",14"expire_by": 0,15"expired_at": 0,16"first_min_partial_amount": 0,17"id": "plink_FdLt0WBldRyE5t",18"notes": null,19"notify": {20"email": true,21"sms": true22},23"payments": null,24"reference_id": "#425",25"reminder_enable": false,26"reminders": [],27"short_url": "https://rzp.io/i/CM5ohDC",28"status": "created",29"user_id": ""30}
Request Parameters
options
*
array
Options to associate the offer_id
with the Payment Link. Parent parameter under which the order
child parameter must be passed.
Show child parameters (1)
Response Parameters
accept_partial
boolean
Indicates whether customers can make
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 ₹300.00, 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
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
(May 2024).customer
string
Customer details.
Show child parameters (3)
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 ₹700.00 is to be received from the customer in two installments of #1 - ₹500.00, #2 - ₹200.00, 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.
Show child parameters (2)
payments
array
Payment details such as amount, payment id, Payment Link id and more. This array is populated only after a payment is made by the customer or if the payment fails. Until then, the value is null
.
Show child parameters (7)
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
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
.
Offers on Payment Links
POST
/v1/payment_links
Click to copy
Use this endpoint to provide offers on Payment Links. Razorpay Offers provides discounts or cashback on Payment Links issued to customers. You can restrict the payment methods on which the Offers are applied and limit their usage to a defined time period.
Watch Out!
Ensure you do not enable partial payments on Payment Links on which offer is being applied.
Know more about how to show
via Razorpay Dashboard.Is this page helpful?
Request Parameters
options
*
array
Options to associate the offer_id
with the Payment Link. Parent parameter under which the order
child parameter must be passed.
Show child parameters (1)
Response Parameters
accept_partial
boolean
Indicates whether customers can make
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 ₹300.00, 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
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
(May 2024).customer
string
Customer details.
Show child parameters (3)
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 ₹700.00 is to be received from the customer in two installments of #1 - ₹500.00, #2 - ₹200.00, 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.
Show child parameters (2)
payments
array
Payment details such as amount, payment id, Payment Link id and more. This array is populated only after a payment is made by the customer or if the payment fails. Until then, the value is null
.
Show child parameters (7)
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
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
.
1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \2-X POST https://api.razorpay.com/v1/payment_links3-H 'content-type: application/json'4-d '{5"amount": 3400,6"currency": "INR",7"accept_partial": false,8"reference_id": "#425",9"description": "Payment for policy no #23456",10"customer": {11"name": "Gaurav Kumar",12"contact": "+919000090000",13"email": "gaurav.kumar@example.com"14},15"notify": {16"sms": true,17"email": true18},19"reminder_enable": false,20"options": {21"order": {22"offers": [23"offer_F4WMTC3pwFKnzq",24"offer_F4WJHqvGzw8dWF"25]26}27}28}'
Success
1{2"accept_partial": false,3"amount": 3400,4"amount_paid": 0,5"cancelled_at": 0,6"created_at": 1600183040,7"currency": "INR",8"customer": {9"contact": "+919000090000",10"email": "gaurav.kumar@example.com",11"name": "Gaurav Kumar"12},13"description": "Payment for policy no #23456",14"expire_by": 0,15"expired_at": 0,16"first_min_partial_amount": 0,17"id": "plink_FdLt0WBldRyE5t",18"notes": null,19"notify": {20"email": true,21"sms": true22},23"payments": null,24"reference_id": "#425",25"reminder_enable": false,26"reminders": [],27"short_url": "https://rzp.io/i/CM5ohDC",28"status": "created",29"user_id": ""30}