Update a payment link
Update an existing payment link. Updates are only allowed when the link is in 'created' or 'partially_paid' status.
Path parameters
Payment Link ID (plink_*).
Request body
Add or update unique reference number. Max 40 characters.
Updated expiry Unix timestamp.
Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.
Response
Updated payment link.
Unique payment link identifier. Prefix: plink_
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.
Total amount paid by customer.
ISO 4217 currency code. UPI Payment Links only support INR.
Allow partial payments. Not supported for UPI links.
Minimum amount required for the first partial payment.
Brief description. Max 2048 characters.
Your unique tracking reference. Max 40 characters. Must be unique per link.
Unix timestamp when link expires. Default: 6 months from creation. Must be at least 15 minutes in the future.
Unix timestamp when link actually expired.
Unix timestamp when link was cancelled.
created: awaiting payment. partially_paid: one or more partial payments received. expired: past expiry with no full payment. cancelled: manually cancelled. paid: fully paid.
true if this is a UPI Payment Link, false for standard.
Shareable short URL for the payment link.
Redirect URL after payment completion.
Send automatic payment reminders.
Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.
Identifier for the user role that created the link.