Razorpay

Usage Instructions

Use Razorpay to send Payment Links that customers pay by UPI, card, netbanking, or wallet, with SMS and email notifications and reminders, then check, cancel, or list them. Create orders for Checkout, fetch and capture payments, issue full or partial refunds, create customers, and generate UPI QR codes. Enter amounts in rupees (the major unit); they are converted to paise for Razorpay. The Razorpay webhook trigger runs workflows when a link is paid or expires, a payment is captured or fails, an order is paid, or a refund is processed.

Actions

Razorpay Cancel Payment Link

Cancel an unpaid Razorpay Payment Link so the customer can no longer pay it. Paid, partially paid, and expired links cannot be cancelled.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`paymentLinkId`	string	Yes	Payment Link ID to cancel, e.g. plink_ExjpAUN3gVHrPJ

Output

Parameter	Type	Description
`id`	string	Payment Link ID (plink_...)
`shortUrl`	string	Short URL to send to the customer
`status`	string	created, partially_paid, paid, expired, or cancelled
`amount`	number	Amount in the major unit (rupees for INR)
`amountPaise`	number	Amount in the smallest unit (paise for INR)
`amountPaid`	number	Amount paid so far in the major unit
`amountPaidPaise`	number	Amount paid so far in the smallest unit
`currency`	string	Currency code, e.g. INR
`description`	string	Description shown to the customer
`referenceId`	string	Your reference ID for the link
`customerName`	string	Customer name
`customerEmail`	string	Customer email
`customerContact`	string	Customer phone number
`notifySms`	boolean	Whether Razorpay sends the link by SMS
`notifyEmail`	boolean	Whether Razorpay sends the link by email
`reminderEnable`	boolean	Whether Razorpay sends payment reminders
`acceptPartial`	boolean	Whether partial payments are allowed
`upiLink`	boolean	Whether this is a UPI Payment Link
`callbackUrl`	string	Where the customer is redirected after paying
`orderId`	string	Order ID created for the link
`expireBy`	number	When the link expires (Unix seconds, 0 if not set)
`expiredAt`	number	When the link expired (Unix seconds, 0 if not expired)
`cancelledAt`	number	When the link was cancelled (Unix seconds, 0 if not cancelled)
`createdAt`	number	When it was created (Unix seconds)
`updatedAt`	number	When it was last updated (Unix seconds)
`notes`	json	Key-value notes stored on the entity
`payments`	array	Captured payments against the link
↳ `paymentId`	string	Payment ID (pay_...)
↳ `amount`	number	Amount in the major unit
↳ `amountPaise`	number	Amount in the smallest unit
↳ `method`	string	Payment method, e.g. upi or card
↳ `status`	string	Payment status
↳ `createdAt`	number	When it was created (Unix seconds)

Razorpay Capture Payment

Capture an authorized Razorpay Payment so the money is settled to you. Only payments in the authorized state can be captured, and the amount must equal the authorized amount. Give the amount in the major currency unit (rupees for INR, e.g. 499.50); it is converted to the smallest unit (paise) that Razorpay expects.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`paymentId`	string	Yes	Authorized payment ID, e.g. pay_G8VQzjPLoAvm6D
`amount`	number	Yes	Authorized amount in the major unit, e.g. 499.50. Give the amount in the major currency unit (rupees for INR, e.g. 499.50); it is converted to the smallest unit (paise) that Razorpay expects.
`currency`	string	No	Currency of the payment. Defaults to INR

Output

Parameter	Type	Description
`id`	string	Payment ID (pay_...)
`status`	string	created, authorized, captured, refunded, or failed
`amount`	number	Amount in the major unit (rupees for INR)
`amountPaise`	number	Amount in the smallest unit (paise for INR)
`currency`	string	Currency code, e.g. INR
`method`	string	card, netbanking, wallet, emi, upi, or paylater
`orderId`	string	Order ID the payment belongs to
`invoiceId`	string	Invoice ID, if any
`customerId`	string	Customer ID, if any
`description`	string	Payment description
`captured`	boolean	Whether the payment is captured
`international`	boolean	Whether the payment used an international card
`amountRefunded`	number	Amount refunded in the major unit
`amountRefundedPaise`	number	Amount refunded in the smallest unit
`refundStatus`	string	null, partial, or full
`email`	string	Customer email
`contact`	string	Customer phone number
`bank`	string	Bank code for netbanking payments
`wallet`	string	Wallet name for wallet payments
`vpa`	string	Customer UPI ID for UPI payments
`fee`	number	Razorpay fee including GST, in the major unit
`feePaise`	number	Razorpay fee including GST, in the smallest unit
`tax`	number	GST on the fee, in the major unit
`taxPaise`	number	GST on the fee, in the smallest unit
`errorCode`	string	Error code for failed payments
`errorDescription`	string	Error description for failed payments
`errorReason`	string	Error reason for failed payments
`createdAt`	number	When it was created (Unix seconds)
`notes`	json	Key-value notes stored on the entity

