Swift with Node Backend

Integrate hyper SDK to your Swift App using hyperswitch-node

Use this guide to integrate Hyperswitch SDK to your iOS app. You can use the following app as a reference with your Hyperswitch credentials to test the setup. You can also checkout the app on Apple Testflight to test the payment flow.


  • iOS 12.4 and above

  • CocoaPods

  • npm

1. Setup the server

1.1 Install the hyperswitch-node library

Install the package and import it in your code

$ npm install @juspay-tech/hyperswitch-node

1.2 Create a payment

Before creating a payment, import the hyperswitch-node dependencies and initialize it with your API key.

const hyper = require("@juspay-tech/hyperwitch-node")(β€˜YOUR_API_KEY’);

Add an endpoint on your server that creates a Payment. Creating a Payment helps to establish the intent of the customer to start a payment. It also helps to track the customer’s payment lifecycle, keeping track of failed payment attempts and ensuring the customer is only charged once. Return the client_secret obtained in the response to securely complete the payment on the client.

// Create a Payment with the order amount and currency
app.post("/create-payment", async (req, res) => {
  try {
    const paymentIntent = await hyper.paymentIntents.create({
      currency: "USD",
      amount: 100,
    // Send publishable key and PaymentIntent details to client
      clientSecret: paymentIntent.client_secret,
  } catch (err) {
    return res.status(400).send({
      error: {
        message: err.message,

2. Build checkout page on your app

2.1 Configure your repository with Hyperswitch dependency

CocoaPods Setup (only required if not already done)

  1. Install the latest version of CocoaPods

  2. To create a Podfile run the following command

pod init

SDK Setup

Add these lines to your Podfile:

#target 'YourAPP' do
  pod 'HyperswitchCore'

Run the following command:

pod install

Remember that moving forward, you should open your project in Xcode using the .xcworkspace file rather than the .xcodeproj file.

To update to the latest version of the SDK, run:

pod install --repo-update

2.2 Setup the SDK and fetch a Payment

Fetch a payment by requesting your server for a payment as soon as your view is loaded. Store a reference to the client_secret returned by the server, the Payment Sheet will use this secret to complete the payment later. Setup the SDK with your publishable key.

STPAPIClient.shared.publishableKey = <YOUR_PUBLISHABLE_KEY>

Note: For Open Source Setup, initialise your custom Backend app URL as:

STPAPIClient.shared.customBackendUrl = <YOUR_SERVER_URL>

3. Complete the payment on your app

3.1 Swift

Create a PaymentSheet instance using the client_secret retrieved from the previous step. Present the payment page from your view controller and use the PaymentSheet.Configuration struct for customising your payment page.

var paymentSheet: PaymentSheet?
var paymentResult: PaymentSheetResult?

var configuration = PaymentSheet.Configuration()
configuration.merchantDisplayName = "Example, Inc."

// Present Payment Page
paymentSheet = PaymentSheet(paymentIntentClientSecret: paymentIntentClientSecret, configuration: configuration)

Handle the payment result in the completion block and display appropriate messages to your customer based on whether the payment fails with an error or succeeds.

func openPaymentSheet(_ sender: Any) { //present payment sheet
    self.paymentSheet?.present(from: self, completion: { result in
        switch result {
        case .completed:
            print("Payment complete")
        case .failed(let error):
            print("Payment failed: \(error.localizedDescription)")
        case .canceled:
            print("Payment canceled.")

4. Card Element

4.1 Swift

Create a card element view and pay button and handle the payment result in the completion block and display appropriate messages to your customer based on whether the payment fails with an error or succeeds.

//Create a card element view and pay button.
lazy var hyperCardTextField: STPPaymentCardTextField = {
    let cardTextField = STPPaymentCardTextField()
    return cardTextField

lazy var payButton: UIButton = {
    let button = UIButton(type: .custom)
    button.layer.cornerRadius = 5
    button.backgroundColor = .systemBlue
    button.setTitle("Pay", for: .normal)
    button.addTarget(self, action: #selector(pay), for: .touchUpInside)
    return button

func pay() {
  guard let paymentIntentClientSecret = model.paymentIntentClientSecret else {
  let paymentIntentParams = STPPaymentIntentParams(clientSecret: paymentIntentClientSecret)
  let paymentHandler = STPPaymentHandler.shared()

  paymentHandler.confirmPayment(paymentIntentParams, with: self)
  { (status, paymentIntent, error) in
      switch (status) {
      case .failed:
      case .canceled:
      case .succeeded:
      @unknown default:

Congratulations! Now that you have integrated the iOS SDK, you can customize the payment sheet to blend with the rest of your app.

Next step:

πŸ’³pagePayment methods setup

Last updated