Payment Link
Create and manage secure payment links to collect payments from customers. Configure amounts, partial payments, expiry, customer details, reminders, callbacks, and custom metadata, then share the generated link across channels such as SMS, email, or messaging apps.
Entity
The unique identifier of the payment link.
The type of entity represented by this object.
The total payment link amount in the smallest currency sub-unit. For INR, ₹100.00 should be provided as 10000.
The total amount successfully paid against the payment link, in the smallest currency sub-unit.
The remaining amount yet to be paid against the payment link, in the smallest currency sub-unit.
The three-letter ISO currency code for the payment link amount.
A unique identifier assigned by the merchant to track and reconcile the payment link. It can contain up to 40 characters and must be unique.
A brief description of the purpose of the payment link, displayed to the customer during the payment process.
Indicates whether the customer can pay the payment link amount in multiple partial payments.
The minimum amount the customer must pay in each transaction when partial payments are enabled, in the smallest currency sub-unit.
The current status of the payment link. Possible values are CREATED, PARTIAL_PAID, PAID, EXPIRED, and CANCELLED.
The Unix timestamp indicating when the payment link will expire.
Indicates whether automatic payment reminders are enabled for the customer before the payment link expires.
The Unix timestamp indicating when the payment link was cancelled. This field is null if the payment link has not been cancelled.
The unique identifier of the customer associated with the payment link.
The customer details associated with the payment link, such as name, email address, and phone number.
Specifies the communication channels used to send the payment link notification to the customer.
Indicates whether a UPI-compatible payment link is enabled.
Indicates whether a WhatsApp-compatible payment link is enabled.
The shortened URL that can be shared with the customer to complete the payment.
Additional key-value information associated with the payment link for internal tracking, reporting, or reconciliation.
The Unix timestamp indicating when the payment link was last updated.
The Unix timestamp indicating when the payment link was created.