Skip to main content
The payments endpoints let you inspect individual payments, list historical payments, update payment notes, and manually capture authorized payments.

Get payment

GET /api/auth/razorpay/payment Retrieves a single Razorpay payment by id. Server API name: getRazorpayPayment
Client method: authClient.razorpay.payment({ query: { id } })
string
required
Razorpay payment id, for example pay_XXXX.
Errors: PAYMENT_FETCH_FAILED.

List payments

GET /api/auth/razorpay/payment/list Lists Razorpay payments with pagination and optional filters. Server API name: fetchAllPayments
Client method: authClient.razorpay.payment.list({ query: { ... } })
integer
Unix timestamp. Return payments created after this time.
integer
Unix timestamp. Return payments created before this time.
integer
Maximum number of payments to return. Maximum value is 100.
integer
Number of payments to skip.
string
Comma-separated list of related resources to expand.
string
Filter by reference id.
string
Filter by transfer details.
Errors: PAYMENT_LIST_FAILED.

Edit payment

POST /api/auth/razorpay/payment/edit Updates the notes on an existing Razorpay payment. Server API name: editPayment
Client method: authClient.razorpay.payment.edit(...)
string
required
Razorpay payment id to update.
object
New notes object. Up to 15 key-value pairs, values 256 characters or fewer.
Errors: PAYMENT_EDIT_FAILED.

Capture payment

POST /api/auth/razorpay/payment/capture Manually captures an authorized payment. Use this when you create an order with paymentCapture: false and want to capture the payment later, for example after verifying stock or shipping details. Server API name: captureRazorpayPayment
Client method: authClient.razorpay.payment.capture(...)
string
required
Razorpay payment id to capture.
integer
required
Amount to capture, in subunits. Must not exceed the authorized amount.
string
default:"INR"
ISO 4217 currency code. Three characters.
Errors: PAYMENT_NOT_CAPTURED.