Cashfree Payments Developer Documentation

curl --request POST \
  --url https://sandbox.cashfree.com/api/v2/subscriptions/seamless/subscription \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriptionId": "DemoSubscription",
  "planId": "TestPlan_ReArch_002",
  "customerName": "John",
  "customerPhone": "99999XXXXX",
  "customerEmail": "[email protected]",
  "returnUrl": "www.google.com",
  "authAmount": 1,
  "expiresOn": "2024-12-02 09:20:12",
  "firstChargeDate": "2024-12-02",
  "payerAccountDetails": {
    "accountNumber": "007200000000",
    "accountHolderName": "John",
    "bankId": "ICIC",
    "accountType": "SAVINGS",
    "ifsc": "ICIC0000072"
  },
  "notificationChannels": [
    "EMAIL",
    "SMS"
  ]
}
'

{
  "status": 200,
  "message": "Subscription Created",
  "data": {
    "subReferenceId": 107350,
    "subscriptionId": "DemoSubscription",
    "customerPhone": "9999988888",
    "customerEmail": "[email protected]",
    "planId": "TestPlan_ReArch_002",
    "status": "INITIALIZED",
    "currentCycle": 0,
    "authAmount": 1,
    "returnUrl": "www.google.com",
    "startDate": {
      "E_MANDATE": "2024-12-02",
      "UPI": "2024-12-02"
    },
    "endDate": "2024-12-02 09:20:12",
    "tpvEnabled": false,
    "paymentOptions": [
      {
        "type": "E_MANDATE",
        "accountTypes": [
          "SAVINGS",
          "CURRENT"
        ],
        "frequentBankDetails": [
          {
            "bankId": "SBIN",
            "bankName": "STATE BANK OF INDIA",
            "accountAuthModes": [
              "DEBIT_CARD",
              "NET_BANKING"
            ]
          }
        ]
      }
    ]
  }
}

POST

api

subscriptions

seamless

subscription

curl --request POST \
  --url https://sandbox.cashfree.com/api/v2/subscriptions/seamless/subscription \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriptionId": "DemoSubscription",
  "planId": "TestPlan_ReArch_002",
  "customerName": "John",
  "customerPhone": "99999XXXXX",
  "customerEmail": "[email protected]",
  "returnUrl": "www.google.com",
  "authAmount": 1,
  "expiresOn": "2024-12-02 09:20:12",
  "firstChargeDate": "2024-12-02",
  "payerAccountDetails": {
    "accountNumber": "007200000000",
    "accountHolderName": "John",
    "bankId": "ICIC",
    "accountType": "SAVINGS",
    "ifsc": "ICIC0000072"
  },
  "notificationChannels": [
    "EMAIL",
    "SMS"
  ]
}
'

{
  "status": 200,
  "message": "Subscription Created",
  "data": {
    "subReferenceId": 107350,
    "subscriptionId": "DemoSubscription",
    "customerPhone": "9999988888",
    "customerEmail": "[email protected]",
    "planId": "TestPlan_ReArch_002",
    "status": "INITIALIZED",
    "currentCycle": 0,
    "authAmount": 1,
    "returnUrl": "www.google.com",
    "startDate": {
      "E_MANDATE": "2024-12-02",
      "UPI": "2024-12-02"
    },
    "endDate": "2024-12-02 09:20:12",
    "tpvEnabled": false,
    "paymentOptions": [
      {
        "type": "E_MANDATE",
        "accountTypes": [
          "SAVINGS",
          "CURRENT"
        ],
        "frequentBankDetails": [
          {
            "bankId": "SBIN",
            "bankName": "STATE BANK OF INDIA",
            "accountAuthModes": [
              "DEBIT_CARD",
              "NET_BANKING"
            ]
          }
        ]
      }
    ]
  }
}

Headers

x-client-id

string

Example:

"{{X-Client-Id}}"

x-client-secret

string

Example:

"{{X-Client-Secret}}"

Body

application/json

subscriptionId

