v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB

Payment Links

Cancel a payment link

Cancel a payment link. Only links in 'created' status can be cancelled. Paid, partially paid, and already expired links cannot be cancelled.

post/payment_links/{id}/cancel

Path parameters

idstring required

Payment Link ID (plink_*).

Response

Payment link cancelled. Status changes to 'cancelled'.

idstring

Unique payment link identifier. Prefix: plink_

entity'payment_link'

amountinteger

Payment amount in smallest currency unit (paise for INR). Three-decimal currencies (KWD, BHD, OMR): drop last decimal digit (e.g. 295.991 KWD → 295990). Zero-decimal currencies (JPY): pass value as-is.

amount_paidinteger

Total amount paid by customer.

currencystring

ISO 4217 currency code. UPI Payment Links only support INR.

accept_partialboolean

Allow partial payments. Not supported for UPI links.

first_min_partial_amountinteger

Minimum amount required for the first partial payment.

descriptionstring

Brief description. Max 2048 characters.

reference_idstring

Your unique tracking reference. Max 40 characters. Must be unique per link.

expire_byinteger

Unix timestamp when link expires. Default: 6 months from creation. Must be at least 15 minutes in the future.

expired_atinteger

Unix timestamp when link actually expired.

cancelled_atinteger

Unix timestamp when link was cancelled.

status'created' | 'partially_paid' | 'expired' | 'cancelled' | 'paid'

created: awaiting payment. partially_paid: one or more partial payments received. expired: past expiry with no full payment. cancelled: manually cancelled. paid: fully paid.

upi_linkboolean

true if this is a UPI Payment Link, false for standard.

short_urlstring

Shareable short URL for the payment link.

callback_urlstring

Redirect URL after payment completion.

callback_method'get'

reminder_enableboolean

Send automatic payment reminders.

notesNotes

Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.

order_idstring

user_idstring

Identifier for the user role that created the link.

created_atinteger

updated_atinteger