API Reference

Cancel a Payment Link

You can cancel a Payment Link using the following endpoint:

/invoices/:id/cancel

Path Parameter🔗

id mandatory
string Unique identifier of the Payment Link.

Response Parameters🔗

id

string The unique identifier of the Payment Link generated.

receipt

string The unique number added for each Payment Link by you for internal reference. The maximum character limit supported is 40.

customer_id

string Unique identifier of the customer to whom the Payment Link has been sent.

customer

Customer details

name
string The customer's name. The maximum character limit supported is 50.
contact
string The customer's mobile number.
email
string The customer's email address.
status

string Indicates the current status of the Payment Link. Refer to the Payment Links Life Cycle to learn about the different statuses.

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.

issued_at

integer Timestamp, in Unix, at which the Payment Link was issued to the customer.

paid_at

integer Timestamp, in Unix, at which the payment was made. Here, the value will be null as the link has just been created.

cancelled_at

integer Timestamp, in Unix, at which the Payment Link was cancelled by you. Here, the value will be null.

expired_at

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

sms_status

string Indicates whether the SMS notification for the Payment Link was sent to the customer. Possible values:

  • pending
  • sent
email_status

string Indicates whether the email notification for the Payment Link was sent to the customer. Possible values:

  • pending
  • sent
partial_payment

boolean 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 ₹299.95, you must enter the value 29995.

amount_paid

integer Amount paid using the Payment Link.

amount_due

integer Remaining amount to be paid using the Payment Link.

currency

string Currency in which the payment was made. Defaults to INR. We accept payments in international currencies.

description

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

notes

object User-entered notes for internal reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. Any custom notes added to the link.

short_url

string The short URL that is generated. This is the Payment Link that can be shared with customers to accept payments. Once cancelled, no payments can be accepted using the link.

view_less

boolean Used when the Payment Link's description is lengthy and you want to make the text collapsible. The text can be expanded by the customer using the Show More link.

  • true (default) - Payment Link's description appears collapsed, with a Show More link.
  • false - Payment Link's description appears expanded.
type

string Here it will be link.

Note:
This method can only be called on a Payment Link that is in the issued state.

‹›
×