824ca9e6faef

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB

Bills3

Customers4

Disputes4

Documents3

Instant Settlements3

Invoices8

Items5

Linked Accounts8

Orders5

Partner Accounts1

Partner Documents4

Partner Stakeholders1

Partner Webhooks5

Payment Downtimes2

Payment Links6

Payments4

Plans3

QR Codes6

Refunds6

Settlements3

Subscriptions10

Transfers8

Virtual Accounts10

X Account Validation3

X Banking Balances1

X Contacts4

X Fund Accounts4

X Payout Links4

X Payouts6

X Transactions2

Payment Links

Create a payment link

Create a shareable payment link to collect payments via SMS and email. Supports standard links (all payment methods) and UPI-only links (set upi_link=true). UPI links are not available in test mode. Partial payments are not supported for UPI links. Links expire after 6 months by default.

post/payment_links

Request body

amountinteger required

Amount in smallest currency unit (paise for INR). Example: 50000 for ₹500.

currencystring

ISO 4217 currency code. UPI links support INR only.

upi_linkboolean

Set true to create a UPI-only Payment Link. Not available in test mode.

accept_partialboolean

Enable partial payments. Not supported for UPI links.

first_min_partial_amountinteger

Minimum first partial payment amount in paise.

expire_byinteger

Unix timestamp for link expiry. Max 6 months from creation. Must be at least 15 minutes in the future.

reference_idstring

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

descriptionstring

Brief description shown on the payment page. Max 2048 characters.

reminder_enableboolean

Send automatic payment reminders.

callback_urlstring

Redirect URL after payment completion.

callback_method'get'

Required when callback_url is set.

notesNotes

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

Response

Payment link created.

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