iOS Subscription Element Integration

The Cashfree subscription element SDK lets you build a fully custom subscription payment experience within your iOS application. Unlike the hosted checkout, you collect payment details directly in your own UI and pass them to the SDK, giving you complete control over the appearance and behaviour of your payment flow. The SDK supports three payment methods for subscriptions: card, UPI, and eNach (electronic National Automated Clearing House, also known as net banking).

Prerequisites

Complete the following tasks before you start the integration:

Create a Cashfree Merchant Account.
Log in to the Merchant Dashboard and generate an App ID and Secret Key. Learn how to generate API keys.
Use Cashfree iOS SDK version 2.4.0 or above.
Set your application’s minimum deployment target to iOS 13.0 or higher.

The integration consists of three steps:

Step 1

Create a subscription

Step 2

Open the payment page

Step 3

Confirm the payment

Step 1: Create a subscription Server-side

Create a subscription from your backend server before you process any payment.

This API requires your secret key. Create subscriptions through your server only. Do not call this API directly from your mobile application.

After the subscription is created, your backend receives a subscription_id and a subscription_session_id. Pass both values to your iOS client to proceed with the payment.

API request for creating a subscription

The following example shows how to create a subscription using the Create Subscription API:

curl --request POST \
  --url https://sandbox.cashfree.com/pg/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: 2025-01-01' \
  --header 'x-client-id: <your-client-id>' \
  --header 'x-client-secret: <your-client-secret>' \
  --data '{
    "subscription_id": "Demo_Subscription",
    "customer_details": {
      "customer_name": "john",
      "customer_email": "john@dummy.com",
      "customer_phone": "9908730221",
      "customer_bank_account_number": "59108290701802",
      "customer_bank_ifsc": "HDFC0002614",
      "customer_bank_code": "HDFC",
      "customer_bank_account_type": "SAVINGS"
    },
    "plan_details": {
      "plan_name": "plan12345",
      "plan_type": "PERIODIC",
      "plan_amount": 10,
      "plan_max_amount": 100,
      "plan_max_cycles": 100,
      "plan_intervals": 2,
      "plan_currency": "INR",
      "plan_interval_type": "WEEK",
      "plan_note": "Bi-weekly INR 10 plan"
    },
    "authorization_details": {
      "authorization_amount": 100,
      "authorization_amount_refund": true,
      "payment_methods": [
        "enach",
        "upi",
        "card"
      ]
    },
    "subscription_meta": {
      "return_url": "https://example.com/subscription/return",
      "notification_channel": [
        "EMAIL",
        "SMS"
      ],
      "session_id_expiry": "2025-06-01T23:00:08+05:30"
    },
    "subscription_expiry_time": "2100-01-01T23:00:08+05:30",
    "subscription_first_charge_time": "2025-06-01T23:00:08+05:30",
    "subscription_tags": {
      "psp_note": "Monthly subscription payment"
    }
  }'

// Creating a subscription using the Cashfree Node SDK
// https://github.com/cashfree/cashfree-pg-sdk-nodejs

// Creating a subscription using the Cashfree Java SDK
// https://github.com/cashfree/cashfree-pg-sdk-java

// Creating a subscription using the Cashfree Go SDK
// https://github.com/cashfree/cashfree-pg

// Creating a subscription using the Cashfree .NET SDK
// https://github.com/cashfree/cashfree-pg-sdk-dotnet

// Creating a subscription using the Cashfree Python SDK
// https://github.com/cashfree/cashfree-pg-sdk-python

// Creating a subscription using the Cashfree PHP SDK
// https://github.com/cashfree/cashfree-pg-sdk-php

A successful response returns the subscription_id and subscription_session_id. Use these values to build the CFSubscriptionSession object in Step 2. The API returns the following response on success:

{
  "subscription_id": "Demo_Subscription",
  "subscription_session_id": "subs_token_tc9JCN4MzUIJ",
  "subscription_status": "INITIALIZED",
  "cf_subscription_id": "4"
}

For the full list of request parameters and response fields, see the Create Subscription API.

Step 2: Open the payment page Client-side

After you create the subscription, open the payment page so the customer can provide payment details.

1. Set up the SDK

