Skip to main content

ā€‹
Request configuration

MethodParameter TypeURL
cf_subReferenceIdLongUnique Id which was generated when the subscription was created (Numeric)
cf_subscriptionIdStringChecksum used to authenticate the transaction
cf_authAmountFloatThe money that was charged to authorize the subscription
cf_referenceIdLongThe referenceId/transactionId of authorization in PG
cf_statusStringStatus of the subscription. In the returnUrl, the response should be ACTIVE or BANK_APPROVAL_PENDING if the authorization was successful or INITIALIZED if the authorization failed.
cf_messageStringA brief note about the payment.
signatureStringThe hash of all parameters in the request generated using secretKey.
cf_umrnStringThe unique identifier associated with a mandate. Applicable if the payment mode is eMandate.
cf_checkoutStatusStringThe subscription checkout status. The status can be SUCCESS, FAILED, SUCCESS_DEBIT_PENDING, SUCCESS_TOKENIZATION_PENDING. (This parameter will be sent from the 1st of November onwards, by default. It is available in the test environment.)
cf_modeStringThe checkout payment mode. Modes - NPCI_SBC, SBC_UPI, SBC_CREDIT_CARD, SBC_DEBIT_CARD. (This parameter will be sent from the 1st of November onwards, by default. It is available in the test environment.)
cf_subscriptionPaymentIdStringThe subscription payment ID. (This parameter will be sent from the 1st of November onwards, by default. It is available in the test environment.)
cf_umnStringThe unique identifier is associated with a mandate. This is applicable if the payment mode is UPI.
Return URL
  • After the customer completes the checkout on the OTP page, they are redirected to your return_url. This redirection is link-based. For example, if you provide a return_url in the format https://b8af79f41056.eu.ngrok.io?order_id={order_id}, the customer is redirected to https://b8af79f41056.eu.ngrok.io?order_id=order_271vfuhh1o4h6bQIigqyOx74YiJ1T.
  • In production, cf_status and cf_message may not be included in the return_url response, even though they are present in the sandbox.
    The return_url is intended only to redirect customers back to your site after payment. It should not be used to retrieve complete subscription details.
For accurate and complete data, use webhooks.
  • Configure your webhook URL in the Cashfree Dashboard.
  • Enable the relevant events, such as SUBSCRIPTION_AUTH_STATUS and SUBSCRIPTION_PAYMENT_SUCCESS.
Always validate the subscription status through webhook notifications for production-grade reliability.