Below are the various events that can be sent to your webhook endpoint. These webhooks will be triggered if the merchant has integrated our newer Subscription API.
Note : If the merchant added the webhook under the 2025-01-01 version, they
will receive the same version of the webhook for older subscriptions as well.
Payment method object attributes:
UPI
ENACH
PNACH
Debit/Credit card
"payment_method" : {
"upi" : {
"channel" : "collect" ,
"upi_id" : "8709228804@ybl" ,
"upi_instrument" : "" ,
"upi_instrument_number" : "" ,
"upi_payer_account_number" : "" ,
"upi_payer_ifsc" : ""
}
},
"payment_group" : "upi"
SUBSCRIPTION_STATUS_CHANGED
Whenever a subscription is created it goes to initialised state and customer is expected to authorise it. The list of statuses where this webhook will get triggered are:
ACTIVE
ON_HOLD
COMPLETED
CUSTOMER_CANCELLED
CUSTOMER_PAUSED
EXPIRED
LINK_EXPIRED
BANK_APPROVAL_PENDING
Version (2025-01-01)
Version (2023-08-01)
{
"data" : {
"subscription_details" : {
"cf_subscription_id" : "857805" ,
"subscription_id" : "check1" ,
"subscription_status" : "CANCELLED" ,
"subscription_expiry_time" : "2055-04-04T17:45:19" ,
"subscription_first_charge_time" : "2025-04-16T00:00:00" ,
"subscription_tags" : null
},
"customer_details" : {
"customer_name" : "Webhook check1" ,
"customer_email" : "shubham.bansal@gmail.com" ,
"customer_phone" : "9900876578"
},
"plan_details" : {
"plan_id" : null ,
"plan_name" : "Check1" ,
"plan_type" : "PERIODIC" ,
"plan_max_cycles" : 7 ,
"plan_recurring_amount" : 10 ,
"plan_max_amount" : 10 ,
"plan_interval_type" : "MONTH" ,
"plan_intervals" : 1 ,
"plan_currency" : null ,
"plan_note" : null ,
"plan_status" : null
},
"authorization_details" : {
"authorizationAmount" : 1 ,
"authorizationAmountRefund" : false ,
"approveByTime" : "2025-05-04T17:45:19" ,
"authorizationReference" : "POSNnwr0NZWo1paEGnAmcxPgCeybmC@upi" ,
"authorizationTime" : "2025-04-04T17:46:39" ,
"authorizationStatus" : "ACTIVE" ,
"paymentId" : "955957" ,
"payment_method" : {
"upi" : {
"channel" : "collect" ,
"upi_id" : "8709228804@ybl" ,
"upi_instrument" : "" ,
"upi_instrument_number" : "" ,
"upi_payer_account_number" : "" ,
"upi_payer_ifsc" : ""
}
},
"payment_group" : "upi"
},
"payment_gateway_details" : {
"gateway_name" : "CASHFREE" ,
"gateway_subscription_id" : "857805" ,
"gateway_plan_id" : null ,
"gateway_auth_id" : "POSNnwr0NZWo1paEGnAmcxPgCeybmC@upi"
}
},
"event_time" : "2025-04-07T14:53:46+05:30" ,
"type" : "SUBSCRIPTION_STATUS_CHANGED"
}
SUBSCRIPTION_AUTH_STATUS
The event is triggered when the checkout is completed by the customer for success and failed cases.
Version (2025-01-01)
Version (2023-08-01)
{
"data" : {
"payment_id" : "10533294_242_1744017942228" ,
"cf_payment_id" : "969185" ,
"cf_txn_id" : "5114917189861" ,
"cf_order_id" : 2191912575 ,
"subscription_id" : "check6" ,
"cf_subscription_id" : "862991" ,
"payment_type" : "AUTH" ,
"authorization_details" : {
"authorization_amount" : 1 ,
"authorization_amount_refund" : false ,
"approve_by_time" : "" ,
"authorization_reference" : null ,
"authorization_time" : "2025-04-07T14:55:42+05:30" ,
"authorization_status" : "INITIALIZED" ,
"payment_id" : "10533294_242_1744017942228" ,
"payment_method" : {
"upi" : {
"channel" : "collect" ,
"upi_id" : "8709228804@ybl" ,
"upi_instrument" : "" ,
"upi_instrument_number" : "" ,
"upi_payer_account_number" : "" ,
"upi_payer_ifsc" : ""
}
},
"payment_group" : "upi"
},
"payment_amount" : 1 ,
"payment_currency" : "INR" ,
"payment_schedule_date" : "" ,
"payment_initiated_date" : "2025-04-07T14:55:42+05:30" ,
"payment_remarks" : "auth payment" ,
"retry_attempts" : 0 ,
"failure_details" : {
"failure_reason" : null
},
"payment_status" : "PENDING" ,
"payment_gateway_details" : {
"gateway_name" : "CASHFREE" ,
"gateway_subscription_id" : "862991" ,
"gateway_payment_id" : "969185"
}
},
"event_time" : "2025-04-07T14:55:44+05:30" ,
"type" : "SUBSCRIPTION_AUTH_STATUS"
}
SUBSCRIPTION_PAYMENT_NOTIFICATION_INITIATED
This webhook is used to inform the merchant that we have sent a notification of payment to the customer.
Version (2025-01-01)
Version (2023-08-01)
{
"data" : {
"payment_id" : "10533294_89_1744054393597" ,
"cf_payment_id" : "969934" ,
"cf_txn_id" : null ,
"cf_order_id" : null ,
"subscription_id" : "check10" ,
"cf_subscription_id" : "863147" ,
"payment_type" : "CHARGE" ,
"authorization_details" : {
"authorization_amount" : 10 ,
"authorization_amount_refund" : false ,
"approve_by_time" : "" ,
"authorization_reference" : {
"authorization_time" : "" ,
"authorization_status" : "ACTIVE" ,
"payment_id" : "10533294_89_1744054393597" ,
"payment_method" : {
"upi" : {
"channel" : "collect" ,
"upi_id" : "8709228804@ybl" ,
"upi_instrument" : "" ,
"upi_instrument_number" : "" ,
"upi_payer_account_number" : "" ,
"upi_payer_ifsc" : ""
}
},
"payment_group" : "upi"
},
"payment_amount" : 10 ,
"payment_currency" : "INR" ,
"payment_schedule_date" : "2025-04-09T12:00:00+05:30" ,
"payment_initiated_date" : "2025-04-08T01:03:14+05:30" ,
"payment_remarks" : "" ,
"retry_attempts" : 0 ,
"failure_details" : {
"failure_reason" : null
},
"payment_status" : "INITIALIZED" ,
"payment_gateway_details" : {
"gateway_name" : "CASHFREE" ,
"gateway_subscription_id" : "863147" ,
"gateway_payment_id" : "969934"
}
},
"event_time" : "2025-04-08T17:00:24+05:30" ,
"type" : "SUBSCRIPTION_PAYMENT_NOTIFICATION_INITIATED"
}
}
SUBSCRIPTION_PAYMENT_SUCCESS
This notification is sent whenever a successful payment is processed for an active subscription.
Version (2025-01-01)
Version (2023-08-01)
{
"data" : {
"payment_id" : "10533294_242_1744017942228" ,
"cf_payment_id" : "969185" ,
"cf_txn_id" : "5114917189861" ,
"cf_order_id" : 2191912575 ,
"subscription_id" : "check6" ,
"cf_subscription_id" : "862991" ,
"payment_type" : "AUTH" ,
"authorization_details" : {
"authorization_amount" : 1 ,
"authorization_amount_refund" : false ,
"approve_by_time" : "" ,
"authorization_reference" : "xDKzVxTxw3viaYISZffrcy9K0ByaT0@upi" ,
"authorization_time" : "2025-04-07T14:55:44+05:30" ,
"authorization_status" : "ACTIVE" ,
"payment_id" : "10533294_242_1744017942228" ,
"payment_method" : {
"upi" : {
"channel" : "collect" ,
"upi_id" : "8709228804@ybl" ,
"upi_instrument" : "" ,
"upi_instrument_number" : "" ,
"upi_payer_account_number" : "" ,
"upi_payer_ifsc" : ""
}
},
"payment_group" : "upi"
},
"payment_amount" : 1 ,
"payment_currency" : "INR" ,
"payment_schedule_date" : "" ,
"payment_initiated_date" : "2025-04-07T14:55:42+05:30" ,
"payment_remarks" : "auth payment" ,
"retry_attempts" : 0 ,
"failure_details" : {
"failure_reason" : null
},
"payment_status" : "SUCCESS" ,
"payment_gateway_details" : {
"gateway_name" : "CASHFREE" ,
"gateway_subscription_id" : "862991" ,
"gateway_payment_id" : "969185"
}
},
"event_time" : "2025-04-07T14:55:44+05:30" ,
"type" : "SUBSCRIPTION_PAYMENT_SUCCESS"
}
SUBSCRIPTION_PAYMENT_FAILED
This notification is sent whenever payment processing fails for an active subscription.
Version (2025-01-01)
Version (2023-08-01)
{
"data" : {
"payment_id" : "10533294_531_1744184404303" ,
"cf_payment_id" : "983717" ,
"cf_txn_id" : 67890 ,
"cf_order_id" : 98765 ,
"subscription_id" : "check19" ,
"cf_subscription_id" : "868529" ,
"payment_type" : "CHARGE" ,
"authorization_details" : {
"authorization_amount" : 1 ,
"authorization_amount_refund" : false ,
"approve_by_time" : "" ,
"authorization_reference" : "xDKzVxTxw3viaYISZffrcy9K0ByaT0@upi" ,
"authorization_time" : "2025-04-07T14:55:44+05:30" ,
"authorization_status" : "ACTIVE" ,
"payment_id" : "10533294_242_1744017942228" ,
"payment_method" : {
"upi" : {
"channel" : "collect" ,
"upi_id" : "8709228804@ybl" ,
"upi_instrument" : "" ,
"upi_instrument_number" : "" ,
"upi_payer_account_number" : "" ,
"upi_payer_ifsc" : ""
}
},
"payment_group" : "upi"
},
"payment_amount" : 10 ,
"payment_currency" : "INR" ,
"payment_schedule_date" : "2025-04-11T12:00:00+05:30" ,
"payment_initiated_date" : "2025-04-09T13:10:04+05:30" ,
"payment_remarks" : "" ,
"retry_attempts" : 0 ,
"failure_details" : {
"failure_reason" : "Notification couldn't be sent to the customer"
},
"payment_status" : "FAILED" ,
"payment_gateway_details" : {
"gateway_name" : "CASHFREE" ,
"gateway_subscription_id" : "868529" ,
"gateway_payment_id" : "983717"
}
},
"event_time" : "2025-04-10T21:02:54+05:30" ,
"type" : "SUBSCRIPTION_PAYMENT_FAILED"
}
SUBSCRIPTION_PAYMENT_CANCELLED
This notification is sent whenever payment processing is cancelled by user for an active subscription.
Version (2025-01-01)
Version (2023-08-01)
{
"data" : {
"payment_id" : "10533294_531_1744184404303" ,
"cf_payment_id" : "983717" ,
"cf_txn_id" : 67890 ,
"cf_order_id" : 98765 ,
"subscription_id" : "check19" ,
"cf_subscription_id" : "868529" ,
"payment_type" : "CHARGE" ,
"authorization_details" : {
"authorization_amount" : 1 ,
"authorization_amount_refund" : false ,
"approve_by_time" : "" ,
"authorization_reference" : "xDKzVxTxw3viaYISZffrcy9K0ByaT0@upi" ,
"authorization_time" : "2025-04-07T14:55:44+05:30" ,
"authorization_status" : "ACTIVE" ,
"payment_id" : "10533294_242_1744017942228" ,
"payment_method" : {
"upi" : {
"channel" : "collect" ,
"upi_id" : "8709228804@ybl" ,
"upi_instrument" : "" ,
"upi_instrument_number" : "" ,
"upi_payer_account_number" : "" ,
"upi_payer_ifsc" : ""
}
},
"payment_group" : "upi"
},
"payment_amount" : 10 ,
"payment_currency" : "INR" ,
"payment_schedule_date" : "2025-04-11T12:00:00+05:30" ,
"payment_initiated_date" : "2025-04-09T13:10:04+05:30" ,
"payment_remarks" : "" ,
"retry_attempts" : 0 ,
"failure_details" : {
"failure_reason" : "Customer has cancelled the mandate."
},
"payment_status" : "CANCELLED" ,
"payment_gateway_details" : {
"gateway_name" : "CASHFREE" ,
"gateway_subscription_id" : "868529" ,
"gateway_payment_id" : "983717"
}
},
"event_time" : "2025-04-10T21:02:54+05:30" ,
"type" : "SUBSCRIPTION_PAYMENT_CANCELLED"
}
SUBSCRIPTION_REFUND_STATUS
This event is triggered whenever a refund status of a transaction will be success, failed, or cancelled.
Version (2025-01-01)
Version (2023-08-01)
{
"data" : {
"payment_id" : "pay8643" ,
"cf_payment_id" : "863782648" ,
"refund_id" : "refund2" ,
"cf_refund_id" : "ref_212" ,
"refund_amount" : 100 ,
"refund_note" : "test" ,
"refund_speed" : "INSTANT" ,
"refund_status" : "SUCCESS" ,
"failure_details" : null ,
"payment_gateway_details" : {
"gateway_name" : "CASHFREE" ,
"gateway_payment_id" : "pay8643" ,
"gateway_refund_id" : "refund2"
}
},
"event_time" : "2023-01-03T11:16:10+05:30" ,
"type" : "SUBSCRIPTION_REFUND_STATUS"
}