Razorpay Create Customer

Create a Razorpay Customer with name, email, and phone number. Turn off failExisting to get the existing customer back instead of an error when one with the same details exists.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`name`	string	No	Customer name, 3 to 50 characters
`email`	string	No	Customer email (max 64 characters)
`contact`	string	No	Customer phone number with country code, e.g. +919876543210 (max 15 characters)
`failExisting`	boolean	No	true (default) fails when the customer already exists; false returns the existing customer
`gstin`	string	No	Customer GST number, e.g. 29XAbbA4369J1PA
`notes`	json	No	Up to 15 key-value notes, e.g. {"lead_id": "L-1042"}

Output

Parameter	Type	Description
`id`	string	Customer ID (cust_...)
`name`	string	Customer name
`email`	string	Customer email
`contact`	string	Customer phone number
`gstin`	string	Customer GSTIN
`createdAt`	number	When it was created (Unix seconds)
`notes`	json	Key-value notes stored on the entity

Razorpay Create Order

Create a Razorpay Order to pass to Razorpay Checkout. Create a new order for every payment attempt. Give the amount in the major currency unit (rupees for INR, e.g. 499.50); it is converted to the smallest unit (paise) that Razorpay expects.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`amount`	number	Yes	Order amount in the major unit, e.g. 499.50 for ₹499.50; at least ₹1. Give the amount in the major currency unit (rupees for INR, e.g. 499.50); it is converted to the smallest unit (paise) that Razorpay expects.
`currency`	string	No	3-letter currency code. Defaults to INR
`receipt`	string	No	Your unique receipt number (max 40 characters). A repeated receipt is rejected as a duplicate
`notes`	json	No	Up to 15 key-value notes, e.g. {"lead_id": "L-1042"}

Output

Parameter	Type	Description
`id`	string	Order ID (order_...)
`status`	string	created, attempted, or paid
`amount`	number	Amount in the major unit (rupees for INR)
`amountPaise`	number	Amount in the smallest unit (paise for INR)
`amountPaid`	number	Amount paid in the major unit
`amountPaidPaise`	number	Amount paid in the smallest unit
`amountDue`	number	Amount still due in the major unit
`amountDuePaise`	number	Amount still due in the smallest unit
`currency`	string	Currency code, e.g. INR
`receipt`	string	Your receipt number
`attempts`	number	Number of payment attempts
`createdAt`	number	When it was created (Unix seconds)
`notes`	json	Key-value notes stored on the entity

Razorpay Create Payment Link

Create a Razorpay Payment Link and get a short URL the customer can pay by UPI, card, netbanking, or wallet. Razorpay can send it by SMS and email and remind the customer. Give the amount in the major currency unit (rupees for INR, e.g. 499.50); it is converted to the smallest unit (paise) that Razorpay expects.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`amount`	number	Yes	Amount to collect in the major unit, e.g. 499.50 for ₹499.50. Converted to paise; at least ₹1. Give the amount in the major currency unit (rupees for INR, e.g. 499.50); it is converted to the smallest unit (paise) that Razorpay expects.
`currency`	string	No	3-letter currency code. Defaults to INR
`description`	string	No	What the payment is for, shown to the customer (max 2048 characters)
`customerName`	string	No	Customer name
`customerEmail`	string	No	Customer email; needed to notify by email
`customerContact`	string	No	Customer phone number with country code, e.g. +919876543210; needed for SMS
`notifySms`	boolean	No	Let Razorpay send the link to the customer by SMS
`notifyEmail`	boolean	No	Let Razorpay send the link to the customer by email
`reminderEnable`	boolean	No	Let Razorpay send payment reminders until the link is paid
`expireBy`	string	No	When the link expires, as Unix seconds or an ISO 8601 date. At least 15 minutes and at most 6 months from now
`callbackUrl`	string	No	URL the customer is redirected to after paying
`referenceId`	string	No	Your own unique reference, e.g. the lead or invoice ID (max 40 characters). A repeated reference ID is rejected
`acceptPartial`	boolean	No	Allow the customer to pay in parts
`firstMinPartialAmount`	number	No	Minimum first partial payment in the major unit (e.g. 100 for ₹100). Needs acceptPartial
`upiLink`	boolean	No	Create a UPI Payment Link (INR only, no partial payments). Not available with test keys
`notes`	json	No	Up to 15 key-value notes stored on the link and returned in webhooks, e.g. {"lead_id": "L-1042"}

