API Test Keys
Implement Thematic Changes in Payment Links Checkout Section
POST
/v1/payment_links
Click to copy
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.
Is this page helpful?
Curl
change language
change language
1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \2-X POST https://api.razorpay.com/v1/payment_links/ \3-H 'Content-type: application/json' \4-d '{5"amount": 1000,6"currency": "MYR",7"accept_partial": true,8"first_min_partial_amount": 100,9"reference_id": "#423212",10"description": "Payment for policy no #23456",11"customer": {12"name": "Gaurav Kumar",13"contact": "+919000090000",14"email": "gaurav.kumar@example.com"15},16"notify": {17"sms": true,18"email": true19},20"reminder_enable": true,21"options": {22"checkout": {23"theme": {24"hide_topbar": true25}26}27}28}'
Success
1{2"accept_partial": true,3"amount": 1000,4"amount_paid": 0,5"callback_method": "",6"callback_url": "",7"cancelled_at": 0,8"created_at": 1596187814,9"currency": "MYR",10"customer": {11"contact": "+919000090000",12"email": "gaurav.kumar@example.com",13"name": "Gaurav Kumar"14},15"description": "Payment for policy no #23456",16"expire_by": 0,17"expired_at": 0,18"first_min_partial_amount": 100,19"id": "plink_FL3Oncr7XxXFf6",20"notes": null,21"notify": {22"email": true,23"sms": true24},25"payments": null,26"reference_id": "#423212",27"reminder_enable": true,28"reminders": [],29"short_url": "https://rzp.io/i/j45EmLE",30"source": "",31"source_id": "",32"status": "created",33"updated_at": 1596187814,34"user_id": ""35}
Request Parameters
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 MYR 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
.
currency
string
A three-letter ISO code for the currency in which you want to accept the payment. For example, MYR.
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.
first_min_partial_amount
integer
Minimum amount, in currency subunits, that must be paid by the customer as the first partial payment. Default currency is MYR
. For example, if an amount of MYR 700.00 is to be received from the customer in two installments of #1 - MYR 500.00, #2 - MYR 200.00, then you can set this value as 500000
. Must be passed along with accept_partial
parameter.
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
string
Customer details
Show child parameters (3)
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.
Show child parameters (2)
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.
If the
callback_url
is passed, it should be passed in the correct format. That is, it should contain a URL. callback_method
string
If callback_url
parameter is passed, callback_method must be passed with the value get
.
reminder_enable
boolean
Used to send
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.
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 MYR 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 MYR.
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 MYR 700.00 is to be received from the customer in two installments of #1 - MYR 500.00, #2 - MYR 200.00, then you can set this value as 500000
.
id
string
Unique identifier of the Payment Link. For example, plink_ERgihyaAAC0VNW
.
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
.
Implement Thematic Changes in Payment Links Checkout Section
POST
/v1/payment_links
Click to copy
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.
Is this page helpful?
Request Parameters
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 MYR 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
.
currency
string
A three-letter ISO code for the currency in which you want to accept the payment. For example, MYR.
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.
first_min_partial_amount
integer
Minimum amount, in currency subunits, that must be paid by the customer as the first partial payment. Default currency is MYR
. For example, if an amount of MYR 700.00 is to be received from the customer in two installments of #1 - MYR 500.00, #2 - MYR 200.00, then you can set this value as 500000
. Must be passed along with accept_partial
parameter.
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
string
Customer details
Show child parameters (3)
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.
Show child parameters (2)
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.
If the
callback_url
is passed, it should be passed in the correct format. That is, it should contain a URL. callback_method
string
If callback_url
parameter is passed, callback_method must be passed with the value get
.
reminder_enable
boolean
Used to send
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.
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 MYR 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 MYR.
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 MYR 700.00 is to be received from the customer in two installments of #1 - MYR 500.00, #2 - MYR 200.00, then you can set this value as 500000
.
id
string
Unique identifier of the Payment Link. For example, plink_ERgihyaAAC0VNW
.
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
.
Curl
change language
change language
1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \2-X POST https://api.razorpay.com/v1/payment_links/ \3-H 'Content-type: application/json' \4-d '{5"amount": 1000,6"currency": "MYR",7"accept_partial": true,8"first_min_partial_amount": 100,9"reference_id": "#423212",10"description": "Payment for policy no #23456",11"customer": {12"name": "Gaurav Kumar",13"contact": "+919000090000",14"email": "gaurav.kumar@example.com"15},16"notify": {17"sms": true,18"email": true19},20"reminder_enable": true,21"options": {22"checkout": {23"theme": {24"hide_topbar": true25}26}27}28}'
Success
1{2"accept_partial": true,3"amount": 1000,4"amount_paid": 0,5"callback_method": "",6"callback_url": "",7"cancelled_at": 0,8"created_at": 1596187814,9"currency": "MYR",10"customer": {11"contact": "+919000090000",12"email": "gaurav.kumar@example.com",13"name": "Gaurav Kumar"14},15"description": "Payment for policy no #23456",16"expire_by": 0,17"expired_at": 0,18"first_min_partial_amount": 100,19"id": "plink_FL3Oncr7XxXFf6",20"notes": null,21"notify": {22"email": true,23"sms": true24},25"payments": null,26"reference_id": "#423212",27"reminder_enable": true,28"reminders": [],29"short_url": "https://rzp.io/i/j45EmLE",30"source": "",31"source_id": "",32"status": "created",33"updated_at": 1596187814,34"user_id": ""35}