When a subscription is created a returnUrl is provided as a part of the request. When the customer authorizes the payment, they will be redirected to the returnURL. This redirection is done via a POST request with the parameters available below.
Method | Parameter Type | URL |
---|---|---|
cf_subReferenceId | Long | Unique Id which was generated when the subscription was created (Numeric) |
cf_subscriptionId | String | Checksum used to authenticate the transaction |
cf_authAmount | Float | The money that was charged to authorize the subscription |
cf_referenceId | Long | The referenceId/transactionId of authorization in PG |
cf_status | String | Status 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_message | String | A brief note about the payment. |
signature | String | The hash of all parameters in the request generated using secretKey. |
cf_umrn | String | The unique identifier associated with a mandate. Applicable if the payment mode is eMandate. |
cf_checkoutStatus | String | The 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_mode | String | The 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_subscriptionPaymentId | String | The subscription payment ID. (This parameter will be sent from the 1st of November onwards, by default. It is available in the test environment.) |
cf_umn | String | The unique identifier is associated with a mandate. This is applicable if the payment mode is UPI. |
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
.
cf_status
and cf_message
may not be included in the return_url
response, even though they are present in the sandbox.return_url
is intended only to redirect customers back to your site after payment. It should not be used to retrieve complete subscription details.
SUBSCRIPTION_AUTH_STATUS
and SUBSCRIPTION_PAYMENT_SUCCESS
.