API Test Keys

Cancel a Standard Payment Link

POST

/v1/payment_links/:id/cancel

Click to copy

Use this endpoint to cancel a Standard Payment Link.

Is this page helpful?

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X POST https://api.razorpay.com/v1/payment_links/plink_ExjpAUN3gVHrPJ/cancel \
3-H 'Content-type: application/json' \

Success

Failure

1{
2  "accept_partial": true,
3  "amount": 1000,
4  "amount_paid": 0,
5  "callback_method": "get",
6  "callback_url": "https://example-callback-url.com/",
7  "cancelled_at": 1591097270,
8  "created_at": 1591097057,
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": 1691097057,
17  "expired_at": 0,
18  "first_min_partial_amount": 100,
19  "id": "plink_ExjpAUN3gVHrPJ",
20  "notes": {
21    "policy_name": "Jeevan Bima"
22  },
23  "notify": {
24    "email": true,
25    "sms": true
26  },
27  "payments": [],
28  "reference_id": "TS1989",
29  "reminder_enable": true,
30  "reminders": {
31    "status": "failed"
32  },
33  "short_url": "https://rzp.io/i/nxrHnLJ",
34  "status": "cancelled",
35  "updated_at": 1591097270,
36  "user_id": ""
37}

Path Parameters

id

string

Unique identifier of the Payment Link.

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

cannot cancel or expire an already paid/partially paid link

Error Status: 400

When a business tries to cancel/expire a Payment Link which is already paid or partially paid.

Solution

cannot cancel or expire an expired link

Error Status: 400

When a business tries to cancel/expire a payment link which has expired or cancelled.

Solution

The id provided does not exist

Error Status: 400

The Payment Link does not belong to the requestor business, or it doesn't exist.

Solution

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

Cancel a Standard Payment Link

POST

/v1/payment_links/:id/cancel

Click to copy

Use this endpoint to cancel a Standard Payment Link.

Is this page helpful?

Path Parameters

id

string

Unique identifier of the Payment Link.

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

Watch Out!

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

expired_at

integer

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

first_min_partial_amount

integer

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

cannot cancel or expire an already paid/partially paid link

Error Status: 400

When a business tries to cancel/expire a Payment Link which is already paid or partially paid.

Solution

cannot cancel or expire an expired link

Error Status: 400

When a business tries to cancel/expire a payment link which has expired or cancelled.

Solution

The id provided does not exist

Error Status: 400

The Payment Link does not belong to the requestor business, or it doesn't exist.

Solution

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

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X POST https://api.razorpay.com/v1/payment_links/plink_ExjpAUN3gVHrPJ/cancel \
3-H 'Content-type: application/json' \

Success

Failure

1{
2  "accept_partial": true,
3  "amount": 1000,
4  "amount_paid": 0,
5  "callback_method": "get",
6  "callback_url": "https://example-callback-url.com/",
7  "cancelled_at": 1591097270,
8  "created_at": 1591097057,
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": 1691097057,
17  "expired_at": 0,
18  "first_min_partial_amount": 100,
19  "id": "plink_ExjpAUN3gVHrPJ",
20  "notes": {
21    "policy_name": "Jeevan Bima"
22  },
23  "notify": {
24    "email": true,
25    "sms": true
26  },
27  "payments": [],
28  "reference_id": "TS1989",
29  "reminder_enable": true,
30  "reminders": {
31    "status": "failed"
32  },
33  "short_url": "https://rzp.io/i/nxrHnLJ",
34  "status": "cancelled",
35  "updated_at": 1591097270,
36  "user_id": ""
37}