Process Payment - Subscriptions

Use the below endpoint to Process Payment for Subscriptions

Request Parameters:

Attribute	params	Nested Params	Data Type	Description
merchantId*			string	Onboarded Merchant ID
clientUniqueReference*			string	unique reference number assigned to a merchant
enableNotification		false/true	boolean	default false
plan*	{}			plan details
	planId		string	required if its plural maintained plan
	merchantMaintainedPlan		boolean	false: if its plural maintained plan true: if its merchant maintained plan
	merchantPlanId		string
	merchantId		string
	planName		string
	planDescription		string
	frequency		string
	frequencyType		string
	maxUsers		string
	notes		string
	amount
		value	integer	value given in numbers
		currency	string	which currency used for transaction: INR
	maxLimitAmount
		value	integer	value given in numbers
		currency	string	which currency used for transaction: INR
	trialPeriodInDays		integer
	startDate	string(UTC format date time example: 2023-02-06 18:30:00)	string	start date of the plan 2023-02-06 18:30:00
	endDate	string(UTC format date time example: 2023-02-06 18:30:00)	string	end date of the plan 2023-02-06 18:30:00
quantity*		number of subscription needed default is 1	integer	number of subscription needed
startDate*	startDate	string(UTC format example: 2023-02-06 18:30:00)	string	start date of subscription 2023-02-06 18:30:00
endDate*	endDate	string(UTC format date time example: 2023-02-06 18:30:00)	string	end date of subscription
customerData*	{}
	firstName		string	forst name of the customer
	lastName		string	last name of the customer
	countryCode*		string	for india its 91, phone country code
	customerMobile*		string	customer mobile number to send any notification
	customerEmail*		string	email to send any notification
autoDebit		default true	boolean	whether auto-debit opted or not
upi_data*	{}
	txnMode: "C/I""		string	customer upi id I:INTENT vpa will not be needed C: COLLECT vpa will be needed
payments	{}
	amountLimit		string
	debitDay		integer	which day debit should happen, default:1
	debitRule		string	default is ON
	blockFund		string	should customer blocked for this customer.default: N

Request Body payload:

{
	"merchantId": "3000004",
	"clientUniqueReference": "Merchant_Plan_001",
	"enableNotification": true,
	"plan": {
		"planId": "",
		"merchantMaintainedPlan": false,		
		"merchantPlanId": "merch007",
		"merchantId": "3004",
		"planName": "MPPlanDayNT",
		"planDescription": "Merchant Maintained Plan feb 06 ",
		"frequency": 1,
		"frequencyType": "Day",
		"maxUsers": "100",
		"notes": "Sample message",
		"amount": {
			"value": 220,
			"currency": "INR"
		},
		"maxLimitAmount": {
			"value": 220,
			"currency": "INR"
		},
		"trialPeriodInDays": 0,
		"startDate": "2023-02-06 18:30:00",
		"endDate": "2023-02-10 18:30:00"
	},
	"quantity": 1,
	"startDate": "2023-02-06 18:30:00",
	"endDate": "2023-02-10 18:30:00",
	"customerData": {
		"firstName": "Dhakshin",
		"lastName": "K",
		"countryCode": "91",
		"customerMobile": "9444600695",
		"customerEmail": "[email protected]"
	},
	"autoDebit": true,
	"upi_data": {
		"vpa": "dhakshin@okaxis"
	},
	"payments": {
		"amountLimit": "M",
		"debitDay": 1,
		"debitRule": "ON",
		"blockFund": "N"
	}
}

Response Payload:

{
	"response_code": "1",
	"response_message": "Transaction initiated",
	"merchant_order_id": "3565203",
	"order_id": 3565203,
	"subscription_id": "130",
	"plan_id": "17"
}

{
    "response_code": 12404,
    "response_message": "Create subscription failed"
}

{    "response_code": 12408,  
     "response_message": "Invalid Upi Details"
}

Response Parameters

Parameter Name	Type	Description
response_code	string	response code received
response_message	string	Short message about code.
subscription_id	string	created subscription id on successful scenario
plan_id	string	id captured while processing the payment