Output

Parameter	Type	Description
`id`	string	Payment Link ID (plink_...)
`shortUrl`	string	Short URL to send to the customer
`status`	string	created, partially_paid, paid, expired, or cancelled
`amount`	number	Amount in the major unit (rupees for INR)
`amountPaise`	number	Amount in the smallest unit (paise for INR)
`amountPaid`	number	Amount paid so far in the major unit
`amountPaidPaise`	number	Amount paid so far in the smallest unit
`currency`	string	Currency code, e.g. INR
`description`	string	Description shown to the customer
`referenceId`	string	Your reference ID for the link
`customerName`	string	Customer name
`customerEmail`	string	Customer email
`customerContact`	string	Customer phone number
`notifySms`	boolean	Whether Razorpay sends the link by SMS
`notifyEmail`	boolean	Whether Razorpay sends the link by email
`reminderEnable`	boolean	Whether Razorpay sends payment reminders
`acceptPartial`	boolean	Whether partial payments are allowed
`upiLink`	boolean	Whether this is a UPI Payment Link
`callbackUrl`	string	Where the customer is redirected after paying
`orderId`	string	Order ID created for the link
`expireBy`	number	When the link expires (Unix seconds, 0 if not set)
`expiredAt`	number	When the link expired (Unix seconds, 0 if not expired)
`cancelledAt`	number	When the link was cancelled (Unix seconds, 0 if not cancelled)
`createdAt`	number	When it was created (Unix seconds)
`updatedAt`	number	When it was last updated (Unix seconds)
`notes`	json	Key-value notes stored on the entity
`payments`	array	Captured payments against the link
↳ `paymentId`	string	Payment ID (pay_...)
↳ `amount`	number	Amount in the major unit
↳ `amountPaise`	number	Amount in the smallest unit
↳ `method`	string	Payment method, e.g. upi or card
↳ `status`	string	Payment status
↳ `createdAt`	number	When it was created (Unix seconds)

Razorpay Create UPI QR Code

Create a Razorpay UPI QR code and get its image URL to show or send. Single-use codes collect one fixed amount; multiple-use codes can take many payments. Amounts are in rupees and converted to paise. QR Codes must be enabled on the Razorpay account.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`usage`	string	Yes	single_use (one payment, then closes) or multiple_use
`name`	string	No	Label for the QR code, e.g. Store Front Display
`fixedAmount`	boolean	No	Accept only paymentAmount. Required (true) for single-use codes; defaults to true when paymentAmount is set
`paymentAmount`	number	No	Fixed amount in rupees, e.g. 300 for ₹300; converted to paise. Required for fixed-amount codes
`description`	string	No	Description of the QR code
`customerId`	string	No	Razorpay Customer ID to link, e.g. cust_HKsR5se84c5LTO
`closeBy`	string	No	Single-use codes only: when the code closes, as Unix seconds or an ISO 8601 date, 2 minutes to 2 hours from now
`notes`	json	No	Up to 15 key-value notes, e.g. {"lead_id": "L-1042"}

Output

Parameter	Type	Description
`id`	string	QR Code ID (qr_...)
`imageUrl`	string	URL of the QR code image to show or send
`status`	string	active or closed
`name`	string	Label of the QR code
`usage`	string	single_use or multiple_use
`type`	string	upi_qr
`fixedAmount`	boolean	Whether the QR code accepts only a fixed amount
`paymentAmount`	number	Fixed amount in rupees
`paymentAmountPaise`	number	Fixed amount in paise
`paymentsAmountReceived`	number	Total received in rupees
`paymentsCountReceived`	number	Number of payments received
`description`	string	QR code description
`customerId`	string	Customer ID, if linked
`closeBy`	number	When the QR code closes (Unix seconds)
`closedAt`	number	When the QR code closed (Unix seconds)
`closeReason`	string	on_demand or paid
`createdAt`	number	When it was created (Unix seconds)
`notes`	json	Key-value notes stored on the entity