The Cashfree iOS SDK is available on CocoaPods. The latest integration version is 2.4.0. The SDK requires iOS 13.0 or higher. You can also integrate via Swift Package Manager (SPM) or a manual framework. See the iOS SDK on GitHub for those options. Add the following to your Podfile:

platform :ios, '13.0'

target 'YourAppTarget' do
  use_frameworks!
  pod 'CashfreePG', '2.4.0'
end

Run pod install to install the dependency.

2. Select a payment method

The Subscription Element SDK supports the following payment methods:

Card
UPI
eNach (net banking)

In this flow, the customer enters their card details directly in your application UI. The SDK securely processes the card payment and initiates the subscription mandate. Use .setChannel("link") on the card builder for the standard link-based card flow.

In this flow, the SDK uses the UPI ID you provide to launch the customer’s UPI app and authorise the subscription mandate. Pass a UPI app URI scheme (for example, tez://) in .setUPIID().

3. Complete the payment

To complete the payment, follow these steps:

Create a CFSubscriptionSession object.
Create the payment object for the selected payment method.
Set up the payment callback.
Initiate the payment using doSubsPayment().

Create a session

The CFSubscriptionSession object holds the session context for the payment. It accepts the subscription_session_id and subscription_id obtained from Step 1, and the Cashfree environment (.SANDBOX or .PRODUCTION). Set the environment to .SANDBOX for testing or .PRODUCTION for live payments. The following example shows how to create the session object:

let subsSession = try CFSubscriptionSession.CFSubscriptionSessionBuilder()
    .setSubscriptionId(subscriptionId)
    .setSubscriptionSessionId(subscriptionSessionId)
    .setEnvironment(.SANDBOX) // or .PRODUCTION
    .build()

Create a payment object

The SDK provides a dedicated payment builder for each supported payment method. Build only the object that corresponds to the payment method your customer has selected.

Card
UPI
eNach (net banking)

Use the following builders to create a card payment object. Collect card details securely from user input. Do not hardcode values in production.

let subsCard = try CFCardSubs.CFCardSubsBuilder()
    .setChannel("link")
    .setCardNumber(cardNumber)
    .setCardExpiryMonth(expiryMonth)
    .setCardExpiryYear(expiryYear)
    .setCardHolderName(cardHolderName)
    .setCVV(cvv)
    .build()

let subsCardPayment = try CFCardSubsPayment.CFCardPaymentSubsBuilder()
    .setCard(subsCard)
    .setSession(subsSession)
    .build()

For non-PCI merchants who must not handle raw card numbers, use CFSubsCardComponent instead of .setCardNumber(). See iOS Custom Card Component.

The setUPIID field accepts the UPI app URI scheme used to launch the customer’s UPI application (for example, tez:// for Google Pay).

let subsUpi = try CFUPISubs.CFUPISubsBuilder()
    .setUPIID(upiId)
    .build()

let subsUpiPayment = try CFUPISubsPayment.CFUPIPaymentSubsBuilder()
    .setUPI(subsUpi)
    .setSession(subsSession)
    .build()

The setAuthMode field specifies how the customer authorises the mandate. The following values are accepted:

Value	Description
`aadhaar`	The customer authorises the mandate using their Aadhaar number and OTP.
`debit`	The customer authorises the mandate using their debit card details.
`net_banking`	The customer authorises the mandate by logging into their net banking portal.

The following example shows how to build the net banking payment object:

let subsNetBanking = try CFNetBankingSubs.CFNetbankingSubsBuilder()
    .setBankAccountCode(bankCode)
    .setAccountHolderName(accountHolderName)
    .setAccountNumber(accountNumber)
    .setAccountType(accountType) // SAVINGS or CURRENT
    .setAuthMode("net_banking") // aadhaar, debit, net_banking
    .build()

let subsNBPayment = try CFNetbankingSubsPayment.CFNetbankingSubsPaymentBuilder()
    .setNetbanking(subsNetBanking)
    .setSession(subsSession)
    .build()

Set up the payment callback

The SDK exposes the CFResponseDelegate protocol to receive callbacks when the subscription payment journey ends. This protocol consists of two methods:

func onError(_ error: CFErrorResponse, order_id: String)
func verifyPayment(order_id: String)

Register the callback on CFPaymentGatewayService before you call doSubsPayment. Set paymentService.setCallback(self) in your view controller before initiating payment.

The following example shows how to implement the callback:

class ViewController: UIViewController, CFResponseDelegate {

    func onError(_ error: CFErrorResponse, order_id: String) {
        print(error.message ?? "")
        // Handle payment failure. Inspect error for details.
    }

    func verifyPayment(order_id: String) {
        print(order_id)
        // Verify subscription status from your backend before proceeding.
    }
}

Backend verification is mandatory. The SDK signals that the payment UI flow ended, not that payment succeeded. Always verify payment status from your backend before presenting success.

Initiate the payment

Call doSubsPayment() when the customer taps the pay button. The following example uses subsNBPayment. Replace it with subsCardPayment or subsUpiPayment for your selected payment method. The following code registers the callback and initiates the subscription payment:

let paymentService = CFPaymentGatewayService.getInstance()
paymentService.setCallback(self)

do {
    try paymentService.doSubsPayment(subsNBPayment, viewController: self)
} catch {
    print(error.localizedDescription)
}

Sample code

The following example shows a complete card payment flow, including session creation, payment object setup, callback registration, and payment initiation.

Card payment sample

The following method demonstrates a complete card payment integration:

do {
    let subsSession = try CFSubscriptionSession.CFSubscriptionSessionBuilder()
        .setSubscriptionId(subscriptionId)
        .setSubscriptionSessionId(subscriptionSessionId)
        .setEnvironment(.SANDBOX) // or .PRODUCTION
        .build()

    let subsCard = try CFCardSubs.CFCardSubsBuilder()
        .setChannel("link")
        .setCardNumber(cardNumber)
        .setCardExpiryMonth(expiryMonth)
        .setCardExpiryYear(expiryYear)
        .setCardHolderName(cardHolderName)
        .setCVV(cvv)
        .build()

    let subsCardPayment = try CFCardSubsPayment.CFCardPaymentSubsBuilder()
        .setCard(subsCard)
        .setSession(subsSession)
        .build()

    let paymentService = CFPaymentGatewayService.getInstance()
    paymentService.setCallback(self)
    try paymentService.doSubsPayment(subsCardPayment, viewController: self)

} catch {
    print(error.localizedDescription)
}

Refer to the sample integration on GitHub for a working end-to-end implementation.

iOS Subscription Element integration

iOS SDK on GitHub

Step 3: Confirm the payment Server-side

After the SDK delivers a callback via verifyPayment, confirm the payment status from your backend before taking any action. The SDK callback signals only that the payment flow has ended. It does not guarantee a successful payment. Use the Fetch Details of All Payments of a Subscription API to retrieve the current payment status.

API request for fetching subscription payments

The following request fetches all payments for a subscription:

curl --request GET \
  --url https://api.cashfree.com/pg/subscriptions/{subscription_id}/payments \
  --header 'x-api-version: 2025-01-01' \
  --header 'x-client-id: <your-client-id>' \
  --header 'x-client-secret: <your-client-secret>'

A successful response returns an array of payment objects. Check the payment_status field to determine the outcome. The API returns the following response on success:

[
  {
    "cf_payment_id": "123456",
    "cf_subscription_id": "7891011",
    "payment_id": "your-payment-id",
    "payment_amount": 1,
    "payment_status": "SUCCESS",
    "payment_type": "AUTH",
    "payment_initiated_date": "2025-06-01T22:14:58+0530",
    "subscription_id": "your-subscription-id",
    "retry_attempts": 0,
    "failure_details": {
      "failure_reason": ""
    }
  }
]

Always verify the subscription status from your backend before delivering goods or services to the customer. Proceed only when payment_status is SUCCESS.

Error codes

If a required field or object is missing when you initiate payment, the SDK returns an error through the catch block or onError callback. The following table lists common SDK-level validation errors and when they occur.

Show error codes

The SDK validation errors are grouped by category as follows:

Session errors

These errors occur when the CFSubscriptionSession object or its required fields are not provided.

Error code	Message	Description
`SUBSCRIPTION_SESSION_OBJECT_MISSING`	The “CFSubscriptionSession” is missing in the request.	The `CFSubscriptionSession` object was not passed to the payment builder.
`SUBSCRIPTION_SESSION_ID_MISSING`	The “subscription_session_id” is missing in the request.	The `subscription_session_id` was not set on the `CFSubscriptionSession` builder.
`SUBSCRIPTION_ID_MISSING`	The “subscription_id” is missing in the request.	The `subscription_id` was not set on the `CFSubscriptionSession` builder.
`ENVIRONMENT_MISSING`	The “environment” is missing in the request.	The Cashfree environment (`.SANDBOX` or `.PRODUCTION`) was not set on the `CFSubscriptionSession` builder.

Payment method object errors

These errors occur when a payment method object is absent or one of its required fields is not set.

Error code	Message	Description
`SUBSCRIPTION_CARD_OBJECT_MISSING`	The “CFCardSubs” object is missing in the request.	The `CFCardSubs` object was not passed to the `CFCardSubsPayment` builder.
`SUBSCRIPTION_NB_OBJECT_MISSING`	The “CFNetBankingSubs” object is missing in the request.	The `CFNetBankingSubs` object was not passed to the `CFNetbankingSubsPayment` builder.
`SUBSCRIPTION_UPI_OBJECT_MISSING`	The “CFUPISubs” object is missing in the request.	The `CFUPISubs` object was not passed to the `CFUPISubsPayment` builder.
`SUBSCRIPTION_NB_ACCOUNT_HOLDER_NAME_MISSING`	The “account holder name” is missing in the request.	The `setAccountHolderName` field was not set on the `CFNetBankingSubs` builder.
`SUBSCRIPTION_NB_ACCOUNT_NUMBER_MISSING`	The “account number” is missing in the request.	The `setAccountNumber` field was not set on the `CFNetBankingSubs` builder.
`SUBSCRIPTION_NB_BANK_CODE_MISSING`	The “bank code” is missing in the request.	The `setBankAccountCode` field was not set on the `CFNetBankingSubs` builder.
`SUBSCRIPTION_NB_ACCOUNT_TYPE_MISSING`	The “account type” is missing in the request.	The `setAccountType` field was not set on the `CFNetBankingSubs` builder.
`SUBSCRIPTION_NB_AUTH_MODE_MISSING`	The “auth mode” is missing in the request.	The `setAuthMode` field was not set on the `CFNetBankingSubs` builder.

Callback errors

These errors occur when the payment callback is not registered before initiating payment.

Error code	Message	Description
`CALLBACK_MISSING`	The “callback” cannot be null.	`setCallback` was not called on `CFPaymentGatewayService` before `doSubsPayment()`. Register the callback before you initiate payment.

Other options

The following optional configurations let you customise the payment screen behaviour.

(Optional) Enable full-screen payment

To present the payment flow in full screen, call setFullScreen(true) on the payment object before you call doSubsPayment():

subsCardPayment.setFullScreen(true)
// or: subsUpiPayment.setFullScreen(true)

Payments

Payment Gateway

Checkout

International Payments

Flowwise

RiskShield

Subscription

Other Products

Developer updates

iOS Subscription Integration

Prerequisites

Step 1

Step 2

Step 3

Step 1: Create a subscription Server-side

Step 2: Open the payment page Client-side

1. Set up the SDK

2. Select a payment method

3. Complete the payment

Create a session

Create a payment object

Set up the payment callback

Initiate the payment

Sample code

Step 3: Confirm the payment Server-side

Error codes

Session errors

Payment method object errors

Callback errors

Other options

​Prerequisites

Step 1

Step 2

Step 3

​Step 1: Create a subscription Server-side

​Step 2: Open the payment page Client-side

​1. Set up the SDK

​2. Select a payment method

​3. Complete the payment

​Create a session

​Create a payment object

​Set up the payment callback

​Initiate the payment

​Sample code

​Step 3: Confirm the payment Server-side

​Error codes

​Session errors

​Payment method object errors

​Callback errors

​Other options

Prerequisites

Step 1: Create a subscription Server-side

Step 2: Open the payment page Client-side

1. Set up the SDK

2. Select a payment method

3. Complete the payment

Create a session

Create a payment object

Set up the payment callback

Initiate the payment

Sample code

Step 3: Confirm the payment Server-side

Error codes

Session errors

Payment method object errors

Callback errors

Other options