Integrate with Turbo UPI

​

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

​

Onboarding Flow

​

Installation

pod razorpay-turbo-pod

​

Turbo UI SDK Integration

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())
   
   ```objectivec: Objective C
   razorpay = [RazorpayCheckout initWithKey:@"Your_Key_ID" andDelegate: self withPaymentWebView: webView 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: , color: , completionHandler: { response, error in
       // Handle the onboarded accounts Response
   })
   
   ```objectivec: Objective C
   [razorpay.upiTurbo linkNewUpiAccountWithMobileNumber:@"919000000000" color:@"0xFF1234" completionHandler:^(id _Nullable upiAccounts, NSError * _Nullable error) {
   }];
   

​

Non-Transactional Flow

​

Manage UPI Accounts

• 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.

self.razorpay?.upiTurbo?.manageUpiAccount(mobileNumber: , color: "")

```objectivec: Objective C
[razorpay.upiTurbo manageUpiAccountWithMobileNumber:@"919000000000" color:@"0xFF1234"];

​

Models Exposed from the SDKs

​

TurboError

​

Error | Description

• 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

​

Requesting UPI Device Validation Entitlement

​

1. 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.

​

2. Submit Details to NPCI

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

​

3. Follow the Guidelines for Implementation

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