Razorpay Create Refund

Refund a captured Razorpay Payment, fully or in part. Leave the amount empty for a full refund. Normal refunds take 5-7 working days; optimum tries an instant refund first. Give the amount in the major currency unit (rupees for INR, e.g. 499.50); it is converted to the smallest unit (paise) that Razorpay expects.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`paymentId`	string	Yes	Captured payment ID to refund, e.g. pay_29QQoUBi66xm2f
`amount`	number	No	Amount to refund in the major unit, e.g. 250 for ₹250. Leave empty for a full refund. Give the amount in the major currency unit (rupees for INR, e.g. 499.50); it is converted to the smallest unit (paise) that Razorpay expects.
`currency`	string	No	Currency of the payment, used only to convert the amount to the smallest unit. Defaults to INR
`speed`	string	No	normal (default, 5-7 working days) or optimum (instant when possible)
`receipt`	string	No	Your unique receipt number for the refund; a repeated receipt is rejected
`notes`	json	No	Up to 15 key-value notes, e.g. {"reason": "Duplicate order"}

Output

Parameter	Type	Description
`id`	string	Refund ID (rfnd_...)
`paymentId`	string	Payment ID that was refunded
`status`	string	pending, processed, or failed
`amount`	number	Refund amount in the major unit (rupees for INR)
`amountPaise`	number	Refund amount in the smallest unit (paise for INR)
`currency`	string	Currency code, e.g. INR
`receipt`	string	Your receipt number for the refund
`speedRequested`	string	normal or optimum
`speedProcessed`	string	instant or normal
`createdAt`	number	When it was created (Unix seconds)
`notes`	json	Key-value notes stored on the entity

Razorpay Get Customer

Get a Razorpay Customer by ID with their name, email, phone number, and GSTIN.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`customerId`	string	Yes	Customer ID, e.g. cust_1Aa00000000004

Output

Parameter	Type	Description
`id`	string	Customer ID (cust_...)
`name`	string	Customer name
`email`	string	Customer email
`contact`	string	Customer phone number
`gstin`	string	Customer GSTIN
`createdAt`	number	When it was created (Unix seconds)
`notes`	json	Key-value notes stored on the entity

Razorpay Get Order

Get a Razorpay Order by ID with its status (created, attempted, paid), amount paid, and amount due.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`orderId`	string	Yes	Order ID, e.g. order_DBJOWzybf0sJbb

Output

Parameter	Type	Description
`id`	string	Order ID (order_...)
`status`	string	created, attempted, or paid
`amount`	number	Amount in the major unit (rupees for INR)
`amountPaise`	number	Amount in the smallest unit (paise for INR)
`amountPaid`	number	Amount paid in the major unit
`amountPaidPaise`	number	Amount paid in the smallest unit
`amountDue`	number	Amount still due in the major unit
`amountDuePaise`	number	Amount still due in the smallest unit
`currency`	string	Currency code, e.g. INR
`receipt`	string	Your receipt number
`attempts`	number	Number of payment attempts
`createdAt`	number	When it was created (Unix seconds)
`notes`	json	Key-value notes stored on the entity

Razorpay Get Payment

Get a Razorpay Payment by ID with its status (authorized, captured, refunded, failed), method, amount, refunds, fee, and failure reason. Card details are not returned.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`paymentId`	string	Yes	Payment ID, e.g. pay_DG4ZdRK8ZnXC3k

Output

Parameter	Type	Description
`id`	string	Payment ID (pay_...)
`status`	string	created, authorized, captured, refunded, or failed
`amount`	number	Amount in the major unit (rupees for INR)
`amountPaise`	number	Amount in the smallest unit (paise for INR)
`currency`	string	Currency code, e.g. INR
`method`	string	card, netbanking, wallet, emi, upi, or paylater
`orderId`	string	Order ID the payment belongs to
`invoiceId`	string	Invoice ID, if any
`customerId`	string	Customer ID, if any
`description`	string	Payment description
`captured`	boolean	Whether the payment is captured
`international`	boolean	Whether the payment used an international card
`amountRefunded`	number	Amount refunded in the major unit
`amountRefundedPaise`	number	Amount refunded in the smallest unit
`refundStatus`	string	null, partial, or full
`email`	string	Customer email
`contact`	string	Customer phone number
`bank`	string	Bank code for netbanking payments
`wallet`	string	Wallet name for wallet payments
`vpa`	string	Customer UPI ID for UPI payments
`fee`	number	Razorpay fee including GST, in the major unit
`feePaise`	number	Razorpay fee including GST, in the smallest unit
`tax`	number	GST on the fee, in the major unit
`taxPaise`	number	GST on the fee, in the smallest unit
`errorCode`	string	Error code for failed payments
`errorDescription`	string	Error description for failed payments
`errorReason`	string	Error reason for failed payments
`createdAt`	number	When it was created (Unix seconds)
`notes`	json	Key-value notes stored on the entity

