# Cashfree Developer Documentation: Payments APIs Other Versions ## Other Versions ### v2025-01-01 - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/overview.md): Learn details about the 2025-01-01 version of our Payment APIs. #### Orders - [Create Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/orders/create.md) - [Get Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/orders/get.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/previous/v2025-01-01/orders/terminate.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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/payments/pay.md): Initiate a payment for an order using the Order Pay API with support for multiple payment methods and NPCI-compliant device headers. - [Submit or Resend OTP](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/payments/authenticate.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. - [Preauthorisation](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/payments/authorize.md): Use this API to capture or void a [pre-authorised](/docs/payments/features/pre-authorisation) payment. - [Get Payment by ID](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/payments/get.md): Use this API to view payment details of an order for a payment ID. - [Get Payments for an Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/payments/get-payments-for-order.md): Use this API to view all payment details for an order. - [Payment Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/payments/webhooks.md): Read about all asynchronous events initiated by Cashfree for this entity #### Payment Links - [Create Payment Link](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/payment-links/create.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/previous/v2025-01-01/payment-links/get.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/previous/v2025-01-01/payment-links/cancel.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/previous/v2025-01-01/payment-links/get-orders-for-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/previous/v2025-01-01/payment-links/webhooks.md): Learn about webhooks triggered when payments made through Payment Links. #### Refunds - [Create Refund](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/refunds/create.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/previous/v2025-01-01/refunds/get.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/previous/v2025-01-01/refunds/get-refunds-for-order.md): Use this API to fetch all refunds processed against an order. - [Update Refund](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/refunds/update-refund.md): Use this API to Update refunds. - [Refund Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/refunds/webhooks.md): Learn about the async events sent for refunds #### Customers - [Create Customer at Cashfree](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/customers/create.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/previous/v2025-01-01/split/easy-split-overview.md) - [Easy Split - Postman Collection](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/split/easy-split-postman-collection.md) - [End Points](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/split/end-points.md) ##### Vendors - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/overview.md): Browse every Cashfree Easy Split vendor API, including endpoints to onboard a vendor, upload KYC documents, fetch balances, and update vendor details. - [Create vendor](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/split/vendors/create.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/previous/v2025-01-01/split/vendors/get.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/previous/v2025-01-01/split/vendors/update.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. - [Upload Vendor Docs](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/split/vendors/add-document.md): Use this API to upload KYC documents of a specific vendor. - [Get Vendor All Documents Status](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/split/vendors/get-document.md): Use this API to fetch the details of all the KYC details of a particular vendor. - [Download Vendor Documents](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/split/vendors/download-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/previous/v2025-01-01/split/vendors/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/previous/v2025-01-01/split/configuration/static-split.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/previous/v2025-01-01/split/configuration/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. ##### Settlements - [Create On Demand Transfer](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/split/settlements/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 v2.0](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/split/settlements/split-details.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/previous/v2025-01-01/split/billing/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/previous/v2025-01-01/split/webhooks/overview.md): This section consists of the Easy Split Webhooks. - [Vendor Settlement Webhook](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/split/webhooks/vendor-settlement-webhooks.md): This chapter explains the vendor settlement webhooks. - [Vendor Status Change Webhook](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/split/webhooks/vendor-status-change-webhooks.md): This chapter explains the vendor status change webhook. ##### Reconciliation - [Vendor Reconciliation API](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/reconciliation/vendor-recon.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/previous/v2025-01-01/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 Offers for an Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/eligibility/get-eligible-offers-for-an-order.md): Use this API to get eligible offers for an order_id or order amount. - [Get Eligible Paylater for a customer on an order](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/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](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/eligibility/get-eligible-payment-methods.md): Use this API to get eligible Payment Methods. #### Offers - [Create Offer](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/offers/create.md): Use this API to create offers with Cashfree from your backend. - [Get Offer by ID](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/offers/get.md): Use this API to get offer by offer_id. #### Token Vault - [Get Cryptogram for a Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/token-vault/generate-cryptogram.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). - [Get All Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/token-vault/get-all.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). - [Get Specific Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/token-vault/get.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/previous/v2025-01-01/token-vault/delete.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/previous/v2025-01-01/token-vault/webhooks.md): Receive asynchronous notification for updates on a card instrument, which is requested to be tokenised. #### Disputes - [Get Disputes by Order ID](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/disputes/contest-arbitration-by-dispute-id) instead. - [Contest Arbitration by Dispute ID](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/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/previous/v2025-01-01/disputes/dispute-webhooks.md): Learn in detail about dispute webhooks. #### Settlements - [Get All Settlements](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/settlements/get-settlements.md): Use this API to get all settlement details by specifying the settlement ID, settlement UTR or date range. - [Get Settlements by Order ID](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/settlements/get-settlements-for-order.md): Use this API to view all the settlements of a particular order. - [Mark Order For Settlement](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/settlements/mark-order-for-settlement.md): Use this API to pass the CBRICS ID to Cashfree and mark an order for settlement. - [PG Reconciliation](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/settlements/reconcile.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/previous/v2025-01-01/settlements/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 - [Settlement Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/settlements/settlement-webhooks.md): Learn more about webhooks triggered when a payout to merchant or vendor account happens #### Offline Payments - [Create Terminal](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/softpos/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/previous/v2025-01-01/softpos/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/previous/v2025-01-01/softpos/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/previous/v2025-01-01/softpos/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/previous/v2025-01-01/softpos/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/previous/v2025-01-01/softpos/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/previous/v2025-01-01/softpos/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/previous/v2025-01-01/softpos/get-terminal-transaction.md): Use this API to get terminal transaction. - [Get Terminal Payments](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/softpos/get-terminal-payments.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/previous/v2025-01-01/softpos/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/previous/v2025-01-01/softpos/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/previous/v2025-01-01/softpos/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/previous/v2025-01-01/softpos/upload-terminal-docs.md): Use this API to upload the terminal documents. - [SoftPOS Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/softpos/softpos-webhooks.md): Learn in detail about softPOS webhooks. #### Simulation - [Simulate Payment](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/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/previous/v2025-01-01/simulation/fetch-simulation.md): Use this API to fetch simulated payment details. - [Simulate Settlement Payment](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/simulation/simulate-settlement.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/previous/v2025-01-01/simulation/fetch-settlement-simulation.md): Use this API to fetch the details of a simulated settlement. #### Subscription - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/overview.md): Learn details about subscription APIs to manage recurring payments, mandates, and payment schedules. - [Postman Collection](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/subscription-postman-collection.md): Download Cashfree's subscription APIs Postman collection to get started with testing and integration. - [Error Codes and Reasons](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/error-codes.md): Learn more about subscription error codes, failure reasons, and their resolutions - [End Points](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/endpoints.md) - [Physical Mandates](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/physical-mandates.md): In this chapter, you will learn in detail about the APIs related to Physical Mandates. - [Redirection Payload After Authorisation](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/redirection-payload-after-authorization.md): When a subscription is created, a return URL is provided as part of the request. When the customer authorises the payment, they are redirected to this URL via a POST request containing the parameters listed below. - [Rate Limits](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/rate-limits.md): This chapter explains the default rate limit applied by the Subscriptions APIs per minute. - [Subscription Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/webhooks.md): Learn about the various Subscription webhooks sent by Cashfree ##### Plan - [Create a Plan](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/plans/create.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/previous/v2025-01-01/subscription/plans/fetch.md): Use this API to fetch plan details. ##### Mandate - [Create Subscription](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/mandate/create.md): Use this API to create a new subscription. - [Fetch Subscription](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/mandate/fetch.md): Use this API to fetch subscription details. - [Manage Subscription](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/mandate/manage.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/previous/v2025-01-01/subscription/mandate/physical-nach-mandate.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/previous/v2025-01-01/subscription/mandate/payment-methods.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/previous/v2025-01-01/subscription/mandate/generate-transaction-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/previous/v2025-01-01/subscription/payment/raise.md): Use this API to create an auth or to raise a charge. - [Fetch Details of a Single Payment](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/payment/fetch.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/previous/v2025-01-01/subscription/payment/manage.md): Use this API to manage a payment of a subscription. A payment can be cancelled or retried with this API. - [Fetch Details of All Payments of a Subscription](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/payment/fetch-payments-for-mandate.md): Use this API to fetch all payments of a subscription. ###### Controlled Charging - [Controlled Subscription Payments](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/payment/controlled/overview.md): Drive pre-debit notification and charge execution yourself with the controlled subscription payment APIs for UPI Autopay mandates. - [Create Controlled Notification](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/subscription/refund/refund-apis-overview.md): In this section, you will learn about all the APIs related to subscription refunds. - [Create a Refund](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/subscription/refund/create.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/previous/v2025-01-01/subscription/refund/fetch.md): Use this API to fetch details of a refund of a subscription payment. #### VBA ##### Manage VBA - [Create VBA](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/international-payments/overview.md): Learn about Cashfree APIs suitable for International Payments ##### Collect from India - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/overview.md): This product helps Merchants/Payment Aggregators/Market Places who are based outside India to collect payments from customers based out of India - [Upload Payment Verification Details](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/upload-payment-verification-details.md): This API is used to upload all the required payment details for the verification - [Get Payment Verification Details](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/get-payment-verification-details.md): Use this API to get the status of the payment verification. - [Get Import Settlement Details for an Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/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/previous/v2025-01-01/international-payments/collect-from-india/get-import-settlement-recon-details.md): This API is used to fetch all events happened for provided Settlement IDs. - [Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/import-webhooks.md): This product helps Merchants/Payment Aggregators/Market Places who are based outside India to collect payments from customers based out of India ###### Sandbox Simulation - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/international-payments/global-collections/overview.md) - [End Points](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/endpoints.md): This document provides you with the Global Collection end points. - [Purpose Codes](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/purpose-codes.md): This page contains the purpose codes for Global Collect - [Get Collection Accounts](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/international-payments/global-collections/partner/webhooks.md): This chapter explains the Global Collections Webhooks. ###### Authorization - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/partner/auth-overview.md): Global Collection APIs - [Get Auth Token](https://www.cashfree.com/docs/api-reference/payments/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/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/previous/v2025-01-01/utilities/get-card-bin.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/previous/v2025-01-01/utilities/incidents/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/previous/v2025-01-01/utilities/incidents/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/previous/v2025-01-01/utilities/incidents/incident-webhook.md) ### v2023-08-01 - [End Points](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/overview.md): Review the production and sandbox base URLs and the authentication headers you need to call the 2023-08-01 Cashfree API endpoints. - [Release Notes for v2023-08-01](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/release-notes.md): Explore key changes in the Cashfree API version 2023-08-01 release, covering breaking updates, new headers, and entity changes. #### Orders - [Create Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/orders/create.md): ### Order An order is an entity which has a amount and currency associated with it. It is something for which you want to collect payment for. Use this API to create orders with Cashfree from your backend to get a `payment_sessions_id`. You can use the `payment_sessions_id` to create a transaction… - [Get Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/orders/get.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 - Once the order is PAID - Once your customer returns to `return_url` - [Terminate Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/orders/terminate.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/previous/v2023-08-01/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 Get Order Extended API - To get the extended data associated with order. - Once the order is PAID - Once your customer returns to `return_url` - [Update Order Extended](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/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 - [Submit or Resend OTP](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payments/authenticate.md): If you accept OTP on your own page, you can use the below API to send OTP to Cashfree. - [Order Pay](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payments/pay.md): Use this API when you have already created the orders 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 the cards payment option the PCI DSS flag is required, reach out to us by filling out the [Support Form](https://merc… - [Preauthorization](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payments/authorize.md): Use this API to capture or void a preauthorized payment - [Get Payments for an Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payments/get-payments-for-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/previous/v2023-08-01/payments/get.md): Use this API to view payment details of an order for a payment ID. - [Payment Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payments/webhooks.md): Subscribe to Cashfree payment webhooks to receive asynchronous events for successful, failed, and user-dropped payment attempts on your orders. #### Payment Links - [Create Payment Link](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-links/create.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. - [Get Orders for a Payment Link](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-links/get.md): Use this API to view all order details for a payment link. - [Cancel Payment Link](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-links/cancel.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. - [Fetch Payment Link Details](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-links/get-orders-for-link.md): Use this API to view all details and status of a payment link. - [Payment Link Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-links/webhooks.md): Subscribe to Cashfree Payment Link webhooks so your server is notified whenever a link is paid, expires, or moves to a new status in real time. #### Refunds - [Get Refund](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/refunds/get.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/previous/v2023-08-01/refunds/get-refunds-for-order.md): Use this API to fetch all refunds processed against an order. - [Create Refund](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/refunds/create.md): Use this API to initiate refunds. - [Refund Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/refunds/webhooks.md): Subscribe to Cashfree refund webhooks to track when a refund is initiated, succeeds, or fails so you can keep your records and customers in sync. #### Customers - [Create Customer](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/customers/create.md): Create Customer at Cashfree #### Easy-Split - [Easy Split Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/easy-split-overview.md): Use Cashfree Easy Split to share each customer payment between vendors at checkout, automate vendor settlements, and reconcile splits from one place. - [Easy Split - Postman Collection](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/easy-split-postman-collection.md): Download the ready-made Postman collection for the Cashfree Easy Split APIs to test vendor, split, and settlement endpoints with sample requests. - [End Points](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/end-points.md): Review the production and sandbox base URLs and authentication headers you need to call the Cashfree Easy Split APIs for vendor and split operations. ##### Vendors - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/overview.md): Browse every Cashfree Easy Split vendor API, including endpoints to onboard a vendor, upload KYC documents, fetch balances, and update vendor details. - [Create vendor](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/create.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/previous/v2023-08-01/split/vendors/get.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/previous/v2023-08-01/split/vendors/update.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. - [Upload Vendor Docs](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/add-document.md): Use this API to upload KYC documents of a specific vendor. - [Get Vendor All Documents Status](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/get-document.md): Use this API to fetch the details of all the KYC details of a particular vendor. - [Download Vendor Documents](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/vendors/download-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/previous/v2023-08-01/split/vendors/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/previous/v2023-08-01/split/configuration/static-split.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/previous/v2023-08-01/split/configuration/split-after-payment.md): Split After Payment API splits the payments to vendors after successful payment from the customers. - [Create Adjustment](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/configuration/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 - [Settlements Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/settlements/overview.md): Explore the Cashfree Easy Split settlement APIs that fetch payout details for vendors, run on-demand transfers, and reconcile each settled order. - [Create On Demand Balance Transfer](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/settlements/on-demand-transfer.md): The Create On Demand Transfer API will create a new on-demand request either from the merchant ledger or from the vendor ledger to the vendor bank account. - [Get Split and Settlement Details by OrderID](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/settlements/split-details.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/previous/v2023-08-01/split/settlements/get-split-and-settlement-details.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/previous/v2023-08-01/split/billing/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/previous/v2023-08-01/split/webhooks/overview.md): Subscribe to Cashfree Easy Split webhooks so your platform is notified whenever a vendor is updated or a vendor settlement is paid out by Cashfree. - [Vendor Settlement Webhook](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/webhooks/vendor-settlement-webhooks.md): Receive a Cashfree webhook every time a vendor settlement payout is processed, so you can reconcile vendor balances and notify partners in real time. - [Vendor Status Change Webhook](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/webhooks/vendor-status-change-webhooks.md): Receive a Cashfree webhook whenever a vendor's KYC or activation status changes, so your platform always shows accurate Easy Split vendor states. ##### Reconciliation - [Vendor Reconciliation API](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/split/reconciliation/vendor-recon.md): This API allows users to fetch vendor reconciliation details using different filters. Use the appropriate filters based on your requirements. - **View Split Order Details Using Settlement ID**: Retrieve details of split orders within a settlement by Settlement ID. - **Vendor Recon for a Time Period*… #### Eligibility - [Get Eligible Cardless EMI Payment Methods for a customer on an order](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-methods/get-emi-for-customer-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 Offers for an Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-methods/get-offers-for-order.md): Use this API to get eligible offers for an order_id or order amount. - [Get Eligible Paylater for a customer on an order](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-methods/get-paylater-for-customer-order.md): Use this API to get eligible Paylater Payment Methods for a customer on an order. - [Get eligible Payment Methods](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/payment-methods/get-payment-methods.md): Use this API to get eligible Payment Methods #### Offers - [Create Offer](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/offers/create.md): Use this API to create offers with Cashfree from your backend - [Get Offer by ID](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/offers/get.md): Use this API to get offer by offer_id #### Dispute - [Get Disputes by Dispute ID](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/dispute/disputes.md): Use this API to get Dispute details by specifying the Dispute ID. - [Get Disputes by Order ID](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/dispute/disputes-for-order.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/previous/v2023-08-01/dispute/disputes-for-payment.md): Use this API to get all Dispute details by specifying the Payment ID. - [Submit Evidence to contest the Dispute by Dispute ID](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/dispute/dispute-submission.md): Use this API to Submit the Evidences to contest the Dispute by specifying the Dispute ID. - [Accept Dispute by Dispute ID](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/dispute/dispute-accept.md): Use this API to get accept the Dispute by specifying the Dispute ID. - [Dispute Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/dispute/dispute-webhooks.md): Subscribe to Cashfree dispute webhooks to receive asynchronous updates whenever a chargeback or pre-arbitration changes state on your account. #### Settlements - [Get All Settlements](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/settlements/settlements.md): Use this API to get all settlement details by specifying the settlement ID, settlement UTR or date range. - [Get Settlements by Order ID](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/settlements/settlements-for-order.md): Use this API to view all the settlements of a particular order. - [Mark Order For Settlement](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/settlements/mark-order-for-settlement.md): Use this API to pass the CBRICS ID to Cashfree and mark an order for settlement. - [PG Reconciliation](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/settlements/reconcile.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/previous/v2023-08-01/settlements/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 - [Settlement Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/settlements/settlement-webhooks.md): Subscribe to Cashfree settlement webhooks so your reconciliation system is alerted whenever a payout to your merchant or vendor account completes. #### Partners - [Create Pre-Activated Vpas for partner](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/partners/create-pre-activated-vpas-for-partner.md): Use this API to create a pre-activated vpa for partner. - [Get Pre-Activated Vpas for partner](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/partners/get-pre-activated-vpas-for-partner.md): Use this API to get a pre-activated vpa for partner. #### Token Vault - [Fetch All Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/token-vault/get-all.md): Use this API to fetch saved cards for a customer_id - [Fetch Specific Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/token-vault/fetch-specific-saved-card-instrument.md): Use this API to fetch a single specific saved card for a customer_id by it's instrument_id - [Delete Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/token-vault/delete.md): Use this API to delete a saved card instrument for a customer_id and instrument_id - [Fetch cryptogram for a saved card instrument](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/token-vault/generate-cryptogram.md): Use this API To get the card network token, token expiry and cryptogram for a saved card instrument using instrument id - [Card Token Webhook](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/token-vault/webhooks.md): Subscribe to Cashfree card token webhooks to receive asynchronous notifications whenever a saved card instrument is created, updated, or deleted. #### Offline Payments - [Offline Payments Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/softpos/softpos-webhooks.md): Subscribe to Cashfree softPOS webhooks to track terminal onboarding, status, and transaction events for in-person card and UPI payments in real time. - [Create Terminal](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/softpos/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/previous/v2023-08-01/softpos/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/previous/v2023-08-01/softpos/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/previous/v2023-08-01/softpos/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/previous/v2023-08-01/softpos/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/previous/v2023-08-01/softpos/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/previous/v2023-08-01/softpos/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/previous/v2023-08-01/softpos/get-terminal-transaction.md): Use this API to get terminal transaction. - [Update Terminal](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/softpos/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/previous/v2023-08-01/softpos/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/previous/v2023-08-01/softpos/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/previous/v2023-08-01/softpos/upload-terminal-docs.md): Use this API to upload the terminal documents. #### Simulation - [Simulate Payment](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/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/previous/v2023-08-01/simulation/fetch-simulation.md): Use this API to fetch simulated payment details. #### Subscription - [Postman Collection](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/subscription-postman-collection.md): Download the ready-made Postman collection for the v2023-08-01 Cashfree Subscriptions APIs and start testing mandate and charge calls in minutes. - [End Points](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/endpoints.md): Review the production and sandbox base URLs and authentication headers you need to call the v2023-08-01 Cashfree Subscriptions API endpoints. - [Physical Mandates](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/physical-mandates.md): Create, authorise, and manage NACH physical mandates using Cashfree Subscriptions APIs, covering customer signatures and bank details. - [Redirection Payload After Authorisation](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/redirection-payload-after-authorization.md): Understand the POST parameters Cashfree sends to your subscription returnUrl after the customer authorises the payment on the Subscriptions API. - [Rate Limits](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/rate-limits.md): Understand the per-minute rate limits on Cashfree Subscriptions APIs and how to handle throttling on recurring payments. - [Subscription Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/webhooks.md): Subscribe to Cashfree Subscription webhooks so your server reacts whenever a mandate is authorised, a charge succeeds, or a refund is processed. ##### Plan - [Create a plan.](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/plans/create.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/previous/v2023-08-01/subscription/plans/fetch.md): Use this API to fetch plan details. ##### Mandate - [Create Subscription](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/mandate/create.md): Use this API to create a new subscription. - [Fetch Subscription](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/mandate/fetch.md): Use this API to fetch subscription details. - [Manage a subscription.](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/mandate/manage.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, create a new plan with the revised amount, and then use the Manage Subscription API to associate the subscription wit… - [API to upload file for Physical Nach Authorization.](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/mandate/physical-nach-mandate.md): Use this API to upload file for Physical Nach Authorization. - [API to get all the payment method details available for subscription payments.](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/mandate/payment-methods.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/previous/v2023-08-01/subscription/mandate/generate-transaction-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/previous/v2023-08-01/subscription/payment/raise.md): Use this API to create an auth or to raise a charge. - [Fetch details of a single payment.](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/payment/fetch.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/previous/v2023-08-01/subscription/payment/manage.md): Use this API to manage a payment of a subscription. A payment can be cancelled or retried with this API. - [Fetch details of all payments of a subscription.](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/payment/fetch-payments-for-mandate.md): Use this API to fetch all payments of a subscription. ##### Refund - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/refund/refund-apis-overview.md): Manage subscription refunds through Cashfree APIs, covering how to initiate, fetch, and reconcile refunds on recurring payments. - [Create a refund.](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/subscription/refund/create.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/previous/v2023-08-01/subscription/refund/fetch.md): Use this API to fetch details of a refund of a subscription payment. #### VBA ##### Manage VBA - [Create VBA](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/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/previous/v2023-08-01/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/previous/v2023-08-01/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/previous/v2023-08-01/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/previous/v2023-08-01/pgvba/get-vba-payments.md): Use this API to get the details of the created virtual bank account by entering the virtual account ID. - [Get VBA Payments By UTR](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/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/previous/v2023-08-01/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/previous/v2023-08-01/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/previous/v2023-08-01/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/previous/v2023-08-01/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/previous/v2023-08-01/international-payments/overview.md): Discover the Cashfree APIs that power international payments, from accepting payments from India to collecting through global virtual accounts. ##### Collect from India - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/overview.md): Use the Collect from India APIs to accept payments from customers in India, designed for overseas merchants, aggregators, and marketplaces. - [Upload Payment Verification Details](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/upload-payment-verification-details.md): This API is used to upload the required payment details for theverification. - [Get Payment Verification Details](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/get-payment-verification-details.md): Use this API to get the status of the payment verification. - [Get Import Settlement Details for an Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/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/previous/v2023-08-01/international-payments/collect-from-india/get-import-settlement-recon-details.md): This API is used to fetch all events happened for provided Settlement IDs. - [Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/import-webhooks.md): Enable merchants, payment aggregators, and marketplaces outside India to accept payments from customers in India, covering import webhooks, event types, payloads, and signature verification. ##### Collect from the World ###### Global Collections - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/overview.md): Use Cashfree Global Collections to receive international payments into virtual accounts in multiple currencies and settle funds to your Indian bank account. - [End Points](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/endpoints.md): Review the production and sandbox base URLs and authentication headers you need to call the Cashfree Global Collections APIs for cross-border payouts. - [Purpose Codes](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/purpose-codes.md): Look up the FEMA purpose codes accepted by Cashfree Global Collections so you can classify each cross-border receipt against the correct business reason. - [Get Collection Accounts](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/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/previous/v2023-08-01/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/previous/v2023-08-01/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/previous/v2023-08-01/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/previous/v2023-08-01/international-payments/global-collections/partner/webhooks.md): Subscribe to Cashfree Global Collections partner webhooks to receive real-time updates whenever international funds arrive in a merchant virtual account. ###### Authorization - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/partner/auth-overview.md): Learn how Cashfree partners authenticate against the Global Collections APIs by exchanging credentials for a short-lived bearer token before each call. - [Get Auth Token](https://www.cashfree.com/docs/api-reference/payments/previous/v2023-08-01/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/previous/v2023-08-01/international-payments/global-collections/partner/auth-verify-token.md): Verify the authentication token generated by the user. ### v2022-01-01 - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/overview.md): Explore the 2022-09-01 version of the Cashfree Payment Gateway APIs, including orders, payments, refunds, settlements, and reconciliation endpoints. #### Orders - [Create Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/orders/create-order.md): ### Order An order is an entity which has a amount and currency associated with it. It is something for which you want to collect payment for. Use this API to create orders with Cashfree from your backend to get a `payment_sessions_id`. You can use the `payment_sessions_id` to create a transaction… - [Get Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/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 - Once the order is PAID - Once your customer returns to `return_url` #### Payments - [Submit or Resend OTP](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/payments/submit-or-resend-otp.md): If you accept OTP on your own page, you can use the below API to send OTP to Cashfree. - [Order Pay](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/payments/order-pay.md): Use this API when you have already created the orders 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 the cards payment option the PCI DSS flag is required, for more information reach out to us by filling out the [Suppo… - [Preauthorization](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/payments/preauthorization.md): Use this API to capture or void a preauthorized payment - [Get Payments for an Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/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/previous/v2022-09-01/payments/get-payment-by-id.md): Use this API to view payment details of an order for a payment ID. #### Payment Links - [Create Payment Link](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/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/previous/v2022-09-01/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/previous/v2022-09-01/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/previous/v2022-09-01/payment-links/get-orders-for-a-payment-link.md): Use this API to view all order details for a payment link. #### Refunds - [Get All Refunds for an Order](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/refunds/get-all-refunds-for-an-order.md): Use this API to fetch all refunds processed against an order. - [Create Refund](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/refunds/create-refund.md): Use this API to initiate refunds. - [Get Refund](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/refunds/get-refund.md): Use this API to fetch a specific refund processed on your Cashfree Account. #### Token Vault - [Fetch All Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/token-vault/fetch-all-saved-card-instrument.md): Use this API to fetch saved cards for a customer_id - [Fetch Specific Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/token-vault/fetch-specific-saved-card-instrument.md): Use this API to fetch a single specific saved card for a customer_id by it's instrument_id - [Delete Saved Card Instrument](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/token-vault/delete-saved-card-instrument.md): Use this API to delete a saved card instrument for a customer_id and instrument_id - [Fetch cryptogram for a saved card instrument](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/token-vault/fetch-cryptogram-for-a-saved-card-instrument.md): Use this API To get the card network token, token expiry and cryptogram for a saved card instrument using instrument id #### Eligibility - [Get Eligible Cardless EMI](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/eligibility/get-eligible-cardless-emi.md): Use this API to get eligible Cardless EMI Payment Methods available for a customer on an order basis their phone number. - [Get Eligible Offers](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/eligibility/get-eligible-offers.md): Use this API to get eligible offers for an order_id or order amount. - [Get Eligible Paylater](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/eligibility/get-eligible-paylater.md): Use this API to get eligible Paylater Payment Methods for a customer on an order. - [Get Eligible Payment Methods](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/eligibility/get-eligible-payment-methods.md): Use this API to get eligible Payment Methods #### Offers - [Create Offer](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/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/previous/v2022-09-01/offers/get-offer-by-id.md): Use this API to get offer by offer_id #### Settlements - [Get Settlements by Order ID](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/settlements/get-settlements-by-order-id.md): Use this API to view all the settlements of a particular order. #### PG Reconciliation - [PG Reconciliation](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/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 - [Settlement Reconciliation](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/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/previous/v2022-09-01/settlement-reconciliation/get-all-settlements.md): Use this API to get all settlement details by specifying the settlement ID, settlement UTR or date range. #### Offline Payments - [Offline Payments Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/softpos/softpos-webhooks.md): Subscribe to Cashfree softPOS webhooks on the 2022-09-01 API to track terminal onboarding, status, and transaction events for in-person payments. - [Create Terminal](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/softpos/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/previous/v2022-09-01/softpos/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](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/softpos/create-terminal-1.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. - [Get terminal status using phone number](https://www.cashfree.com/docs/api-reference/payments/previous/v2022-09-01/softpos/get-terminal-status-using-phone-number.md): Use this API to view all details of a terminal. #### Subscription - [Postman Collection](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription-postman-collection.md): Download the ready-made Postman collection for the legacy Subscriptions v1 APIs and start testing mandate, charge, and refund calls in minutes. - [End Points](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/endpoints.md): Get the production and test base URLs for the legacy Subscriptions v1 APIs, plus the API key authentication details you need to send requests. - [Physical Mandates](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/physical-mandates.md): Use the Cashfree Subscriptions v1 APIs to create and manage physical NACH mandates using customer signature and bank account details. - [Redirection Payload After Authorisation](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/redirection-payload-after-authorization.md): Understand the POST parameters Cashfree returns to your subscription `returnUrl` once the customer authorises on Subscriptions v1 APIs. - [Rate Limits](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/rate-limits.md): Understand the per-minute rate limits for Cashfree Subscriptions v1 APIs and how to avoid throttling on recurring payment calls. - [Webhooks](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/webhooks.md): Learn how Cashfree sends server callbacks for Subscriptions v1 events so you can react to mandate, charge, and refund status changes in real time. ##### Seamless APIs - [Create Seamless Subscription with Plan ID](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/seamless-apis/create-seamless-subscription-with-plan-id.md): Use this API to create a subscription by providing a custom payment experience to your customers by specifying the plan ID and the customer details. You can also specify the bank account information when you create the subscription to ensure that mandates are created via the specified bank account o… - [Create Authorization Request](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/seamless-apis/create-authorization-request.md): Use this API to create an authorisation request for a particular subscription. This API is applicable only if you have created a subscription via Create Seamless Subscription API. Use the response of the Create Seamless Subscription API to get the supported banks for E_MANDATE and supported UPI hand… - [Get Authorization Status](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/seamless-apis/get-authorization-status.md): Use this API to fetch the status of the authorisation request. Provide the authID that is available in the Create Auth API response. This API is applicable only if you have created a subscription using the Create Seamless Subscription API - [Update Authorization Status](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/seamless-apis/update-authorization-status.md): Use this API to update the status of the authorisation from INITIALIZED to SUCCESS or FAILED. Provide the authID and the payment status. This is applicable only in the test environment. ##### Subscription Refund - [Overview](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription-refund/refund-apis-overview.md): Use the Cashfree Subscriptions v1 APIs to initiate, retrieve, and reconcile refunds on recurring payments. - [Create Subscription Refund](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription-refund/create-subscription-refund.md): Use this API to create a refund for the payment of a Subscription. Only one of paymentId or merchantTxnId should be passed. If both are passed then the request will be rejected. - [Get Subscription Refund Details](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription-refund/get-subscription-refund-details.md): Use this API to fetch the status of the refund of a Subscription. Only one of paymentId or merchantRefundId should be passed as query parameter. If both are passed then the request will be rejected. ##### Subscription - [Get Subscription Details](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/get-subscription-details.md): Fetch the details of a subscription for a specific subscription reference ID. - [Update Recurring Amount](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/update-recurring-amount.md): Update the recurring amount for a specific subscription reference ID. - [Fetch Subscription Payments](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/fetch-subscription-payments.md): Fetch all payments associated with a specific subscription reference ID. - [Fetch Single Subscription Payment](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/fetch-single-subscription-payment.md): Fetch details of a specific payment associated with a subscription reference ID. - [Fetch Payment by Merchant Transaction ID](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/fetch-payment-by-merchant-transaction-id.md): Fetch details of a specific payment associated with a given merchant transaction ID. - [Cancel Subscription](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/cancel-subscription.md): Use this API to cancel the subscription. After a successful cancellation, the subscription status will move to "CANCELLED", and the customer will no longer be charged. Subscription, once cancelled, cannot be reactivated. - [Pause Subscription](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/pause-subscription.md): Use this API to temporarily pause a subscription. Once this API is called, the subscription status will be updated to "PAUSED". Only a periodic subscription can be paused. To reactivate the subscription, you can use the Activate Subscription API. - [Charge Subscription](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/charge-subscription.md): Charge a specific subscription using the provided subscription reference ID. - [Retry Subscription Charge](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/retry-subscription-charge.md): Applicable only for Periodic Subscriptions. Use this API to retry the last failed payment for a subscription in ON HOLD state. On a successful retry, the subscription gets activated. Use the Retry API when the subscription debit has failed at your customer's end. Only one retry attempt is allowed pe… - [Upload Physical Mandate File](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/upload-physical-mandate-file.md): Use this API to upload the Physical Nach registration forms that contain your customer’s bank account details and signature. Use the fileId you get in the response in the "Create Auth Seamless PhysicalMandate API". - [Activate Subscription](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/activate-subscription.md): Use this API to activate a subscription that is in ONHOLD state. For periodic subscriptions, the next charge date is calculated for the next cycle. - [Cancel Subscription Charge](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/cancel-subscription-charge.md): Use this API to cancel a transaction that is in the INITIALIZED state. - [Update Charge Status](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/update-charge-status.md): Use this API to update the status of the charge from PENDING to SUCCESS or FAILED. This is applicable only in the test environment. - [Generate Transaction Return Summary](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/generate-transaction-return-summary.md): Use this API to generate transaction return summary for failed transactions (insufficient balance). You will have to hit the API again to check the status of the transaction return summary, or go to the [Merchant Dashboard](https://merchant.cashfree.com/merchants) and download the same. - [Create a Subscription Plan](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/create-a-subscription-plan.md): Use this API to create a new plan. Provide the planId, planName, and the plan type(PERIODIC/ON_DEMAND). - [Create a Subscription](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/create-a-subscription.md): Use this API to create a subscription by specifying the plan ID or plan Info and customer details.You can also specify the bank account information when you create the subscription to ensure that mandates are created via the specified bank account only. TPV is applicable only for eNACH and UPI Autop… - [Port Mandate](https://www.cashfree.com/docs/api-reference/payments/previous/subscriptionsv1/subscription/port-mandate.md): Use this API to import an existing mandate into the Cashfree subscription system. This is applicable where mandates are already created with another provider or system. By porting the mandate, you can manage the subscription within Cashfree's ecosystem. ## OpenAPI Specs - [v2025-01-01](/docs/openapi/payments/v2025-01-01.yaml) - [pgvba](/docs/openapi/pgvba/pgvba.yaml) - [v2025-01-01](/docs/openapi/cb-imports/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)