Create Controlled Execution

Use this API to create a controlled charge execution for an on-demand subscription mandate after a successful notification.

POST /subscriptions/pay/controlled/execute-mandate

Create Controlled Execution

cURL

curl --request POST \
  --url https://sandbox.cashfree.com/pg/subscriptions/pay/controlled/execute-mandate \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "execution_id": "basePay123-exec1",
  "payment_id": "basePay123"
}
'

import requests

url = "https://sandbox.cashfree.com/pg/subscriptions/pay/controlled/execute-mandate"

payload = {
    "execution_id": "basePay123-exec1",
    "payment_id": "basePay123"
}
headers = {
    "x-api-version": "<x-api-version>",
    "x-client-id": "<api-key>",
    "x-client-secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-version': '<x-api-version>',
    'x-client-id': '<api-key>',
    'x-client-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({execution_id: 'basePay123-exec1', payment_id: 'basePay123'})
};

fetch('https://sandbox.cashfree.com/pg/subscriptions/pay/controlled/execute-mandate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.cashfree.com/pg/subscriptions/pay/controlled/execute-mandate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'execution_id' => 'basePay123-exec1',
    'payment_id' => 'basePay123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-version: <x-api-version>",
    "x-client-id: <api-key>",
    "x-client-secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.cashfree.com/pg/subscriptions/pay/controlled/execute-mandate"

	payload := strings.NewReader("{\n  \"execution_id\": \"basePay123-exec1\",\n  \"payment_id\": \"basePay123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-version", "<x-api-version>")
	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-client-secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/pg/subscriptions/pay/controlled/execute-mandate")
  .header("x-api-version", "<x-api-version>")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"execution_id\": \"basePay123-exec1\",\n  \"payment_id\": \"basePay123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/pg/subscriptions/pay/controlled/execute-mandate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"execution_id\": \"basePay123-exec1\",\n  \"payment_id\": \"basePay123\"\n}"

response = http.request(request)
puts response.read_body

200

Example

{
  "cf_execution_id": "3333",
  "cf_payment_id": "123456",
  "execution_id": "basePay123-exec1",
  "execution_initiated_time": "2025-06-01T22:14:58+05:30",
  "execution_status": "INITIALIZED",
  "payment_amount": 10,
  "payment_id": "basePay123",
  "payment_status": "PENDING",
  "subscription_id": "abcd"
}

This API supports UPI mandates only. eNACH and Physical NACH (PNACH) mandates are not supported. Card support is planned for a future release.

The debit amount cannot change after the pre-debit notification (PDN) is initiated. If the executed debit amount differs from the amount notified in the PDN, the transaction is declined by the issuing bank due to the amount-match logic enforced at the issuing bank.

Authorizations

XClientID & XClientSecretXClientID & XPartnerAPIKeyXClientID & XClientSignatureHeaderXPartnerMerchantID & XPartnerAPIKey

x-client-id · string · header · required

Client app ID. You can find your app id in the Merchant Dashboard.

x-client-secret · string · header · required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

x-api-version · string · default: 2025-01-01 · required

API version to be used.

x-request-id · string

Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.

x-idempotency-key · string<UUID>

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Body

application/json

Request parameters to create a controlled charge execution for a subscription mandate.

execution_id · string · required

A unique ID passed by the merchant to identify the controlled execution attempt.

payment_id · string · required

Base Payment ID for which the controlled execution is being raised.

Response

200

application/json

Success response for creating a controlled payment execution.

cf_execution_id · string

Cashfree-generated identifier for the controlled execution.

cf_payment_id · string

Cashfree subscription payment reference number.

execution_id · string

Merchant-provided identifier for the controlled execution.

execution_initiated_time · string<ISO8601>

The timestamp when the controlled execution was initiated. Timestamps are in IST.

Example:

"2025-06-01T22:14:58+05:30"

execution_status · string

Status of the controlled execution.

payment_amount · number<float64>

Amount associated with the controlled execution.

payment_id · string

Base Payment ID associated with the controlled execution.

payment_status · string

Current status of the parent payment entity.

subscription_id · string

Subscription ID associated with the controlled execution.