# Cashfree Developer Documentation: Payments APIs ## Payments APIs - [Payments APIs / Other Versions (349 pages)](https://www.cashfree.com/docs/_llms/payments-apis/other-versions.txt): v2025-01-01, v2023-08-01, v2022-01-01. ### Payments API - [Overview](https://www.cashfree.com/docs/api-reference/payments/overview.md): Explore Cashfree Payment Gateway APIs for orders, payments, refunds, and more. - [Payment SDK](https://www.cashfree.com/docs/api-reference/payments/sdk.md): Integrate the Cashfree SDKs for server-side languages and mobile platforms to accept payments without writing low-level REST code. - [Rate Limits](https://www.cashfree.com/docs/api-reference/payments/rate-limits.md): Review the per-minute rate limits applied to Cashfree API endpoints and learn how to detect throttling using response headers. - [Enums Reference](https://www.cashfree.com/docs/api-reference/payments/enums.md): Look up enum values in the Cashfree API, covering order states, payment states, net banking codes, wallet codes, and EMI codes. - [Errors](https://www.cashfree.com/docs/api-reference/payments/errors.md): Understand the Cashfree API error structure, common HTTP status codes, and merchant-specific error codes you can handle programmatically. - [Data to Test Integration](https://www.cashfree.com/docs/api-reference/payments/data-to-test-integration.md): Use the test card numbers, UPI IDs, netbanking credentials, and OTPs supplied here to validate your Cashfree integration in the sandbox environment. #### Webhooks - [Webhook Overview](https://www.cashfree.com/docs/api-reference/payments/latest/webhooks/overview.md): Understand Cashfree Payment Gateway webhooks: event references, verification, retries, resends, and version migration for your integration. - [Webhook Configuration](https://www.cashfree.com/docs/api-reference/payments/latest/webhooks/configure.md): Add, test, and edit Payment Gateway webhook endpoints in the Merchant Dashboard, then review delivery logs and analytics for your integration. - [Webhook Signature Verification](https://www.cashfree.com/docs/api-reference/payments/latest/webhooks/signature-verification.md): Verify Cashfree Payment Gateway webhook signatures with HMAC on the raw payload using the SDK or a manual implementation in six languages. - [Webhook Security Checklist](https://www.cashfree.com/docs/api-reference/payments/latest/webhooks/security-checklist.md): Harden Payment Gateway webhook endpoints with HTTPS, IP whitelisting, signature verification, SSL whitelisting, and authentication validation. - [Webhook Idempotency](https://www.cashfree.com/docs/api-reference/payments/latest/webhooks/idempotency.md): Handle duplicate Cashfree Payment Gateway webhook deliveries safely: deduplicate by cf_payment_id and treat only SUCCESS as terminal. - [Webhook Troubleshooting](https://www.cashfree.com/docs/api-reference/payments/latest/webhooks/troubleshooting.md): Diagnose missing triggers, failed endpoint additions, and duplicate deliveries for Cashfree Payment Gateway webhooks using dashboard logs and resends. ### v2026-01-01 - [Overview](https://www.cashfree.com/docs/api-reference/payments/latest/overview.md): Learn details about the 2026-01-01 version of our Payment APIs. - [Preauthorisation](https://www.cashfree.com/docs/api-reference/payments/preauth-journey.md): Run the Cashfree preauthorisation flow in sandbox: create an order, hold funds on cards or UPI, and capture or void the authorised amount. #### Orders - [Create Order](https://www.cashfree.com/docs/api-reference/payments/latest/orders/create-order.md) - [Get Order](https://www.cashfree.com/docs/api-reference/payments/latest/orders/get-order.md): Use this API to fetch the order that was created at Cashfree's using the `order_id`. ## When to use this API - To check the status of your order - [Terminate Order](https://www.cashfree.com/docs/api-reference/payments/latest/orders/terminate-order.md): Use this API to terminate the order that was created at Cashfree's using the `order_id`. - [Get Order Extended](https://www.cashfree.com/docs/api-reference/payments/latest/orders/get-order-extended.md): Use this API to fetch the order related data like address,cart,offers,customer details etc using the Cashfree's `order_id`. ## When to use this API - To get the extended data associated with order. - [Update Order Extended](https://www.cashfree.com/docs/api-reference/payments/latest/orders/update-order-extended.md): Use this api to update the order related data like shipment details,order delivery status etc. ## When to use this API - To provide/update the shipment details or order delivery status. - Once the order is PAID. #### Payments - [Order Pay](https://www.cashfree.com/docs/api-reference/payments/latest/payments/order-pay.md): Use this API when you have already created the order using [Create Order API](https://www.cashfree.com/docs/api-reference/payments/latest/orders/create) and want Cashfree to process the payment. To use this API S2S flag needs to be enabled from the backend. In case you want to use this API for plain… - [Submit or Resend OTP](https://www.cashfree.com/docs/api-reference/payments/latest/payments/submit-or-resend-otp.md): Use this API to submit or resend OTP if you use [Native OTP](https://www.cashfree.com/docs/payments/features/native-otp) for authentication of card payments. Native OTP must be enabled for your account. - [Preauthorisation](https://www.cashfree.com/docs/api-reference/payments/latest/payments/preauthorisation.md): Use this API to capture or void a [pre-authorised](/docs/payments/features/pre-authorisation) payment. - [Get Payments for an Order](https://www.cashfree.com/docs/api-reference/payments/latest/payments/get-payments-for-an-order.md): Use this API to view all payment details for an order. - [Get Payment by ID](https://www.cashfree.com/docs/api-reference/payments/latest/payments/get-payment-by-id.md): Use this API to view payment details of an order for a payment ID. - [Order Pay Authorise Only](https://www.cashfree.com/docs/api-reference/payments/latest/payments/order-pay-authorise-only.md): Use this API when an order has already been created and you want Cashfree to process the payment for authorisation only. To use this API, the 'AUTHORIZE_ONLY' flag must be enabled for your account. Submit [Support Form](https://merchant.cashfree.com/auth/login) to enable this feature. - [Payment Webhooks](https://www.cashfree.com/docs/api-reference/payments/latest/payments/webhooks.md): Subscribe to Cashfree webhooks to receive asynchronous events for payment success, failure, refunds, and dispute updates on each order attempt. #### Payment Links - [Create Payment Link](https://www.cashfree.com/docs/api-reference/payments/latest/payment-links/create-payment-link.md): Use this API to create a new payment link. The created payment link url will be available in the API response parameter link_url. - [Fetch Payment Link Details](https://www.cashfree.com/docs/api-reference/payments/latest/payment-links/fetch-payment-link-details.md): Use this API to view all details and status of a payment link. - [Cancel Payment Link](https://www.cashfree.com/docs/api-reference/payments/latest/payment-links/cancel-payment-link.md): Use this API to cancel a payment link. No further payments can be done against a cancelled link. Only a link in ACTIVE status can be cancelled. - [Get Orders for a Payment Link](https://www.cashfree.com/docs/api-reference/payments/latest/payment-links/get-orders-for-a-payment-link.md): Use this API to view all order details for a payment link. - [Payment Link Webhooks](https://www.cashfree.com/docs/api-reference/payments/latest/payment-links/webhooks.md): Receive Cashfree Payment Link webhook events when customers pay, partially pay, cancel, or expire links, so your backend can update orders automatically. #### Refunds - [Create Refund](https://www.cashfree.com/docs/api-reference/payments/latest/refunds/create-refund.md): Use this API to initiate refunds. You can initiate refunds only within six months of the original successful transaction's date and time. - [Get Refund](https://www.cashfree.com/docs/api-reference/payments/latest/refunds/get-refund.md): Use this API to fetch a specific refund processed on your Cashfree Account. - [Get All Refunds for an Order](https://www.cashfree.com/docs/api-reference/payments/latest/refunds/get-all-refunds-for-an-order.md): Use this API to fetch all refunds processed against an order. - [Update Refund](https://www.cashfree.com/docs/api-reference/payments/latest/refunds/update-refund.md): Use this API to Update refunds. - [Refund Webhooks](https://www.cashfree.com/docs/api-reference/payments/latest/refunds/webhooks.md): Subscribe to Cashfree refund webhook events for successful refunds, cancelled refunds after retries, and automatic auto-refunds triggered for failed orders. #### Customers - [Create Customer at Cashfree](https://www.cashfree.com/docs/api-reference/payments/latest/customers/create-customer-at-cashfree.md): Use this API to register a customer in Cashfree's system before initiating payments, subscriptions, tokenisation, or other customer-linked actions. It creates a reusable *customer profile* and returns a unique identifier for future transactions. #### Easy-Split - [Easy Split Overview](https://www.cashfree.com/docs/api-reference/payments/latest/split/easy-split-overview.md): Use Cashfree Easy Split to share each order amount across multiple vendors and settle their share automatically when the parent transaction is captured. - [Easy Split - Postman Collection](https://www.cashfree.com/docs/api-reference/payments/latest/split/easy-split-postman-collection.md): Download the Easy Split Postman collection to explore Cashfree marketplace endpoints for vendor creation, splits, on-demand transfers, and settlements. - [End Points](https://www.cashfree.com/docs/api-reference/payments/latest/split/end-points.md): Reference base URLs for the Cashfree Easy Split sandbox and production environments along with authentication headers required for every API call. ##### Vendors - [Overview](https://www.cashfree.com/docs/api-reference/payments/latest/split/vendors/overview.md): Use Cashfree's Vendor 2.0 APIs to create vendors, update KYC and bank details, upload documents, and fetch vendor status for Easy-Split payouts. - [Create Vendor](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/create-vendor.md): Use this API to create a new vendor to your EasySplit account along with the KYC details. Provide KYC details such as account_type, business_type, gst, cin, pan, passport number and so on. - [Get Vendor All Details](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/get-vendor-all-details.md): Use this API to get the details of a specific vendor associated with your Easy Split account. - [Update Vendor Details](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/update-vendor-details.md): Use this API to edit the existing vendor details added to your EasySplit account. You can edit vendor details such as name, email, phone number, upi details, and any of the KYC details. - [Get Vendor All Documents Status](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/get-vendor-all-documents-status.md): Use this API to fetch the details of all the KYC details of a particular vendor. - [Upload Vendor Docs](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/upload-vendor-docs.md): Use this API to upload KYC documents of a specific vendor. - [Download Vendor Documents](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/download-vendor-documents.md): Use this API to download the uploaded KYC documents of that particular vendor. Provide the document type. Click the link from the sample request to download the KYC document. - [Get On Demand Balance](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/get-on-demand-balance.md): This API fetches the available amount with the merchant, vendor, and the unsettled amount for the merchant as well as the vendor. ##### Configuration - [Create Static Split Configuration](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/create-static-split-configuration.md): This API will create a static split scheme wherein you can define the split type and the vendor-wise split percentage. - [Split After Payment](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/split-after-payment.md): The Split After Payment API splits payments to vendors after customers successfully complete a payment. After you receive a successful payment confirmation, wait 2 minutes before you call this API endpoint. - [Create Adjustment](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/create-adjustment.md): The Create Adjustment API will create a adjustment request either from vendor to the merchant or from merchant to the vendor. ##### Settlements - [Create On Demand Transfer](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/create-on-demand-transfer.md): The Create On Demand Transfer API will create a new on-demand request either from to the merchant or from to the vendor. - [Get Split and Settlement Details by OrderID](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/get-split-and-settlement-details-by-orderid.md): Use this API to get all the split details, settled and unsettled transactions details of each vendor who were part of a particular order by providing order Id or start date and end date. - [Get Split and Settlement Details by OrderID v2.0](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/get-split-and-settlement-details-by-orderid-v20.md): Use this API to get all the split details, settled and unsettled transactions details of each vendor who were part of a particular order by providing order Id or start date and end date. ##### Billing - [Get Vendor Balance Transfer Charges](https://www.cashfree.com/docs/api-reference/payments/latest/easy-split/get-vendor-balance-transfer-charges.md): This API returns the applicable service charge and service tax for a vendor balance transfer, based on the provided amount and rate type. ##### Webhooks - [Overview](https://www.cashfree.com/docs/api-reference/payments/latest/split/webhooks/overview.md): Subscribe to Cashfree Easy Split webhooks to receive event-based notifications about vendor settlements, vendor status changes, and split payment activity. - [Vendor Settlement Webhook](https://www.cashfree.com/docs/api-reference/payments/latest/split/webhooks/vendor-settlement-webhooks.md): Receive Cashfree vendor settlement webhooks when vendor payouts are initiated, successfully processed, failed, or reversed, so you can keep ledgers in sync. - [Vendor Status Change Webhook](https://www.cashfree.com/docs/api-reference/payments/latest/split/webhooks/vendor-status-change-webhooks.md): Set up Cashfree vendor status change webhooks to receive automated notifications whenever a vendor in your Easy Split program is activated, blocked, or updated. ##### Reconciliation - [Vendor Reconciliation API](https://www.cashfree.com/docs/api-reference/payments/latest/reconciliation/vendor-reconciliation-api.md): This API allows you to fetch vendor reconciliation details by using different filters. Use the appropriate filters based on your requirements. After you receive a VENDOR_SETTLEMENT_SUCCESS webhook confirmation, wait 15 minutes before you call this API endpoint. - **View Split Order Details Using Se… #### Payment Methods - [Get Eligible Cardless EMI Payment Methods for a customer on an order](https://www.cashfree.com/docs/api-reference/payments/latest/eligibility/get-eligible-cardless-emi-payment-methods-for-a-customer-on-an-order.md): Use this API to get eligible Cardless EMI Payment Methods available for a customer on an order basis their phone number. - [Get Eligible Paylater for a customer on an order](https://www.cashfree.com/docs/api-reference/payments/latest/eligibility/get-eligible-paylater-for-a-customer-on-an-order.md): Use this API to get eligible Paylater Payment Methods for a customer on an order. - [Get Eligible Payment Methods for Orders](https://www.cashfree.com/docs/api-reference/payments/latest/eligibility/get-eligible-payment-methods.md): Fetch the payment instruments a Cashfree order is eligible to use, including UPI, cards, netbanking, wallets, and EMI rails for personalised checkouts. #### Offers - [Create Offer](https://www.cashfree.com/docs/api-reference/payments/latest/offers/create-offer.md): Use this API to create offers with Cashfree from your backend. - [Get Offer by ID](https://www.cashfree.com/docs/api-reference/payments/latest/offers/get-offer-by-id.md): Use this API to get offer by offer_id. - [Get Eligible Offers for an Order](https://www.cashfree.com/docs/api-reference/payments/latest/eligibility/get-eligible-offers-for-an-order.md): Use this API to get eligible offers for an order_id or order amount. #### Token Vault - [Fetch Cryptogram for a Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/latest/token-vault/fetch-cryptogram-for-a-saved-card-instrument.md): Use this API to retrieve the token and cryptogram for a specific saved card stored in Cashfree's [Token Vault](https://www.cashfree.com/docs/payments/features/token-vault). - [Fetch All Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/latest/token-vault/fetch-all-saved-card-instrument.md): Use this API to fetch all saved cards stored for the customer in Cashfree’s [Token Vault](https://www.cashfree.com/docs/payments/features/token-vault). - [Fetch Specific Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/latest/token-vault/fetch-specific-saved-card-instrument.md): Use this API to fetch a specific saved card stored for the customer in Cashfree’s [Token Vault](https://www.cashfree.com/docs/payments/features/token-vault). - [Delete Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/latest/token-vault/delete-saved-card-instrument.md): Use this API to delete a specific saved card stored for the customer in Cashfree’s [Token Vault](https://www.cashfree.com/docs/payments/features/token-vault). - [Card Token Webhook](https://www.cashfree.com/docs/api-reference/payments/latest/token-vault/webhooks.md): Receive Cashfree Token Vault webhooks for asynchronous updates on saved card instruments including tokenisation success, failure, and expiry events. #### Disputes - [Get Disputes by Order ID](https://www.cashfree.com/docs/api-reference/payments/latest/disputes/get-disputes-by-order-id.md): Use this API to get all Dispute details by specifying the Order ID. - [Get Disputes by Payment ID](https://www.cashfree.com/docs/api-reference/payments/latest/disputes/get-disputes-by-payment-id.md): Use this API to get all Dispute details by specifying the Payment ID. - [Get Disputes by Dispute ID](https://www.cashfree.com/docs/api-reference/payments/latest/disputes/get-disputes-by-dispute-id.md): Use this API to get Dispute details by specifying the Dispute ID. - [Accept Dispute by Dispute ID](https://www.cashfree.com/docs/api-reference/payments/latest/disputes/accept-dispute-by-dispute-id.md): Use this API to get accept the Dispute by specifying the Dispute ID. - [Submit Evidence to contest the Dispute by Dispute ID](https://www.cashfree.com/docs/api-reference/payments/latest/disputes/submit-evidence-to-contest-the-dispute-by-dispute-id.md): Use this API to submit evidence to contest a dispute by specifying the dispute ID. This API does not apply to ARBITRATION disputes. Use the [Contest Arbitration API](/docs/api-reference/payments/latest/disputes/contest-arbitration-by-dispute-id) instead. - [Contest Arbitration by Dispute ID](https://www.cashfree.com/docs/api-reference/payments/latest/disputes/contest-arbitration-by-dispute-id.md): Use this API to contest an ARBITRATION dispute without uploading documents. - [Dispute Webhooks](https://www.cashfree.com/docs/api-reference/payments/latest/disputes/dispute-webhooks.md): Configure Cashfree dispute webhooks to receive automated notifications when disputes are created, updated, contested, or closed against your transactions. #### Settlements - [Get Settlements by Order ID](https://www.cashfree.com/docs/api-reference/payments/latest/settlements/get-settlements-by-order-id.md): Use this API to view the latest linked settlement details for a particular order, including pending and failed settlements. - [Mark Order For Settlement](https://www.cashfree.com/docs/api-reference/payments/latest/settlements/mark-order-for-settlement.md): Use this API to pass the CBRIKS ID to Cashfree and mark an order for settlement. - [PG Reconciliation](https://www.cashfree.com/docs/api-reference/payments/latest/pg-reconciliation/pg-reconciliation.md): - Use this API to get the payment gateway reconciliation details with date range. - It will have events for your payment account - [Settlement Reconciliation](https://www.cashfree.com/docs/api-reference/payments/latest/settlement-reconciliation/settlement-reconciliation.md): - Use this API to get settlement reconciliation details using Settlement ID, settlement UTR or date range. - This API will return events for the settlement IDs you want - [Get All Settlements](https://www.cashfree.com/docs/api-reference/payments/latest/settlement-reconciliation/get-all-settlements.md): Use this API to get all settlement details by specifying the settlement ID, settlement UTR, settlement status or date range. Returns settlements of all statuses including SUCCESS, PENDING, PENDING_WITH_CASHFREE, PENDING_WITH_BANK and FAILED. - [Settlement Webhooks](https://www.cashfree.com/docs/api-reference/payments/latest/settlements/settlement-webhooks.md): Get notified about Cashfree merchant and vendor settlements via webhooks that fire when payouts to bank accounts are initiated, succeeded, or failed. #### Offline Payments - [Create Terminal](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/create-terminal.md): Use this API to create new terminals to use softPOS. - [Fetch Terminal QR Codes](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/fetch-terminal-qr-codes.md): You can fetch all the StaticQRs corresponding to given terminal id or phone number. Provide either the terminal_phone_no or terminal_id in the request. - [Create Terminal Transaction](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/create-terminal-transaction.md): Use this API to create a new terminal transaction. To use this API you should first create an order using the Create Order API. Also, you need to enter the terminal details while creating the order and pass the same terminal information while creating a transaction using the below mentioned API. - [Onboard Soundbox VPA](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/onboard-soundbox-vpa.md): Use this API to onboard a terminal Vpa to soundbox. - [Update Soundbox VPA](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/update-soundbox-vpa.md): Use this API to update a terminal Vpa to soundbox. - [Demap Soundbox VPA](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/demap-soundbox-vpa.md): Use this API to demap a device from soundbox. - [Fetch Terminal Soundbox VPA](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/fetch-terminal-soundbox-vpa.md): You can fetch all the active and mapped SoundboxVpa corresponding to given terminal id or deviceSerialNo. Provide either the device_serial_no or cf_terminal_id in the request. - [Get Terminal Transaction](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/get-terminal-transaction.md): Use this API to get terminal transaction. - [Get list of terminal transactions](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/get-list-of-terminal-transactions.md): Use this API to fetch a paginated list of terminal payment transactions. You can filter results by date range, terminal details, payment status, and other criteria. - [Update Terminal](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/update-terminal.md): Use this API to update the terminal details. Email, Phone Number, and Terminal Meta are updatable for "Storefront". Only account status change is possible in case of "Agent". - [Update Terminal Status](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/update-terminal-status.md): Use this API to update the terminal status. - [Get Terminal Status using Phone Number](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/get-terminal-status-using-phone-number.md): Use this API to view all details of a terminal. - [Upload Terminal Docs](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/upload-terminal-docs.md): Use this API to upload the terminal documents. - [Offline Payments Webhooks](https://www.cashfree.com/docs/api-reference/payments/latest/offline-payments/softpos-webhooks.md): Receive Cashfree Offline Payments webhooks for in-person card and UPI transactions so your servers learn about completions, failures, and refunds. #### Simulation - [Simulate Payment](https://www.cashfree.com/docs/api-reference/payments/latest/simulation/simulate-payment.md): Use this API to simulate payment. To use this API you should first create an order using the Create Order API. Also, you need to create a payment with the same order. - [Fetch Simulation](https://www.cashfree.com/docs/api-reference/payments/latest/simulation/fetch-simulation.md): Use this API to fetch simulated payment details. - [Simulate Settlement Payment](https://www.cashfree.com/docs/api-reference/payments/latest/simulation/simulate-settlement-payment.md): Use this API to simulate a settlement in the sandbox environment. First, create a successful order, and then call this API with the order ID to simulate the settlement for that order. - [Fetch Settlement Simulation](https://www.cashfree.com/docs/api-reference/payments/latest/simulation/fetch-settlement-simulation.md): Use this API to fetch the details of a simulated settlement. - [Simulate Vendor Settlement](https://www.cashfree.com/docs/api-reference/payments/latest/simulation/simulate-vendor-settlement.md): Simulate an Easy Split vendor settlement in sandbox to move it to INITIATED, SUCCESS or FAILED and trigger vendor settlement webhooks. - [Enable Easy Split](https://www.cashfree.com/docs/api-reference/payments/latest/simulation/enable-easy-split-sandbox.md): Enable Easy Split on your sandbox merchant ID without raising a request, and provision sample bank and UPI vendors for testing. - [Fetch Easy Split Status](https://www.cashfree.com/docs/api-reference/payments/latest/simulation/fetch-easy-split-sandbox-status.md): Retrieve the Easy Split configuration for your sandbox merchant ID and confirm onboarding is complete before you start testing splits. #### Subscription - [Overview](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/overview.md): Use the Cashfree Subscriptions APIs to manage recurring payments, mandate authorisation, charge schedules, and payment instruments at scale across India. - [Postman Collection](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/subscription-postman-collection.md): Download the Cashfree Subscriptions Postman collection to test mandate creation, charge, refund, and plan APIs against the sandbox before going live. - [Error Codes and Reasons](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/error-codes.md): Reference the most common Cashfree Subscriptions API error codes, their failure reasons, and recommended resolutions to debug mandate and charge issues quickly. - [End Points](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/endpoints.md): Reference base URLs and authentication headers required to call the Cashfree Subscriptions APIs across the sandbox and production environments. - [Physical Mandates](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/physical-mandates.md): Use Cashfree Subscriptions Physical Mandate APIs to authorise customers with only signature and bank details, without a debit card or netbanking. - [Redirection Payload After Authorisation](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/redirection-payload-after-authorization.md): Understand the POST parameters Cashfree sends to your subscription return URL after the customer authorises a mandate, covering status confirmation and flow finalisation. - [Rate Limits](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/rate-limits.md): Reference the per-minute rate limits applied to the Cashfree Subscriptions APIs and learn how to handle throttling for create, charge, and management endpoints. ##### Plan - [Create a Plan](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/create-a-plan.md): A plan allows your customer to identify the features you offer along with your pricing. You can create plans as per the pricing you support for your services. For each plan, you can set a pre-decided frequency and amount with which they’ll be charged. Example: Netflix Plans : Premium, Basic, Standar… - [Fetch Plan](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/fetch-plan.md): Use this API to fetch plan details. ##### Mandate - [Create Subscription](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/create-subscription.md): Use this API to create a new subscription. - [Fetch Subscription](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/fetch-subscription.md): Use this API to fetch subscription details. - [Manage Subscription](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/manage-subscription.md): Use this API to manage subscriptions. You can cancel, pause, activate, or change the plan associated with a subscription. To update the recurring amount for a periodic subscription: 1. Create a new plan with the revised amount. 2. Use the Manage Subscription API to associate the subscription with th… - [Upload file for Physical Nach Authorisation](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/upload-file-for-physical-nach-authorisation.md): Use this API to upload file for Physical Nach Authorization. - [Get All the Payment Method Details Available for Subscription Payments](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/get-all-the-payment-method-details-available-for-subscription-payments.md): Use this API to check if a payment method is enabled for your account. - [Generate Transaction Return Summary](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/generate-transaction-return-summary.md): Use this API to generate transaction return summary for failed transactions (insufficient balance). ##### Payment - [Raise a Charge or Create an Auth](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/raise-a-charge-or-create-an-auth.md): Use this API to create an auth or to raise a charge. - [Fetch Details of All Payments of a Subscription](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/fetch-details-of-all-payments-of-a-subscription.md): Use this API to fetch all payments of a subscription. - [Fetch Details of a Single Payment](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/fetch-details-of-a-single-payment.md): Use this API to fetch details of a single payment of a subscription. - [Manage a Single Payment](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/manage-a-single-payment.md): Use this API to manage a payment of a subscription. A payment can be cancelled or retried with this API. ###### Controlled Charging - [Controlled Subscription Payments](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/payment/controlled/overview.md): Drive pre-debit notification and charge execution yourself with the controlled subscription payment APIs for UPI Autopay and card mandates. - [Create Controlled Notification](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/payment/controlled/create-controlled-notification.md): Use this API to initiate a controlled payment notification (PDN) for an on-demand subscription mandate. - [Fetch Controlled Notification](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/payment/controlled/fetch-controlled-notification.md): Use this API to fetch the details of a controlled payment notification for a subscription mandate. - [Fetch All Controlled Notifications](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/payment/controlled/fetch-controlled-notifications.md): Use this API to fetch all controlled payment notifications for a subscription payment. - [Create Controlled Execution](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/payment/controlled/create-controlled-execution.md): Use this API to create a controlled charge execution for an on-demand subscription mandate after a successful notification. - [Fetch Controlled Execution](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/payment/controlled/fetch-controlled-execution.md): Use this API to fetch the details of a controlled execution for a subscription mandate. - [Fetch All Controlled Executions](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/payment/controlled/fetch-controlled-executions.md): Use this API to fetch all controlled payment executions for a subscription payment. ##### Refund - [Refund APIs Overview](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/refund/refund-apis-overview.md): Browse the Cashfree Subscriptions refund APIs that let you create refunds against subscription charges and fetch the latest refund status from your backend. - [Create a Refund](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/create-a-refund.md): This API allows you to create refund on a successful payment. Refund amount can be partial or the full amount of the payment. - [Fetch Details of a Refund](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/fetch-details-of-a-refund.md): Use this API to fetch details of a refund of a subscription payment. ##### Webhooks - [Events](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/webhooks.md): Subscribe to Cashfree Subscriptions webhooks for mandate authorisation, recurring charges, payment status changes, and subscription lifecycle updates. - [Signature Verification](https://www.cashfree.com/docs/api-reference/payments/latest/subscription/webhook-signature.md): Verify Cashfree Subscriptions webhook signatures to confirm authenticity, prevent spoofing, and validate payload integrity before processing recurring events. #### VBA ##### Manage VBA - [Create VBA](https://www.cashfree.com/docs/api-reference/payments/latest/pgvba/create-vba.md): Use this API to create a virtual bank account. It allows you to receive payments just like a regular bank account. - [Edit VBA](https://www.cashfree.com/docs/api-reference/payments/latest/pgvba/edit-vba.md): Use this API to edit the details of the created virtual bank account. - [Manage VBA](https://www.cashfree.com/docs/api-reference/payments/latest/pgvba/manage-vba.md): Use this API to manage the status of the created virtual bank account. - [Get VBA](https://www.cashfree.com/docs/api-reference/payments/latest/pgvba/get-vba.md): Use this API to get the details of the created virtual bank account by entering the virtual account ID. ##### Payments - [Get VBA Payments](https://www.cashfree.com/docs/api-reference/payments/latest/pgvba/get-vba-payments.md): Use this API to get all the payment details regarding a virtual bank account. - [Get VBA Payments By UTR](https://www.cashfree.com/docs/api-reference/payments/latest/pgvba/get-vba-payments-by-utr.md): Use this API to get the payment details by entering the unique transaction reference (UTR). ##### Notification Group - [Create VBA Notification Group](https://www.cashfree.com/docs/api-reference/payments/latest/pgvba/create-vba-notification-group.md): Use this API to create a notification group. The recipients in the group will receive notifications regarding the payment details. - [Edit VBA Notification Group](https://www.cashfree.com/docs/api-reference/payments/latest/pgvba/edit-vba-notification-group.md): Use this API to edit the details of the created notification group. - [Manage VBA Notification Group Status](https://www.cashfree.com/docs/api-reference/payments/latest/pgvba/manage-vba-notification-group-status.md): Use this API to modify the status of the created notification group. - [Get VBA Notification Group](https://www.cashfree.com/docs/api-reference/payments/latest/pgvba/get-vba-notification-group.md): Use this API to get the details of the created notification group. #### International Payments - [Overview](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/overview.md): Explore the Cashfree International Payments APIs that help businesses accept and disburse cross-border transactions in multiple currencies and regions. ##### Collect from India - [Overview](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/collect-from-india/overview.md): Cashfree Collect from India helps overseas merchants, payment aggregators, and marketplaces accept payments from Indian customers in INR with full compliance. - [Upload Payment Verification Details](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/collect-from-india/upload-payment-verification-details.md): This API is used to upload the required payment verification details. - [Get Payment Verification Details](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/collect-from-india/get-payment-verification-details.md): This API is used to get the verification status of the payment. - [Get Import Settlement Details for an Order](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/collect-from-india/get-import-settlement-details.md): This API is used to get ICA settlement details using PG Order ID. - [Get Import Settlement Recon Details](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/collect-from-india/get-import-settlement-recon-details.md): This API is used to fetch all events for the provided Settlement IDs. - [Webhooks](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/collect-from-india/import-webhooks.md): Set up Cashfree Collect from India import webhooks to receive event-based notifications about incoming international payments and reconciliation status. ###### Sandbox Simulation - [Overview](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/collect-from-india/sandbox-simulation.md): Learn how to simulate transaction verification and settlement processes in the sandbox environment for payments from India-based customers to overseas merchants - [Trigger Sandbox Settlement](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/collect-from-india/trigger-sandbox-settlement.md): This API is used to trigger settlement in sandbox environment. - [Mark Sandbox Settlement Processed](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/collect-from-india/mark-sandbox-settlement-processed.md): This API is used to mark settlement as processed in sandbox environment. ##### Collect from the World ###### Global Collections - [Overview](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/global-collections/overview.md): Use Cashfree Global Collections to accept cross-border collections in multiple currencies through virtual accounts that settle to your home bank account. - [End Points](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/global-collections/endpoints.md): Reference base URLs and endpoints for the Cashfree Global Collections APIs across the sandbox testing environment and the production processing environment. - [Purpose Codes](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/global-collections/purpose-codes.md): Reference FEMA-compliant purpose codes used with Cashfree Global Collections to declare the nature of inward remittances from overseas customers. - [Get Collection Accounts](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/global-collections/partner/get-collection-accounts.md): This API fetches all the virtual accounts that is linked with the given merchant ID. - [Get Transactions](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/global-collections/partner/get-transactions.md): Use this API to get all the transaction details within a time interval. - [Add Transaction Details](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/global-collections/partner/add-transaction-details.md): Use this API to input invoice details for a specific transaction. You have the flexibility to upload multiple invoices until the cumulative total of all invoice amounts matches the transaction amount. - [Simulate Transaction](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/global-collections/partner/simulate-transaction.md): Use this API to simulate a funding in test environment. - [Webhook - Partner](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/global-collections/partner/webhooks.md): Configure Global Collections partner webhooks in the Cashfree partner dashboard to receive transaction, settlement, and virtual account notifications. ###### Authorization - [Overview](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/global-collections/partner/auth-overview.md): Authenticate Global Collections partner API calls by generating bearer tokens, verifying token validity, and refreshing credentials before each request. - [Get Auth Token](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/global-collections/partner/auth-get-token.md): Use this API to authenticate with the Cashfree system and obtain the authorization bearer token. - [Verify Auth Token](https://www.cashfree.com/docs/api-reference/payments/latest/international-payments/global-collections/partner/auth-verify-token.md): Verify the authentication token generated by the user. #### Utilities - [Get PAR](https://www.cashfree.com/docs/api-reference/payments/latest/utilities/get-par.md): Use this API to get [Payment Account Reference (PAR)](https://www.cashfree.com/docs/payments/features/payment-account-reference) by providing plain card details. - [Get Card BIN Details](https://www.cashfree.com/docs/api-reference/payments/latest/utilities/get-card-bin-details.md): Use this API to get [Card BIN](https://www.cashfree.com/docs/payments/features/utility-apis) (Bank Identification Number) details. ##### Downtimes - [Fetch All Downtimes](https://www.cashfree.com/docs/api-reference/payments/latest/downtime/fetch-all-downtimes.md): Fetches active downtimes across various payment methods based on filters. Gives all active downtimes when no filters are applied. - [Fetch Downtime by ID](https://www.cashfree.com/docs/api-reference/payments/latest/intellisense/fetch-downtime-by-id.md): Fetches details of a specific downtime using its unique ID. - [Incident Service Webhook](https://www.cashfree.com/docs/api-reference/payments/latest/utilities/incidents/incident-webhook.md): Subscribe to Cashfree Incident Service webhooks so your checkout learns when payment rails go down, recover, or change scope across banks and networks. ## OpenAPI Specs - [v2026-01-01](/docs/openapi/payments/v2026-01-01.yaml) - [pgvba](/docs/openapi/pgvba/pgvba.yaml) - [v2025-01-01](/docs/openapi/cb-imports/v2025-01-01.yaml) - [v2026-01-01](/docs/openapi/cb-imports/v2026-01-01.yaml) - [v2025-01-01](/docs/openapi/payments/v2025-01-01.yaml) - [merchant-spec](/docs/openapi/cb-imports/merchant-spec.json) - [v2023-08-01](/docs/openapi/payments/v2023-08-01.yaml) - [v2022-09-01](/docs/openapi/payments/v2022-09-01.yaml)