string

Unique identifier for the subscription.

Example:

"DemoSubscription"

planId

string

Unique identifier for the subscription plan.

Example:

"TestPlan_ReArch_002"

customerName

string

Name of the customer subscribing.

Example:

"John"

customerPhone

string

Customer's phone number.

Example:

"99999XXXXX"

customerEmail

string

Customer's email address.

Example:

"[email protected]"

returnUrl

string

URL to redirect the user after successful subscription.

Example:

"www.google.com"

authAmount

number

Authorization amount for the subscription.

Example:

1

expiresOn

string

Expiration date for the subscription.

Example:

"2024-12-02 09:20:12"

firstChargeDate

string

First charge date for the subscription.

Example:

"2024-12-02"

payerAccountDetails

object

Show child attributes

payerAccountDetails.accountNumber

string

Customer's account number.

Example:

"007200000000"

payerAccountDetails.accountHolderName

string

Name of the account holder.

Example:

"John"

payerAccountDetails.bankId

string

Bank identifier.

Example:

"ICIC"

payerAccountDetails.accountType

string

Type of the bank account.

Example:

"SAVINGS"

payerAccountDetails.ifsc

string

IFSC code of the bank.

Example:

"ICIC0000072"

notificationChannels

string[]

Notification channels for subscription.

Example:

["EMAIL", "SMS"]

tpvEnabled

boolean

Whether Third Party Verification (TPV) is enabled.

Example:

true

splitDetails

object

Show child attributes

splitDetails.scheme

object[]

Show child attributes

splitDetails.scheme.merchantVendorId

string

Vendor ID for split payments.

Example:

"test-vendor-1"

splitDetails.scheme.percentage

number

Percentage of split payment.

Example:

10

Response

Successful subscription creation.

status

integer

Status code of the response.

Example:

200

message

string

Status message.

Example:

"Subscription Created"

data

object

Show child attributes

data.subReferenceId

integer

Subscription reference ID.

Example:

107350

data.subscriptionId

string

Unique identifier for the created subscription.

Example:

"DemoSubscription"

data.customerPhone

string

Customer's phone number.

Example:

"9999988888"

data.customerEmail

string

Customer's email address.

Example:

"[email protected]"

data.planId

string

Unique identifier for the subscription plan.

Example:

"TestPlan_ReArch_002"

data.status

string

Current status of the subscription.

Example:

"INITIALIZED"

data.currentCycle

integer

Current subscription cycle.

Example:

0

data.authAmount

number

Authorization amount for the subscription.

Example:

1

data.returnUrl

string

URL to redirect the user after successful subscription.

Example:

"www.google.com"

data.startDate

object

Show child attributes

data.startDate.E_MANDATE

string

Start date for E_MANDATE payment type.

Example:

"2024-12-02"

data.startDate.UPI

string

Start date for UPI payment type.

Example:

"2024-12-02"

data.endDate

string

Expiration date for the subscription.

Example:

"2024-12-02 09:20:12"

data.tpvEnabled

boolean

Indicates if TPV is enabled.

Example:

false

data.paymentOptions

object[]

Show child attributes

data.paymentOptions.type

string

Type of payment option.

Example:

"E_MANDATE"

data.paymentOptions.accountTypes

string[]

Available account types for the payment option.

Example:

["SAVINGS", "CURRENT"]

data.paymentOptions.frequentBankDetails

object[]

Show child attributes

data.paymentOptions.frequentBankDetails.bankId

string

Bank identifier.

Example:

"SBIN"

data.paymentOptions.frequentBankDetails.bankName

string

Name of the bank.

Example:

"STATE BANK OF INDIA"

data.paymentOptions.frequentBankDetails.accountAuthModes

string[]

Authorization modes for the bank.

Example:

["DEBIT_CARD", "NET_BANKING"]

Physical Mandates Create Authorization Request

⌘I

Payments API

v2025-01-01

Other Versions

Create Seamless Subscription with Plan ID

Headers

Body

Response