Integrate with Turbo UPI

Steps to integrate Razorpay Turbo UPI with your app.

Available in🇮🇳 India

With Razorpay Turbo UPI, businesses experience faster and simpler payments. It condenses the payment process from 5 steps to just 1, eliminating app redirections. Enjoy a seamless in-app payment experience, reduce dependencies on third-party UPI apps, and gain complete visibility of the payment journey.

You can seamlessly integrate Turbo UPI with Razorpay iOS Standard SDK. Explore the full potential of Razorpay Turbo UPI and know How it Works.

Prerequisites

• Integrate with Razorpay iOS Standard SDK. Ensure that you integrate with SDK version 1.0.0 or higher.
• Import the following frameworks:
  • Common library/NPCI framework
  • Axis olive framework
  • Razorpay Turbo UPI framework

Watch Out!

The minimum supported iOS version for Turbo UPI is 11 and above.

Onboarding Flow

Ensure your customers onboard with Razorpay Turbo UPI to get started.

Installation

Turbo UPI wrapper plugin is available as a cocoapod, which can be integrated with any iOS application with a minimum deployment target of iOS 11 later. Add the code given below in the project’s podfile to get this cocoapod:

pod razorpay-turbo-pod

Turbo UI SDK Integration

Follow these steps to integrate with Razorpay Turbo UPI:

1. Initialise the Checkout object to enable the Turbo UPI functionality.

Swift

// The `razorpay` variable can be declared a Global Variable in the ViewController.

var razorpay: RazorpayCheckout?

self.razorpay = RazorpayCheckout.initWithKey(checkoutKey ?? "",  andDelegateWithData: self, plugin: RazorpayTurboUPI.turboUIPlugin())

2. Use the following code to link the newly created UPI account with your app. This function can be called from any application section, offering multiple entry points for customers to link their UPI account with your app. Linking it in advance allows customers to pay directly with the linked UpiAccount without repeating the linking process.

Swift

self.razorpay?.upiTurbo?.linkNewUpiAccount(mobileNumber: <customer-mobile>, color: <hex-code>, completionHandler: { response, error in
    // Handle the onboarded accounts Response
})

Payment Flow

Razorpay SDK will handle all the changes related to UpiTurbo internally. To integrate with the payment flow, pass payment option and display the checkout form.

Non-Transactional Flow

Razorpay provides a single exposed function that allows you to manage linked UPI accounts and access all non-transactional flows seamlessly.

Manage UPI Accounts

The SDK manages the linked UpiAccounts on the application by triggering manageUpiAccounts(), which follows the following internal non-transaction flows for UpiAccounts:

• Fetch balance: Check the customer’s account balance.
• Change UPI pin: Provide the customer the ability to change their UPI PIN.
• Reset UPI pin: Let your customers reset the pin for their account.
• Delete the account from the application: Let your customers delink, that is, remove a selected UPI account from your application.

Swift

self.razorpay?.upiTurbo?.manageUpiAccount(mobileNumber: <customer-mobile>, color: "<hex-code>")

Models Exposed from the SDKs

The SDKs given below provide access to exposed models for seamless integration.

TurboError

Error	Description
errorCode	Types of error codes BAD_REQUEST_ERROR: Failure from the client’s end (SDK). GATEWAY_ERROR: Failure either from the Secure Component or the Bank. SERVER_ERROR: Failure at PSP.
errorDescription	Brief description of the error.
errorReason	Specifies the specific reason for the error.
errorSource	Indicates the origin of the error. Possible values: gateway issuer_bank beneficiary_bank customer_psp customer internal
errorStep	Highlights the stage where the error occurred.

Refer to the list of possible error reasons.

Go-Live Checklist

For iOS users, outgoing device binding SMS is editable by default. To ensure these SMS messages are non-editable, you must complete the following steps:

Requesting UPI Device Validation Entitlement

Submit a Request on the Apple Developer Portal

• Log in to the Apple Developer Portal.
• Fill out the necessary details to request permission for the setUPIVerificationCodeSendCompletion API, which allows secure, non-editable content for device registration SMS.
• Await approval from Apple.

Submit Details to NPCI

Once Apple approves the entitlement, share the request details with NPCI for their approval. Use the format given below for submitting the details:

• Name of the App:
• Functionality (UPI or CBDC App): UPI
• App ID:
• Team ID:
• Request ID:
• Bundle ID:

Follow the Guidelines for Implementation

• Ensure your app supports iOS 17 and above.
• Use the setUPIVerificationCodeSendCompletion API to comply with NPCI requirements.