Razorpay Get Payment Link

Get a Razorpay Payment Link by ID, with its status (created, partially_paid, paid, expired, cancelled), amount paid, and captured payments.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`paymentLinkId`	string	Yes	Payment Link ID, e.g. plink_ExjpAUN3gVHrPJ

Output

Parameter	Type	Description
`id`	string	Payment Link ID (plink_...)
`shortUrl`	string	Short URL to send to the customer
`status`	string	created, partially_paid, paid, expired, or cancelled
`amount`	number	Amount in the major unit (rupees for INR)
`amountPaise`	number	Amount in the smallest unit (paise for INR)
`amountPaid`	number	Amount paid so far in the major unit
`amountPaidPaise`	number	Amount paid so far in the smallest unit
`currency`	string	Currency code, e.g. INR
`description`	string	Description shown to the customer
`referenceId`	string	Your reference ID for the link
`customerName`	string	Customer name
`customerEmail`	string	Customer email
`customerContact`	string	Customer phone number
`notifySms`	boolean	Whether Razorpay sends the link by SMS
`notifyEmail`	boolean	Whether Razorpay sends the link by email
`reminderEnable`	boolean	Whether Razorpay sends payment reminders
`acceptPartial`	boolean	Whether partial payments are allowed
`upiLink`	boolean	Whether this is a UPI Payment Link
`callbackUrl`	string	Where the customer is redirected after paying
`orderId`	string	Order ID created for the link
`expireBy`	number	When the link expires (Unix seconds, 0 if not set)
`expiredAt`	number	When the link expired (Unix seconds, 0 if not expired)
`cancelledAt`	number	When the link was cancelled (Unix seconds, 0 if not cancelled)
`createdAt`	number	When it was created (Unix seconds)
`updatedAt`	number	When it was last updated (Unix seconds)
`notes`	json	Key-value notes stored on the entity
`payments`	array	Captured payments against the link
↳ `paymentId`	string	Payment ID (pay_...)
↳ `amount`	number	Amount in the major unit
↳ `amountPaise`	number	Amount in the smallest unit
↳ `method`	string	Payment method, e.g. upi or card
↳ `status`	string	Payment status
↳ `createdAt`	number	When it was created (Unix seconds)

Razorpay Get Refund

Get a Razorpay Refund by ID with its status (pending, processed, failed), amount, and whether it was processed instantly.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`refundId`	string	Yes	Refund ID, e.g. rfnd_FP8QHiV938haTz

Output

Parameter	Type	Description
`id`	string	Refund ID (rfnd_...)
`paymentId`	string	Payment ID that was refunded
`status`	string	pending, processed, or failed
`amount`	number	Refund amount in the major unit (rupees for INR)
`amountPaise`	number	Refund amount in the smallest unit (paise for INR)
`currency`	string	Currency code, e.g. INR
`receipt`	string	Your receipt number for the refund
`speedRequested`	string	normal or optimum
`speedProcessed`	string	instant or normal
`createdAt`	number	When it was created (Unix seconds)
`notes`	json	Key-value notes stored on the entity

Razorpay List Payment Links

List Razorpay Payment Links, optionally only the link with a given reference ID or the link a payment was made on. Use the reference ID to find the link you created for a lead or invoice.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`paymentId`	string	No	Only the link this payment was made on, e.g. pay_FHfAzEJ51k8NLj
`referenceId`	string	No	Only the link with this reference ID

Output

