v2025-01-01
Other Versions
- Overview
- Postman Collection
- End Points
- Physical Mandates
- GETGet Subscription Details
- PUTUpdate Recurring Amount
- GETFetch Subscription Payments
- GETFetch Single Subscription Payment
- GETFetch Payment by Merchant Transaction ID
- POSTCancel Subscription
- PUTPause Subscription
- POSTCharge Subscription
- POSTRetry Subscription Charge
- POSTUpload Physical Mandate File
- POSTActivate Subscription
- POSTCancel Subscription Charge
- PUTUpdate Charge Status
- POSTGenerate Transaction Return Summary
- POSTCreate a Subscription Plan
- POSTCreate a Subscription
- POSTPort Mandate
- GET
- Redirection Payload after Authorization
- Rate Limits
- Webhooks
curl --request POST \
--url https://sandbox.cashfree.com/api/v2/subscriptions/mandate/port \
--header 'Content-Type: application/json' \
--header 'X-Client-Id: <x-client-id>' \
--header 'X-Client-Secret: <x-client-secret>' \
--data '
{
"customerDetails": {
"customerEmail": "[email protected]",
"customerPhone": "9999999999",
"debitAccountNumber": "1234567890",
"debitAccountHolderName": "John Doe",
"debitBankId": "SBIN",
"debitAccountType": "SAVINGS"
},
"subscriptionDetails": {
"umrn": "SBIN0000000000000000",
"paymentType": "E_MANDATE",
"fixedAmount": 10,
"maxAmount": 100,
"portingFrequency": "MNTH",
"startDate": "2025-03-28",
"endDate": "2025-08-04",
"maxCycles": 10,
"subscriptionId": "subs-import-mandate",
"firstChargeDate": "2025-04-03"
}
}
'{
"status": "OK",
"message": "Mandate Porting Successful",
"data": {
"subReferenceId": 12345,
"subscriptionId": "subs-import-mandate",
"status": "ACTIVE"
}
}Port Mandate
Use this API to import an existing mandate into the Cashfree subscription system. This is applicable where mandates are already created with another provider or system. By porting the mandate, you can manage the subscription within Cashfree’s ecosystem.
curl --request POST \
--url https://sandbox.cashfree.com/api/v2/subscriptions/mandate/port \
--header 'Content-Type: application/json' \
--header 'X-Client-Id: <x-client-id>' \
--header 'X-Client-Secret: <x-client-secret>' \
--data '
{
"customerDetails": {
"customerEmail": "[email protected]",
"customerPhone": "9999999999",
"debitAccountNumber": "1234567890",
"debitAccountHolderName": "John Doe",
"debitBankId": "SBIN",
"debitAccountType": "SAVINGS"
},
"subscriptionDetails": {
"umrn": "SBIN0000000000000000",
"paymentType": "E_MANDATE",
"fixedAmount": 10,
"maxAmount": 100,
"portingFrequency": "MNTH",
"startDate": "2025-03-28",
"endDate": "2025-08-04",
"maxCycles": 10,
"subscriptionId": "subs-import-mandate",
"firstChargeDate": "2025-04-03"
}
}
'{
"status": "OK",
"message": "Mandate Porting Successful",
"data": {
"subReferenceId": 12345,
"subscriptionId": "subs-import-mandate",
"status": "ACTIVE"
}
}Headers
Client ID provided by Cashfree.
"asdf1234"
Client Secret provided by Cashfree.
"qwer9876"
Body
Details of the customer.
Show child attributes
Show child attributes
Email of the customer.
Phone number of the customer.
"9999999999"
Customer's bank account number.
"1234567890"
Name of the account holder.
"John Doe"
Bank code (e.g., SBIN for State Bank of India).
"SBIN"
Type of the account (e.g., SAVINGS or CURRENT).
"SAVINGS"
Details of the subscription.
Show child attributes
Show child attributes
Unique Mandate Reference Number (UMRN) of the existing mandate.
"SBIN0000000000000000"
Type of mandate (e.g., E_MANDATE).
"E_MANDATE"
Fixed amount for the subscription (if applicable).
10
Maximum amount allowed for the subscription.
100
Frequency of the subscription (e.g., MNTH for monthly Periodic subscription, ADHO for On-Demand subscription).
"MNTH"
Start date of the subscription.
"2025-03-28"
End date of the subscription.
"2025-08-04"
Maximum number of cycles for the subscription.
10
Unique ID for the subscription.
"subs-import-mandate"
Date of the first charge for the subscription (Required for periodic subscriptions).
"2025-04-03"
Response
Mandate ported successfully.
Was this page helpful?