Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates Flow

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Payments

Payment Links

Customise Payment Methods

API Test Keys

Customise Payment Methods - Options and Method Parameters

POST
/v1/payment_links

Click to copy

Use this endpoint to enable or disable display of specific payment methods. For example, you can use the options and method parameters to display only card and fpx methods on the Checkout.

You can use the options parameter to display or hide any of the following payment methods:

  • Card
  • FPX
  • Wallet

Is this page helpful?

Curl

change language

change language

1
curl -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": "#523442",
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": true
19
  },
20
  "reminder_enable": true,
21
  "options": {
22
    "checkout": {
23
      "method": {
24
        "fpx": "1",
25
        "card": "1",
26
        "wallet": "0"
27
      }
28
    }
29
  }
30
}'

Success

Failure

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": 1596188371,
9
  "currency": "MYR",
10
  "customer": {
11
    "contact": "+919000090000",
12
    "email": "gaurav.kumar@example.com",
13
    "name": "Gaurav Kumar"
14
  },
15
  "deleted_at": 0,
16
  "description": "Payment for policy no #23456",
17
  "expire_by": 0,
18
  "expired_at": 0,
19
  "first_min_partial_amount": 100,
20
  "id": "plink_FL3YbdvN2Cj6gh",
21
  "notes": null,
22
  "notify": {
23
    "email": true,
24
    "sms": true
25
  },
26
  "payments": null,
27
  "reference_id": "#543422",
28
  "reminder_enable": true,
29
  "reminders": [],
30
  "short_url": "https://rzp.io/i/wKiXKud",
31
  "source": "",
32
  "source_id": "",
33
  "status": "created",
34
  "updated_at": 1596188371,
35
  "user_id": ""
36
}
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 RM 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

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

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 RM 700.00 is to be received from the customer in two installments of #1 - RM 500.00, #2 - RM 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
object

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.

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

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 display or hide payment methods on the Checkout section. Parent parameter under which the checkout and method child parameters must be passed.

Show child parameters (1)

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 RM 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 RM 700.00 is to be received from the customer in two installments of #1 - RM 500.00, #2 - RM 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

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

Error Status: 4xx

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

Solution

The {input field} is required

Error Status: 4xx

A mandatory field is empty.

Solution

payment link with given reference_id: notes already exists. Please create a Payment Link with a different reference_id

Error Status: 400

An existing reference id has been passed.

Solution

Customise Payment Methods - Options and Method Parameters

POST
/v1/payment_links

Click to copy

Use this endpoint to enable or disable display of specific payment methods. For example, you can use the options and method parameters to display only card and fpx methods on the Checkout.

You can use the options parameter to display or hide any of the following payment methods:

  • Card
  • FPX
  • Wallet

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 RM 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

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

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 RM 700.00 is to be received from the customer in two installments of #1 - RM 500.00, #2 - RM 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
object

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.

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

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 display or hide payment methods on the Checkout section. Parent parameter under which the checkout and method child parameters must be passed.

Show child parameters (1)

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 RM 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 RM 700.00 is to be received from the customer in two installments of #1 - RM 500.00, #2 - RM 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

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

Error Status: 4xx

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

Solution

The {input field} is required

Error Status: 4xx

A mandatory field is empty.

Solution

payment link with given reference_id: notes already exists. Please create a Payment Link with a different reference_id

Error Status: 400

An existing reference id has been passed.

Solution

Curl

change language

change language

1
curl -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": "#523442",
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": true
19
  },
20
  "reminder_enable": true,
21
  "options": {
22
    "checkout": {
23
      "method": {
24
        "fpx": "1",
25
        "card": "1",
26
        "wallet": "0"
27
      }
28
    }
29
  }
30
}'

Success

Failure

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": 1596188371,
9
  "currency": "MYR",
10
  "customer": {
11
    "contact": "+919000090000",
12
    "email": "gaurav.kumar@example.com",
13
    "name": "Gaurav Kumar"
14
  },
15
  "deleted_at": 0,
16
  "description": "Payment for policy no #23456",
17
  "expire_by": 0,
18
  "expired_at": 0,
19
  "first_min_partial_amount": 100,
20
  "id": "plink_FL3YbdvN2Cj6gh",
21
  "notes": null,
22
  "notify": {
23
    "email": true,
24
    "sms": true
25
  },
26
  "payments": null,
27
  "reference_id": "#543422",
28
  "reminder_enable": true,
29
  "reminders": [],
30
  "short_url": "https://rzp.io/i/wKiXKud",
31
  "source": "",
32
  "source_id": "",
33
  "status": "created",
34
  "updated_at": 1596188371,
35
  "user_id": ""
36
}