Parameter	Type	Description
`paymentLinks`	array	Payment Links
↳ `id`	string	Payment Link ID (plink_...)
↳ `shortUrl`	string	Short URL to send to the customer
↳ `status`	string	created, partially_paid, paid, expired, or cancelled
↳ `amount`	number	Amount in the major unit (rupees for INR)
↳ `amountPaise`	number	Amount in the smallest unit (paise for INR)
↳ `amountPaid`	number	Amount paid so far in the major unit
↳ `amountPaidPaise`	number	Amount paid so far in the smallest unit
↳ `currency`	string	Currency code, e.g. INR
↳ `description`	string	Description shown to the customer
↳ `referenceId`	string	Your reference ID for the link
↳ `customerName`	string	Customer name
↳ `customerEmail`	string	Customer email
↳ `customerContact`	string	Customer phone number
↳ `notifySms`	boolean	Whether Razorpay sends the link by SMS
↳ `notifyEmail`	boolean	Whether Razorpay sends the link by email
↳ `reminderEnable`	boolean	Whether Razorpay sends payment reminders
↳ `acceptPartial`	boolean	Whether partial payments are allowed
↳ `upiLink`	boolean	Whether this is a UPI Payment Link
↳ `callbackUrl`	string	Where the customer is redirected after paying
↳ `orderId`	string	Order ID created for the link
↳ `expireBy`	number	When the link expires (Unix seconds, 0 if not set)
↳ `expiredAt`	number	When the link expired (Unix seconds, 0 if not expired)
↳ `cancelledAt`	number	When the link was cancelled (Unix seconds, 0 if not cancelled)
↳ `createdAt`	number	When it was created (Unix seconds)
↳ `updatedAt`	number	When it was last updated (Unix seconds)
↳ `notes`	json	Key-value notes stored on the entity
↳ `payments`	array	Captured payments against the link
↳ `paymentId`	string	Payment ID (pay_...)
↳ `amount`	number	Amount in the major unit
↳ `amountPaise`	number	Amount in the smallest unit
↳ `method`	string	Payment method, e.g. upi or card
↳ `status`	string	Payment status
↳ `createdAt`	number	When it was created (Unix seconds)
`count`	number	Number of Payment Links returned

Razorpay List Payments

List Razorpay Payments, optionally between two times. Returns up to 100 per call; use skip to page.

Input

Parameter	Type	Required	Description
`keyId`	string	Yes	Razorpay Key ID (Dashboard → Account & Settings → API Keys), e.g. rzp_test_...
`keySecret`	string	Yes	Razorpay Key Secret shown once when the key is generated
`from`	string	No	Only payments created at or after this time (Unix seconds or ISO 8601 date)
`to`	string	No	Only payments created at or before this time (Unix seconds or ISO 8601 date)
`count`	number	No	Number of payments to return, 1 to 100. Defaults to 10
`skip`	number	No	Number of payments to skip, for paging

Output

Parameter	Type	Description
`payments`	array	Payments
↳ `id`	string	Payment ID (pay_...)
↳ `status`	string	created, authorized, captured, refunded, or failed
↳ `amount`	number	Amount in the major unit (rupees for INR)
↳ `amountPaise`	number	Amount in the smallest unit (paise for INR)
↳ `currency`	string	Currency code, e.g. INR
↳ `method`	string	card, netbanking, wallet, emi, upi, or paylater
↳ `orderId`	string	Order ID the payment belongs to
↳ `invoiceId`	string	Invoice ID, if any
↳ `customerId`	string	Customer ID, if any
↳ `description`	string	Payment description
↳ `captured`	boolean	Whether the payment is captured
↳ `international`	boolean	Whether the payment used an international card
↳ `amountRefunded`	number	Amount refunded in the major unit
↳ `amountRefundedPaise`	number	Amount refunded in the smallest unit
↳ `refundStatus`	string	null, partial, or full
↳ `email`	string	Customer email
↳ `contact`	string	Customer phone number
↳ `bank`	string	Bank code for netbanking payments
↳ `wallet`	string	Wallet name for wallet payments
↳ `vpa`	string	Customer UPI ID for UPI payments
↳ `fee`	number	Razorpay fee including GST, in the major unit
↳ `feePaise`	number	Razorpay fee including GST, in the smallest unit
↳ `tax`	number	GST on the fee, in the major unit
↳ `taxPaise`	number	GST on the fee, in the smallest unit
↳ `errorCode`	string	Error code for failed payments
↳ `errorDescription`	string	Error description for failed payments
↳ `errorReason`	string	Error reason for failed payments
↳ `createdAt`	number	When it was created (Unix seconds)
↳ `notes`	json	Key-value notes stored on the entity
`count`	number	Number of payments returned

Razorpay

On this page