Overview
- GET /v1/customers
- POST /v1/customers
- GET /v1/customers/{cust_id}
- PUT /v1/customers/{cust_id}
- PARAMETERS /v1/customers/{cust_id}
- GET /v1/orders
- POST /v1/orders
- GET /v1/orders/{order_id}
- PATCH /v1/orders/{order_id}
- PARAMETERS /v1/orders/{order_id}
- GET /v1/orders/{order_id}/payments
- PARAMETERS /v1/orders/{order_id}/payments
- GET /v1/payments/downtimes
- GET /v1/payments/downtimes/down_F1cxDoHWD4fkQt
- GET /v1/payments/
- GET /v1/payments/{pay_id}
- PATCH /v1/payments/{pay_id}
- PARAMETERS /v1/payments/{pay_id}
- GET /v1/payments/{pay_id}/card
- PARAMETERS /v1/payments/{pay_id}/card
- POST /v1/payments/{pay_id}/capture
- PARAMETERS /v1/payments/{pay_id}/capture
- GET /v1/payments/{id}/
- PARAMETERS /v1/payments/{id}/
- POST /v1/payments/{pay_id}/refund
- PARAMETERS /v1/payments/{pay_id}/refund
- GET /v1/refunds
- GET /v1/refunds/{rfnd_id}
- PATCH /v1/refunds/{rfnd_id}
- PARAMETERS /v1/refunds/{rfnd_id}
- GET /v1/payments/{pay_id}/refunds/{rfnd_id}
- PARAMETERS /v1/payments/{pay_id}/refunds/{rfnd_id}
- GET /v1/payments/{pay_id}/refunds
- PARAMETERS /v1/payments/{pay_id}/refunds
- GET /v1/settlements/ondemand
- POST /v1/settlements/ondemand
- GET /v1/settlements/ondemand/{sod_id}
- PARAMETERS /v1/settlements/ondemand/{sod_id}
- GET /v1/settlements/ondemand/setlod_FNj7g2YS5J67Rz
- GET /v1/settlements/recon/combined
- GET /v1/settlements/{setl_id}
- PARAMETERS /v1/settlements/{setl_id}
- GET /v1/settlements
- POST /v1/documents
- GET /v1/documents/{id}
- PARAMETERS /v1/documents/{id}
- GET /v1/documents/{id}/content
- PARAMETERS /v1/documents/{id}/content
- GET /v1/disputes
- POST /v1/disputes/{id}/accept
- PARAMETERS /v1/disputes/{id}/accept
- PATCH /v1/disputes/{id}/contest/
- PARAMETERS /v1/disputes/{id}/contest/
- GET /app/disputes/disp_K8bVLppJ8zp5Wp
- GET /v1/invoices
- POST /v1/invoices
- GET /v1/invoices/{inv_id}
- DELETE /v1/invoices/{inv_id}
- PATCH /v1/invoices/{inv_id}
- PARAMETERS /v1/invoices/{inv_id}
- POST /v1/invoices/{inv_id}/issue
- PARAMETERS /v1/invoices/{inv_id}/issue
- POST /v1/invoices/{inv_id}/notify_by/{medium}
- PARAMETERS /v1/invoices/{inv_id}/notify_by/{medium}
- POST /v1/invoices/{inv_id}/cancel
- PARAMETERS /v1/invoices/{inv_id}/cancel
- GET /v1/items
- POST /v1/items
- GET /v1/items/{item_id}
- DELETE /v1/items/{item_id}
- PATCH /v1/items/{item_id}
- PARAMETERS /v1/items/{item_id}
- GET /v1/plans
- POST /v1/plans
- GET /v1/plans/{plan_id}
- PARAMETERS /v1/plans/{plan_id}
- GET /v1/subscriptions
- POST /v1/subscriptions
- GET /v1/subscriptions/{sub_id}
- PATCH /v1/subscriptions/{sub_id}
- PARAMETERS /v1/subscriptions/{sub_id}
- POST /v1/subscriptions/{sub_id}/cancel
- PARAMETERS /v1/subscriptions/{sub_id}/cancel
- GET /v1/subscriptions/{sub_id}/retrieve_scheduled_changes
- PARAMETERS /v1/subscriptions/{sub_id}/retrieve_scheduled_changes
- POST /v1/subscriptions/{sub_id}/cancel_scheduled_changes
- PARAMETERS /v1/subscriptions/{sub_id}/cancel_scheduled_changes
- POST /v1/subscriptions/{sub_id}/pause
- PARAMETERS /v1/subscriptions/{sub_id}/pause
- POST /v1/subscriptions/{sub_id}/resume
- PARAMETERS /v1/subscriptions/{sub_id}/resume
- GET /v1//invoices
- DELETE /subscriptions/{sub_id}/{offer_id}
- PARAMETERS /subscriptions/{sub_id}/{offer_id}
- POST /v1/subscriptions/{sub_id}/addons
- PARAMETERS /v1/subscriptions/{sub_id}/addons
- GET /v1/addons/
- GET /v1/addons/{ao_id}
- DELETE /v1/addons/{ao_id}
- PARAMETERS /v1/addons/{ao_id}
- POST /v1/payment_links
- GET /v1/payment_links/{plink_id}
- PATCH /v1/payment_links/{plink_id}
- PARAMETERS /v1/payment_links/{plink_id}
- POST /v1/payment_links/{plink_id}/cancel
- PARAMETERS /v1/payment_links/{plink_id}/cancel
- GET /v1/payment_links/
- POST /v1/payment_links/
- POST /v1/payment_links/{plink_id}/notify_by/sms
- PARAMETERS /v1/payment_links/{plink_id}/notify_by/sms
- GET /v1/virtual_accounts/{va_id}
- PARAMETERS /v1/virtual_accounts/{va_id}
- GET /v1/virtual_accounts
- POST /v1/virtual_accounts
- GET /v1/virtual_accounts/{va_id}/payments
- PARAMETERS /v1/virtual_accounts/{va_id}/payments
- GET /v1/payments/{pay_id}/bank_transfer
- PARAMETERS /v1/payments/{pay_id}/bank_transfer
- POST /v1/virtual_accounts/{va_id}/close
- PARAMETERS /v1/virtual_accounts/{va_id}/close
- POST /v1/virtual_accounts/{va_id}/receiver
- PARAMETERS /v1/virtual_accounts/{va_id}/receiver
- POST /v1/virtual_accounts/{va_id}/allowed_payers
- PARAMETERS /v1/virtual_accounts/{va_id}/allowed_payers
- DELETE /v1/virtual_accounts/va_DlGmm7jInLudH9/allowed_payers/ba_DlGmm9mSj8fjRM
- POST /v1/virtual_accounts/va_DzcFjMezDcN8vv/receivers
- POST /v1/virtual_accounts/va_DzaBLzIz494C64/receivers
- GET /v1/payments/{pay_id}/upi_transfer
- PARAMETERS /v1/payments/{pay_id}/upi_transfer
- GET /v1/payments
- POST /v1/virtual_accounts/va_KFIrkRmd70ylIg
- GET /v1/payments/{pay_id}/transfers
- POST /v1/payments/{pay_id}/transfers
- PARAMETERS /v1/payments/{pay_id}/transfers
- GET /v1/transfers
- POST /v1/transfers
- GET /v1/orders/order_DSkl2lBNvueOly/
- GET /v1/transfers/{trf_id}
- PATCH /v1/transfers/{trf_id}
- PARAMETERS /v1/transfers/{trf_id}
- GET /v1/transfers/{trf_id}/reversals
- POST /v1/transfers/{trf_id}/reversals
- PARAMETERS /v1/transfers/{trf_id}/reversals
- POST /v2/accounts
- PATCH /v2/accounts/acc_GP4lfNA0iIMn5B
- GET /v2/accounts/acc_GLGeLkU2JUeyDZ
- POST /v2/accounts/acc_GLGeLkU2JUeyDZ/stakeholders
- PATCH /v2/accounts/acc_GLGeLkU2JUeyDZ/stakeholders/sth_GOQ4Eftlz62TSL
- POST /v2/accounts/acc_HQVlm3bnPmccC0/products
- GET /v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/
- PATCH /v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/
- GET /v1/contacts
- POST /v1/contacts
- GET /v1/contacts/{cont_id}
- PATCH /v1/contacts/{cont_id}
- PARAMETERS /v1/contacts/{cont_id}
- GET /v1/fund_accounts
- POST /v1/fund_accounts
- GET /v1/fund_accounts/{fa_id}
- PARAMETERS /v1/fund_accounts/{fa_id}
- PATCH /v1//fund_accounts/{id}
- PARAMETERS /v1//fund_accounts/{id}
- GET /v1/payouts
- POST /v1/payouts
- GET /v1/payouts/{pout_id}
- PARAMETERS /v1/payouts/{pout_id}
- POST /v1/payouts/{pout_id}/cancel
- PARAMETERS /v1/payouts/{pout_id}/cancel
- GET /v1/payout-links
- POST /v1/payout-links
- GET /v1/payout-links/{poutlk_id}
- PARAMETERS /v1/payout-links/{poutlk_id}
- POST /v1/payout-links/{poutlk_id}/cancel
- PARAMETERS /v1/payout-links/{poutlk_id}/cancel
- GET /v1/transactions
- GET /v1/transactions/{txn_id}
- PARAMETERS /v1/transactions/{txn_id}
- GET /v1/fund_accounts/validations
- POST /v1/fund_accounts/validations
- GET /v1/fund_accounts/validations/{fav_id}
- PARAMETERS /v1/fund_accounts/validations/{fav_id}
- GET /v2/accounts/{account_id}
- DELETE /v2/accounts/{account_id}
- PATCH /v2/accounts/{account_id}
- PARAMETERS /v2/accounts/{account_id}
- GET /v2/accounts/{account_id}/stakeholders
- POST /v2/accounts/{account_id}/stakeholders
- PARAMETERS /v2/accounts/{account_id}/stakeholders
- GET /v2/accounts/{account_id}/stakeholders/{stakeholder_id}
- PATCH /v2/accounts/{account_id}/stakeholders/{stakeholder_id}
- PARAMETERS /v2/accounts/{account_id}/stakeholders/{stakeholder_id}
- POST /v2/accounts/{account_id}/stakeholders/{stakeholder_id}/documents
- PARAMETERS /v2/accounts/{account_id}/stakeholders/{stakeholder_id}/documents
- GET /v2/accounts/{account_id}/documents
- POST /v2/accounts/{account_id}/documents
- PARAMETERS /v2/accounts/{account_id}/documents
- GET /v2/accounts/{account_id}/stakeholders/{stakeholders_id}/documents
- PARAMETERS /v2/accounts/{account_id}/stakeholders/{stakeholders_id}/documents
- POST /v2/accounts/{account_id}/products
- PARAMETERS /v2/accounts/{account_id}/products
- GET /v2/accounts/{account_id}/products/{product_id}
- PATCH /v2/accounts/{account_id}/products/{product_id}
- PARAMETERS /v2/accounts/{account_id}/products/{product_id}
- GET /v2/accounts/{account_id}/webhooks
- POST /v2/accounts/{account_id}/webhooks
- PARAMETERS /v2/accounts/{account_id}/webhooks
- GET /v2/accounts/{account_id}/webhooks/{webhook_id}
- PARAMETERS /v2/accounts/{account_id}/webhooks/{webhook_id}
- DELETE /v2/accounts/{account_id}/webhooks/{webhooks_id}
- PATCH /v2/accounts/{account_id}/webhooks/{webhooks_id}
- PARAMETERS /v2/accounts/{account_id}/webhooks/{webhooks_id}
- POST /v2/accounts/{account_id}/tnc
- PARAMETERS /v2/accounts/{account_id}/tnc
- POST /v2/products/{product_name}/tnc
- PARAMETERS /v2/products/{product_name}/tnc
- GET /v1/payments/qr_codes
- POST /v1/payments/qr_codes
- POST /v1/payments/qr_codes/{qr_id}/close
- PARAMETERS /v1/payments/qr_codes/{qr_id}/close
- GET /v1/payments/qr_codes/{qr_id}
- PARAMETERS /v1/payments/qr_codes/{qr_id}
- GET /v1/payments/qr_codes/{qr_id}/payments
- PARAMETERS /v1/payments/qr_codes/{qr_id}/payments
GET /v1/customers
Summary: Fetch all Customers
Retrieve details of all customers using the Fetch all Customers API.
Know more about the Fetch all Customers API.
OpenAPI snippet URL
POST /v1/customers
Summary: Create a Customer
Create a customer using the Create a Customer API. You can add your customer’s name, email and contact number. In the response, you will receive a customer_id.
Know more about the Create a Customer API.
OpenAPI snippet URL
GET /v1/customers/{cust_id}
Summary: Fetch Customer by ID
Retrieve details of a specific customer using the Fetch a Customer by ID API. You can send the customer_id as a path parameter to retrieve the customer details.
Know more about the Fetch a Customer by ID API.
OpenAPI snippet URL
PUT /v1/customers/{cust_id}
Summary: Edit a Customer
Update details of a specific customer using the Edit a Customer API. You can send the customer_id as a path parameter to access and edit the customer details.
Know more about the Edit a Customer API.
OpenAPI snippet URL
PARAMETERS /v1/customers/{cust_id}
OpenAPI snippet URL
GET /v1/orders
Summary: Fetch Orders
Fetch all orders created on your account using this API.
Know more about the Fetch all Orders API.
OpenAPI snippet URL
POST /v1/orders
Summary: Create an Order
Create an order using this API. Amount and currency are mandatory parameters.
Know more about the Create an Order API.
OpenAPI snippet URL
GET /v1/orders/{order_id}
Summary: Fetch Orders by ID
Fetch a particular order with the order_id using this API.
Know more about the Fetch Orders by ID API.
OpenAPI snippet URL
PATCH /v1/orders/{order_id}
Summary: Update Order
Update a particular order using this API.
Know more about the Update an Order API.
OpenAPI snippet URL
PARAMETERS /v1/orders/{order_id}
OpenAPI snippet URL
GET /v1/orders/{order_id}/payments
Summary: Fetch Payments by Order
Fetch payments made for a particular order using this API.
Know more about the Fetch Payments For an Orders API.
OpenAPI snippet URL
PARAMETERS /v1/orders/{order_id}/payments
OpenAPI snippet URL
GET /v1/payments/downtimes
Summary: Fetch Payment Downtime Details
Fetch details of all payment downtimes using this API.
Know more about the Fetch Payment Downtime Details API
OpenAPI snippet URL
GET /v1/payments/downtimes/down_F1cxDoHWD4fkQt
Summary: Fetch Payment Downtime Details by ID
Fetch details of particular payment downtime using this API.
Know more about the Fetch Payment Downtime Details by ID API
OpenAPI snippet URL
GET /v1/payments/
Summary: Fetch all Payments
Fetch all payments made to your account using this API.
Know more about the Fetch all Payments API.
OpenAPI snippet URL
GET /v1/payments/{pay_id}
Summary: Fetch Payment by ID
Fetch the details of a particular payment using this API.
Know more about the Fetch a Payment by ID API.
OpenAPI snippet URL
PATCH /v1/payments/{pay_id}
Summary: Update Payment
Update the details of a specific payment using the API.
Know more about the Update a Payment API.
OpenAPI snippet URL
PARAMETERS /v1/payments/{pay_id}
OpenAPI snippet URL
GET /v1/payments/{pay_id}/card
Summary: Fetch Card Details for a Payment
Fetch the details of the card used to make a payment using the API.
Know more about the Fetch Card Details of a Payment API.
OpenAPI snippet URL
PARAMETERS /v1/payments/{pay_id}/card
OpenAPI snippet URL
POST /v1/payments/{pay_id}/capture
Summary: Capture a Payment
Change the status of payment from authorized to captured using this API.
Know more about the Capture a Payment API.
OpenAPI snippet URL
PARAMETERS /v1/payments/{pay_id}/capture
OpenAPI snippet URL
GET /v1/payments/{id}/
Summary: Fetch a Payment (With Expanded Card Details)
Fetch a Payment (With Expanded Card Details)
OpenAPI snippet URL
PARAMETERS /v1/payments/{id}/
OpenAPI snippet URL
POST /v1/payments/{pay_id}/refund
Summary: Create a Normal Refund
Create a normal refund using this API. You can refund the entire amount or a partial amount. For example, for payment of INR100, you can refund the entire INR100 or INR50.
Know more about the Create a Normal Refund API.
OpenAPI snippet URL
PARAMETERS /v1/payments/{pay_id}/refund
OpenAPI snippet URL
GET /v1/refunds
Summary: Fetch Refunds
Fetch all refunds created by you using this API.
Know more about the Fetch all Refunds API.
OpenAPI snippet URL
GET /v1/refunds/{rfnd_id}
Summary: Fetch Refund by ID
Fetch a specific refund created by you using this API.
Know more about the Fetch a Refund API.
OpenAPI snippet URL
PATCH /v1/refunds/{rfnd_id}
Summary: Update Refund
Update a specific refund using this API.
Know more about the Update a Refund API.
OpenAPI snippet URL
PARAMETERS /v1/refunds/{rfnd_id}
OpenAPI snippet URL
GET /v1/payments/{pay_id}/refunds/{rfnd_id}
Summary: Fetch a Specific Refund for a Payment
Fetch a specific refund for a specific payment using this API.
Know more about the Fetch a Specific Refund for a Specific Payment API.
OpenAPI snippet URL
PARAMETERS /v1/payments/{pay_id}/refunds/{rfnd_id}
OpenAPI snippet URL
GET /v1/payments/{pay_id}/refunds
Summary: Fetch All Refunds for a Payment
Fetch multiple refunds for a specific payment using this API.
Know more about the Fetch all Refunds for a Payment API.
OpenAPI snippet URL
PARAMETERS /v1/payments/{pay_id}/refunds
OpenAPI snippet URL
GET /v1/settlements/ondemand
Summary: Fetch all Instant Settlements
Fetch all on-demand settlements created by you using this API.
Know more about the Fetch all On-demand Settlements API.
OpenAPI snippet URL
POST /v1/settlements/ondemand
Summary: Create Instant Settlement
Create an on-demand settlement using this API. Here, amount is a mandatory parameter.
Know more about the Create an On-demand Settlement API.
OpenAPI snippet URL
GET /v1/settlements/ondemand/{sod_id}
Summary: Fetch Instant Settlement by ID
Fetch a specific on-demand settlement created by you using this API.
Know more about the Fetch On-demand Settlements by ID API.
OpenAPI snippet URL
PARAMETERS /v1/settlements/ondemand/{sod_id}
OpenAPI snippet URL
GET /v1/settlements/ondemand/setlod_FNj7g2YS5J67Rz
Summary: Fetch Instant Settlement by ID With Payout Details
Fetch Instant Settlement by ID With Payout Details
OpenAPI snippet URL
GET /v1/settlements/recon/combined
Summary: Settlements Recon
Fetch a list of all transactions such as payments, refunds, transfers and adjustments that have been settled to you for a particular day or month, using this API.
Know more about the Settlement Recon API.
OpenAPI snippet URL
GET /v1/settlements/{setl_id}
Summary: Fetch Settlement by ID
Fetch details of a particular settlement using this API.
Know more about the Fetch Settlement by ID API.
OpenAPI snippet URL
PARAMETERS /v1/settlements/{setl_id}
OpenAPI snippet URL
GET /v1/settlements
Summary: Fetch All Settlements
Fetch details of all settlements using this API.
Know more about the Fetch All Settlements API.
OpenAPI snippet URL
POST /v1/documents
Summary: Create a Document
Create a Document
OpenAPI snippet URL
GET /v1/documents/{id}
Summary: Fetch Document Information
Fetch Document Information
OpenAPI snippet URL
PARAMETERS /v1/documents/{id}
OpenAPI snippet URL
GET /v1/documents/{id}/content
Summary: Fetch Document Content
Fetch Document Content
OpenAPI snippet URL
PARAMETERS /v1/documents/{id}/content
OpenAPI snippet URL
GET /v1/disputes
Summary: Fetch All Disputes
Fetch the list of all disputes using this API.
Know more about the Fetch All Disputes API.
OpenAPI snippet URL
POST /v1/disputes/{id}/accept
Summary: Accept a Dispute
Accept a Dispute
OpenAPI snippet URL
PARAMETERS /v1/disputes/{id}/accept
OpenAPI snippet URL
PATCH /v1/disputes/{id}/contest/
Summary: Contest a Dispute
Contest a Dispute
OpenAPI snippet URL
PARAMETERS /v1/disputes/{id}/contest/
OpenAPI snippet URL
GET /app/disputes/disp_K8bVLppJ8zp5Wp
Summary: Fetch a Dispute (With Expanded Payments Details)
Fetch a Dispute (With Expanded Payments Details)
OpenAPI snippet URL
GET /v1/invoices
Summary: Fetch Invoices
Fetch all invoices created by you using this API.
Know more about the Fetch all Invoices API.
OpenAPI snippet URL
POST /v1/invoices
Summary: Create an Invoice with Customer Id
Create an Invoice using the Create an Invoice API.
Some points to note. You can:
- Create a blank invoice (with no details at all) in draft state.
- Update it with necessary information.
- Issue it at a later time with the Issue Invoice API. Only after the invoice is issued, you will get a short URL. Also, only after the invoice is issued, it can be sent to customers and the corresponding payment can be made against it.
- Use Items APIs to create items which you can later use as a template to create line items in an invoice.
Know more about the Create an Invoice API.
OpenAPI snippet URL
GET /v1/invoices/{inv_id}
Summary: Fetch Invoice by Id
Fetch an invoice created by you using this API.
Know more about the Fetch an Invoice API.
OpenAPI snippet URL
DELETE /v1/invoices/{inv_id}
Summary: Delete an Invoice
Delete an invoice using this API.
Know more about the Delete an Invoice API.
OpenAPI snippet URL
PATCH /v1/invoices/{inv_id}
Summary: Update an Invoice
Update an invoice using this API.
Know more about the Update an Invoice API.
OpenAPI snippet URL
PARAMETERS /v1/invoices/{inv_id}
OpenAPI snippet URL
POST /v1/invoices/{inv_id}/issue
Summary: Issue an Invoice
Issue an invoice using this API.
Know more about the Issue an Invoice API.
OpenAPI snippet URL
PARAMETERS /v1/invoices/{inv_id}/issue
OpenAPI snippet URL
POST /v1/invoices/{inv_id}/notify_by/{medium}
Summary: Send or Resend Notification
Send or resend an invoice notification using this API.
Know more about the Send/Resend a Notification API.
OpenAPI snippet URL
PARAMETERS /v1/invoices/{inv_id}/notify_by/{medium}
OpenAPI snippet URL
POST /v1/invoices/{inv_id}/cancel
Summary: Cancel an Invoice
Cancel an invoice using this API.
Know more about the Cancel an Invoice API.
OpenAPI snippet URL
PARAMETERS /v1/invoices/{inv_id}/cancel
OpenAPI snippet URL
GET /v1/items
Summary: Fetch Items
Use this API to fetch multiple items.
OpenAPI snippet URL
POST /v1/items
Summary: Create an Item
Create an Item
OpenAPI snippet URL
GET /v1/items/{item_id}
Summary: Fetch Item by ID
Use this API to fetch a specific item.
OpenAPI snippet URL
DELETE /v1/items/{item_id}
Summary: Delete an Item
Use this API to delete a specific item.
OpenAPI snippet URL
PATCH /v1/items/{item_id}
Summary: Update an Item
Use this API to update a specific item.
OpenAPI snippet URL
PARAMETERS /v1/items/{item_id}
OpenAPI snippet URL
GET /v1/plans
Summary: Fetch All Plans
You can fetch all the plans created by you. Know more about the Fetch all Plans API.
OpenAPI snippet URL
POST /v1/plans
Summary: Create Plan
You must create a plan before creating a subscription via the Checkout or using the Subscription Link feature.
Know more about the Create a Plan API.
OpenAPI snippet URL
GET /v1/plans/{plan_id}
Summary: Fetch Plans by ID
You can fetch a particular plan using its ID. Know more about the Fetch a Plan API.
OpenAPI snippet URL
PARAMETERS /v1/plans/{plan_id}
OpenAPI snippet URL
GET /v1/subscriptions
Summary: Fetch All Subscriptions
You can fetch all the subscriptions created by you using the Fetch All Subscriptions API.
OpenAPI snippet URL
POST /v1/subscriptions
Summary: Create Subscription
You can create a subscription using the a Create a Subscription API.
OpenAPI snippet URL
GET /v1/subscriptions/{sub_id}
Summary: Fetch Subscriptions by ID
You can fetch a specific subscription created by you using the Fetch a Subscription API.
OpenAPI snippet URL
PATCH /v1/subscriptions/{sub_id}
Summary: Update Subscription
You can update a specific subscription created by you using the Update a Subscription API.
OpenAPI snippet URL
PARAMETERS /v1/subscriptions/{sub_id}
OpenAPI snippet URL
POST /v1/subscriptions/{sub_id}/cancel
Summary: Cancel Subscription
You can cancel a specific subscription created by you using the Cancel a Subscription API.
OpenAPI snippet URL
PARAMETERS /v1/subscriptions/{sub_id}/cancel
OpenAPI snippet URL
GET /v1/subscriptions/{sub_id}/retrieve_scheduled_changes
Summary: Fetch Details of a Pending Update
You can fetch the details of a pending update using the Fetch details of a pending update API.
OpenAPI snippet URL
PARAMETERS /v1/subscriptions/{sub_id}/retrieve_scheduled_changes
OpenAPI snippet URL
POST /v1/subscriptions/{sub_id}/cancel_scheduled_changes
Summary: Cancel Pending Update
You can cancel a pending update using the Cancel a pending update API.
OpenAPI snippet URL
PARAMETERS /v1/subscriptions/{sub_id}/cancel_scheduled_changes
OpenAPI snippet URL
POST /v1/subscriptions/{sub_id}/pause
Summary: Pause a Subscription
You can pause a subscription using the Pause a Subscription API.
OpenAPI snippet URL
PARAMETERS /v1/subscriptions/{sub_id}/pause
OpenAPI snippet URL
POST /v1/subscriptions/{sub_id}/resume
Summary: Resume a Subscription
You can resume a paused subscription using the Resume a Subscription API.
OpenAPI snippet URL
PARAMETERS /v1/subscriptions/{sub_id}/resume
OpenAPI snippet URL
GET /v1//invoices
Summary: Fetch All Invoices for a Subscription
You can fetch all invoices for a subscription using the Fetch All Invoices for a Subscription API. Here, the count indicates the number of invoices generated for the subscription.
OpenAPI snippet URL
DELETE /subscriptions/{sub_id}/{offer_id}
Summary: Delete an Offer Linked to a Subscription
You can delete an offer linked to a subscription using the Delete an offer linked to a Subscription API.
OpenAPI snippet URL
PARAMETERS /subscriptions/{sub_id}/{offer_id}
OpenAPI snippet URL
POST /v1/subscriptions/{sub_id}/addons
Summary: Create Add-on
You can create an add-on using the Create an Add-on API.
OpenAPI snippet URL
PARAMETERS /v1/subscriptions/{sub_id}/addons
OpenAPI snippet URL
GET /v1/addons/
Summary: Fetch All Add-ons
You can fetch all add-ons created by you using the Fetch all Add-ons API.
OpenAPI snippet URL
GET /v1/addons/{ao_id}
Summary: Fetch Add-on by ID
You can fetch a particular add-on created by you using the Fetch an Add-on API.
OpenAPI snippet URL
DELETE /v1/addons/{ao_id}
Summary: Delete Add-on
You can delete a particular add-on created by you using the Delete an Add-on API.
OpenAPI snippet URL
PARAMETERS /v1/addons/{ao_id}
OpenAPI snippet URL
POST /v1/payment_links
Summary: Create a Payment Link
You can create a payment link using the Create a Payment Link API.
OpenAPI snippet URL
GET /v1/payment_links/{plink_id}
Summary: Fetch a Payment Link
You can fetch a specific payment link using the Fetch a Payment Link API.
OpenAPI snippet URL
PATCH /v1/payment_links/{plink_id}
Summary: Update a Payment Link
You can update a specific payment link using the Update a Payment Link API.
OpenAPI snippet URL
PARAMETERS /v1/payment_links/{plink_id}
OpenAPI snippet URL
POST /v1/payment_links/{plink_id}/cancel
Summary: Cancel a Payment Link
You can cancel a specific payment link using the Cancel a Payment Link API.
OpenAPI snippet URL
PARAMETERS /v1/payment_links/{plink_id}/cancel
OpenAPI snippet URL
GET /v1/payment_links/
Summary: Fetch all Payment Links
You can fetch all payment links using the Fetch all Payment Links API.
OpenAPI snippet URL
POST /v1/payment_links/
Summary: Customize Payment Methods on Razorpay Checkout
Learn how to enable and display specific payment methods on Razorpay Checkout.
OpenAPI snippet URL
POST /v1/payment_links/{plink_id}/notify_by/sms
Summary: Resend a Payment Link
You can resend a specific payment link using the Resend a Payment Link API.
OpenAPI snippet URL
PARAMETERS /v1/payment_links/{plink_id}/notify_by/sms
OpenAPI snippet URL
GET /v1/virtual_accounts/{va_id}
Summary: Fetch a Customer Identifier By ID
You can use this API to fetch a specific virtual account using its ID.
OpenAPI snippet URL
PARAMETERS /v1/virtual_accounts/{va_id}
OpenAPI snippet URL
GET /v1/virtual_accounts
Summary: Fetch All Customer Identifiers
You can use this API to fetch all the virtual accounts.
OpenAPI snippet URL
POST /v1/virtual_accounts
Summary: Create a Customer Identifier
You can create a virtual account using this API.
OpenAPI snippet URL
GET /v1/virtual_accounts/{va_id}/payments
Summary: Fetch Payments Made to a Customer Identifier
You can use this API to retrieve payments made to a specific virtual account.
OpenAPI snippet URL
PARAMETERS /v1/virtual_accounts/{va_id}/payments
OpenAPI snippet URL
GET /v1/payments/{pay_id}/bank_transfer
Summary: Method is Bank Transfer
You can use this API to retrieve details of payments using the Payment ID and transfer method.
OpenAPI snippet URL
PARAMETERS /v1/payments/{pay_id}/bank_transfer
OpenAPI snippet URL
POST /v1/virtual_accounts/{va_id}/close
Summary: Close a Customer Identifier
Use this API to close a virtual account.
OpenAPI snippet URL
PARAMETERS /v1/virtual_accounts/{va_id}/close
OpenAPI snippet URL
POST /v1/virtual_accounts/{va_id}/receiver
Summary: Update a Virtual Account
You can add a receiver to a virtual account using this API.
OpenAPI snippet URL
PARAMETERS /v1/virtual_accounts/{va_id}/receiver
OpenAPI snippet URL
POST /v1/virtual_accounts/{va_id}/allowed_payers
Summary: Add an Allowed Payer Account
You can add an allowed payer to a virtual account using this API.
OpenAPI snippet URL
PARAMETERS /v1/virtual_accounts/{va_id}/allowed_payers
OpenAPI snippet URL
DELETE /v1/virtual_accounts/va_DlGmm7jInLudH9/allowed_payers/ba_DlGmm9mSj8fjRM
Summary: Delete an Allowed Payer Account
You can delete an allowed payer from a virtual account using this API.
OpenAPI snippet URL
POST /v1/virtual_accounts/va_DzcFjMezDcN8vv/receivers
Summary: Add Receiver to an Existing Customer Identifier with VPA
Add Receiver to an Existing Customer Identifier with VPA
OpenAPI snippet URL
POST /v1/virtual_accounts/va_DzaBLzIz494C64/receivers
Summary: Add Receiver to an Existing Customer Identifier with Bank Account
Add Receiver to an Existing Customer Identifier with Bank Account
OpenAPI snippet URL
GET /v1/payments/{pay_id}/upi_transfer
Summary: Method is UPI Transfer
Use this API to retrieve details of a payment using the Payment ID and transfer method.
OpenAPI snippet URL
PARAMETERS /v1/payments/{pay_id}/upi_transfer
OpenAPI snippet URL
GET /v1/payments
Summary: Method is Bank Transfer via UTR
Method is Bank Transfer via UTR
OpenAPI snippet URL
POST /v1/virtual_accounts/va_KFIrkRmd70ylIg
Summary: Update a Virtual Account with VPA
You can use this API to add a receiver to a virtual account.
OpenAPI snippet URL
GET /v1/payments/{pay_id}/transfers
Summary: Fetch Transfers for a Payment
Use this API to fetch the collection of all transfers created on a specific Payment ID.
OpenAPI snippet URL
POST /v1/payments/{pay_id}/transfers
Summary: Transfer via Payments
You can use this API to transfer a captured payment to one or more linked accounts using account_id. A response will be generated on a successful transfer with a collection of transfer entities created for the payment.
OpenAPI snippet URL
PARAMETERS /v1/payments/{pay_id}/transfers
OpenAPI snippet URL
GET /v1/transfers
Summary: Fetch Transfers for a Settlement
Use this API to retrieve the collection of all transfers made for a particular recipient_settlement_id.
OpenAPI snippet URL
POST /v1/transfers
Summary: Direct Transfer
You can transfer funds to your linked accounts directly from your account balance using the Direct Transfers API.
OpenAPI snippet URL
GET /v1/orders/order_DSkl2lBNvueOly/
Summary: Fetch Transfers for an Order
Use this API to fetch the collection of all transfers created on a specific Order ID.
OpenAPI snippet URL
GET /v1/transfers/{trf_id}
Summary: Fetch a Transfer
Use this API to fetch details of a specific transfer.
OpenAPI snippet URL
PATCH /v1/transfers/{trf_id}
Summary: Modify Transfer Settlement Hold
Use this API to modify the settlement configuration for a particular transfer_id. On a successful request, the API responds with the modified transfer entity.
OpenAPI snippet URL
PARAMETERS /v1/transfers/{trf_id}
OpenAPI snippet URL
GET /v1/transfers/{trf_id}/reversals
Summary: Fetch Reversals for a Transfer
Fetch Reversals for a Transfer
OpenAPI snippet URL
POST /v1/transfers/{trf_id}/reversals
Summary: Transfer Reversals
Transfer Reversals
OpenAPI snippet URL
PARAMETERS /v1/transfers/{trf_id}/reversals
OpenAPI snippet URL
POST /v2/accounts
Summary: Create a Linked Account
Create a Linked Account
OpenAPI snippet URL
PATCH /v2/accounts/acc_GP4lfNA0iIMn5B
Summary: Update Linked Accounts
Update Linked Accounts
OpenAPI snippet URL
GET /v2/accounts/acc_GLGeLkU2JUeyDZ
Summary: Fetch a Linked Account
Fetch a Linked Account
OpenAPI snippet URL
POST /v2/accounts/acc_GLGeLkU2JUeyDZ/stakeholders
Summary: Create a Stakeholder
Create a Stakeholder
OpenAPI snippet URL
PATCH /v2/accounts/acc_GLGeLkU2JUeyDZ/stakeholders/sth_GOQ4Eftlz62TSL
Summary: Update a Stakeholder
Update a Stakeholder
OpenAPI snippet URL
POST /v2/accounts/acc_HQVlm3bnPmccC0/products
Summary: Request a Product Configuration
Request a Product Configuration
OpenAPI snippet URL
GET /v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/
Summary: Fetch a Product Configuration
Fetch a Product Configuration
OpenAPI snippet URL
PATCH /v2/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e/
Summary: Update a Product Configuration
Update a Product Configuration
OpenAPI snippet URL
GET /v1/contacts
Summary: Fetch all Contacts
Use this API to fetch all contacts.
OpenAPI snippet URL
POST /v1/contacts
Summary: Create Contact
A contact is an entity to whom payouts can be made through supported modes such as UPI, IMPS, NEFT and RTGS.
Use this API to create a contact.
OpenAPI snippet URL
GET /v1/contacts/{cont_id}
Summary: Fetch Contact by ID
Use this API to fetch the details of a specific contact.
OpenAPI snippet URL
PATCH /v1/contacts/{cont_id}
Summary: Update Contact
Use this API to update a particular contact.
OpenAPI snippet URL
PARAMETERS /v1/contacts/{cont_id}
OpenAPI snippet URL
GET /v1/fund_accounts
Summary: Fetch all Fund Accounts
Fetch all Fund Accounts
OpenAPI snippet URL
POST /v1/fund_accounts
Summary: Create Fund Account - Bank Account
Use this API to create a Fund Account with Bank Account details
OpenAPI snippet URL
GET /v1/fund_accounts/{fa_id}
Summary: Fetch Fund Account by ID
Use this API to fetch a specific fund account.
OpenAPI snippet URL
PARAMETERS /v1/fund_accounts/{fa_id}
OpenAPI snippet URL
PATCH /v1//fund_accounts/{id}
Summary: Activate or Deactivate
Activate or Deactivate
OpenAPI snippet URL
PARAMETERS /v1//fund_accounts/{id}
OpenAPI snippet URL
GET /v1/payouts
Summary: Fetch all Payouts
Use this API to fetch all the payouts created by you.
OpenAPI snippet URL
POST /v1/payouts
Summary: Create Payout-Bank Account
Use this API to create a payout to a bank account.
OpenAPI snippet URL
GET /v1/payouts/{pout_id}
Summary: Fetch Payout by ID
Use this API to fetch a specific payout created by you.
OpenAPI snippet URL
PARAMETERS /v1/payouts/{pout_id}
OpenAPI snippet URL
POST /v1/payouts/{pout_id}/cancel
Summary: Cancel Queued Payouts
Use this API to cancel a specific payout created by you.
Handy Tips:
You can only cancel payouts that are in the queued state. It is not possible to cancel payouts that have any other status.
OpenAPI snippet URL
PARAMETERS /v1/payouts/{pout_id}/cancel
OpenAPI snippet URL
GET /v1/payout-links
Summary: Fetch Payout Links
Use this API to fetch all Payout Links.
OpenAPI snippet URL
POST /v1/payout-links
Summary: Create Payout Link (using customer details)
Use this API to create a Payout Link.
OpenAPI snippet URL
GET /v1/payout-links/{poutlk_id}
Summary: Fetch Payout Link by ID
Use this API to fetch a specific Payout Link.
OpenAPI snippet URL
PARAMETERS /v1/payout-links/{poutlk_id}
OpenAPI snippet URL
POST /v1/payout-links/{poutlk_id}/cancel
Summary: Cancel Payout Link
Use this API to cancel a payout link.
OpenAPI snippet URL
PARAMETERS /v1/payout-links/{poutlk_id}/cancel
OpenAPI snippet URL
GET /v1/transactions
Summary: Fetch all Transactions
Use this API to fetch details of all transactions.
OpenAPI snippet URL
GET /v1/transactions/{txn_id}
Summary: Fetch Transaction by ID
Use this API to fetch details of a specific transaction.
OpenAPI snippet URL
PARAMETERS /v1/transactions/{txn_id}
OpenAPI snippet URL
GET /v1/fund_accounts/validations
Summary: Fetch all Account Validation Transactions
Use this API to fetch all account validation transactions.
OpenAPI snippet URL
POST /v1/fund_accounts/validations
Summary: Validate Fund Account
Use this API to create an account validation transaction.
OpenAPI snippet URL
GET /v1/fund_accounts/validations/{fav_id}
Summary: Fetch Account Validation Transactions by ID
Use this API to fetch details of a specific account validation transaction.
OpenAPI snippet URL
PARAMETERS /v1/fund_accounts/validations/{fav_id}
OpenAPI snippet URL
GET /v2/accounts/{account_id}
Summary: Fetch an Account
Use this API to fetch the details of an account.
Know more about the Fetch an Account API.
OpenAPI snippet URL
DELETE /v2/accounts/{account_id}
Summary: Delete an Account
Use this API to delete an account.
Know more about the Delete an Account API.
OpenAPI snippet URL
PATCH /v2/accounts/{account_id}
Summary: Update an Account
Use this API to update the details of an account.
Know more about the Update an Account API.
OpenAPI snippet URL
PARAMETERS /v2/accounts/{account_id}
OpenAPI snippet URL
GET /v2/accounts/{account_id}/stakeholders
Summary: Fetch all Stakeholders
Use this API to fetch all stakeholders.
Know more about the Fetch all Stakeholders API.
OpenAPI snippet URL
POST /v2/accounts/{account_id}/stakeholders
Summary: Create a Stakeholder
Use this API to create a stakeholder.
Know more about the Create a Stakeholder API.
OpenAPI snippet URL
PARAMETERS /v2/accounts/{account_id}/stakeholders
OpenAPI snippet URL
GET /v2/accounts/{account_id}/stakeholders/{stakeholder_id}
Summary: Fetch a Stakeholder
Use this API to fetch a stakeholder.
Know more about the Fetch a Stakeholder API.
OpenAPI snippet URL
PATCH /v2/accounts/{account_id}/stakeholders/{stakeholder_id}
Summary: Update a Stakeholder
Use this API to update a stakeholder.
Know more about the Update a Stakeholder API.
OpenAPI snippet URL
PARAMETERS /v2/accounts/{account_id}/stakeholders/{stakeholder_id}
OpenAPI snippet URL
POST /v2/accounts/{account_id}/stakeholders/{stakeholder_id}/documents
Summary: Upload Stakeholder Documents
Use the API to upload signatory documents for a stakeholder.
Know more about the Upload Stakeholder Documents API.
OpenAPI snippet URL
PARAMETERS /v2/accounts/{account_id}/stakeholders/{stakeholder_id}/documents
OpenAPI snippet URL
GET /v2/accounts/{account_id}/documents
Summary: Fetch Account Documents
Use the API to fetch business documents for a sub-merchant’s account.
Know more about the Fetch Account Documents API.
OpenAPI snippet URL
POST /v2/accounts/{account_id}/documents
Summary: Upload Account Documents
Use the API to upload business documents for a sub-merchant’s account.
Know more about the Upload Account Documents API.
OpenAPI snippet URL
PARAMETERS /v2/accounts/{account_id}/documents
OpenAPI snippet URL
GET /v2/accounts/{account_id}/stakeholders/{stakeholders_id}/documents
Summary: Fetch Stakeholders Documents
Use the API to fetch the files uploaded for a stakeholder.
Know more about the Fetch Stakeholders Documents API.
OpenAPI snippet URL
PARAMETERS /v2/accounts/{account_id}/stakeholders/{stakeholders_id}/documents
OpenAPI snippet URL
POST /v2/accounts/{account_id}/products
Summary: Request a Product Configuration
Use this API to request a product configuration. You can also use this API to accept terms and conditions for a product.
Know more about the Request a Product Configuration API.
OpenAPI snippet URL
PARAMETERS /v2/accounts/{account_id}/products
OpenAPI snippet URL
GET /v2/accounts/{account_id}/products/{product_id}
Summary: Fetch a Product Configuration
Use this API to retrieve the details of a product for a given sub-merchant’s account.
Know more about the Fetch a Product Configuration API.
OpenAPI snippet URL
PATCH /v2/accounts/{account_id}/products/{product_id}
Summary: Update a Product Configuration
Use this API to update a product configuration. You can also use this API to accept terms and conditions.
Know more about the Update a Product Configuration API.
OpenAPI snippet URL
PARAMETERS /v2/accounts/{account_id}/products/{product_id}
OpenAPI snippet URL
GET /v2/accounts/{account_id}/webhooks
Summary: Fetch all Webhooks
Use this API to fetch all webhooks.
Know more about the Fetch all Webhooks API.
OpenAPI snippet URL
POST /v2/accounts/{account_id}/webhooks
Summary: Create a Webhook
Use this API to create a webhook.
Know more about the Create a Webhook API.
OpenAPI snippet URL
PARAMETERS /v2/accounts/{account_id}/webhooks
OpenAPI snippet URL
GET /v2/accounts/{account_id}/webhooks/{webhook_id}
Summary: Fetch a Webhook
Use this API to fetch a webhook.
Know more about the Fetch a Webhook API.
OpenAPI snippet URL
PARAMETERS /v2/accounts/{account_id}/webhooks/{webhook_id}
OpenAPI snippet URL
DELETE /v2/accounts/{account_id}/webhooks/{webhooks_id}
Summary: Delete a Webhook
Use this API to delete a webhook.
Know more about the Delete a Webhook API.
OpenAPI snippet URL
PATCH /v2/accounts/{account_id}/webhooks/{webhooks_id}
Summary: Update a Webhook
Use this API to update a webhook.
Know more about the Update a Webhook API.
OpenAPI snippet URL
PARAMETERS /v2/accounts/{account_id}/webhooks/{webhooks_id}
OpenAPI snippet URL
POST /v2/accounts/{account_id}/tnc
Summary: [Deprecated] Accept Terms and Conditions
Deprecation Notice
We deprecated this API in February 2022. We do not support this API anymore.
Use the Product Configuration APIs to accept terms and conditions.
OpenAPI snippet URL
PARAMETERS /v2/accounts/{account_id}/tnc
OpenAPI snippet URL
POST /v2/products/{product_name}/tnc
Summary: Fetch Terms and Conditions for a Sub-merchant
Use this API to accept the terms and conditions for a merchant.
Know more about the Fetch Terms and Conditions API.
OpenAPI snippet URL
PARAMETERS /v2/products/{product_name}/tnc
OpenAPI snippet URL
GET /v1/payments/qr_codes
Summary: Fetch All QR Codes
You can fetch all QR Codes using this API.
OpenAPI snippet URL
POST /v1/payments/qr_codes
Summary: Create a QR Code
You can create a QR Code using this API.
OpenAPI snippet URL
POST /v1/payments/qr_codes/{qr_id}/close
Summary: Close a QR Code
You can close a QR Code using this API.
OpenAPI snippet URL
PARAMETERS /v1/payments/qr_codes/{qr_id}/close
OpenAPI snippet URL
GET /v1/payments/qr_codes/{qr_id}
Summary: Fetch a QR Code
You can fetch a specific QR Codes using this API.
OpenAPI snippet URL
PARAMETERS /v1/payments/qr_codes/{qr_id}
OpenAPI snippet URL
GET /v1/payments/qr_codes/{qr_id}/payments
Summary: Fetch Payments for a QR Code
You can fetch payments for a specific QR Code using this API.
OpenAPI snippet URL
PARAMETERS /v1/payments/qr_codes/{qr_id}/payments
OpenAPI snippet URL