iOS PG SDK Integration (Standard)

The steps to integrate iOS PG SDK on the native iOS App.
1. PreRequisites
2. iOS PG SDK setup
3. iOS PG App Side Implementation
4. iOS PG Server Side Implementation

1. PreRequisites

  1. XCode 12.5 or newer
  2. Cocoapod
  3. Onboarded on PhonePe as a Merchant (Given a MerchantID, & Saltkeys to generate the checksum on your servers)
  4. PhonePeAppId (Pass AppId if received from the PhonePe team. Otherwise, pass nil)

2. iOS PG SDK setup

The PhonePePayment framework is needed for the SDK to work for both Sandbox (Testing) and Production (Deployment) environments.

Latest Phonepe iOS SDK Version: 2.7.3

Step 2. Installation

To install it, simply add the following line to your Podfile:

pod 'PhonePePayment'

then run

pod install
Step 3. Import the framework in your project using
import PhonePePayment

3. iOS PG App Side Implementation

Step 1. Update PhonePe App Id

If merchants have received the AppId from the PhonePe team, then pass the value in the init method using the key: appId [Refer to Step 3]. Otherwise, you can just pass nil.

Create a URLType for your app (Deeplink), if not already present.
For example, we have used: iOSIntentIntegration. (You can create your own identifier for your app)

URLScheme should match the below conditions

  • Only Alphabets (lower and upper case) and numbers are allowed.
  • We can allow special characters only like dot and Hyphen
  • The name should always start with alphabets.

The schema should be correct to redirect the app otherwise it will not redirect back to the merchant app.

Step 3. Create DPSTransactionRequest Object

Using the Payload from your server, create a DPSTransactionRequest object.

Step 4. Initialize the PG SDK

Initialize the PPPayment and pass the DPSTransactionRequest object to the SDK. After the payment is complete and a callback is received back to your app on the completionHandler, check the status of the transaction with your backend.

let headers: [String: String] = [:]
let phonePeAppId = nil

let request : DPSTransactionRequest = DPSTransactionRequest (
    body : base64EncodedString,
    apiEndPoint : apiEndPoint,
    checksum : payloadChecksum,
    headers : headers,
    appSchema : null

//Warning: phonePeAppId is optional, if you have received it from the PhonePe team, kindly pass it within the method. Otherwise, pass it as 'nil'

PPPayment(environment: .sandbox, enableLogging: true, appId: phonePeAppId)
            .startPG(transactionRequest: request, on: self, animated: true) 
{ _, result in
	let text = "\(result)"
	// Indicates the UI Callback is given back to the Merchant app. 
	//Now, check the status with your server and update it to the user accordingly

To Enable Debug Logs

Update the PPPayment.enableDebugLogs = true or enableLogging flag to true in startPG method.

Step 5. Setup the Environment

Set the environment as .sandbox to test in the UAT Simulator environment. While moving to Production, set the environment as .production.

4. iOS PG Server Side Implementation

Step 1. Save the below-assigned value on your server
String apiEndPoint = "/pg/v1/pay";
Step 2. Construct the request body and encode it in Base 64 at your server as follows:
  "merchantId": "MERCHANTUAT",
  "merchantTransactionId": "MT7850590068188104",
  "merchantUserId": "MUID123",
  "amount": 10000,
  "callbackUrl": "",
  "mobileNumber": "9999999999",
  "paymentInstrument": {
    "type": "PAY_PAGE"
  "request": "ewoibWVyY2hhbnRJZCI6ICJNRVJDSEFOVFVBVCIsCiJtZXJjaGFudFRyYW5zYWN0aW9uSWQiOiAiTVQ3ODUwNTkwMDY4MTg4MTA0IiwKIm1lcmNoYW50VXNlcklkIjogIk1VSUQxMjMiLAoiYW1vdW50IjogMTAwMDAsCiJjYWxsYmFja1VybCI6ICJodHRwczovL3dlYmhvb2suc2l0ZS9jYWxsYmFjay11cmwiLAoibW9iaWxlTnVtYmVyIjogIjk5OTk5OTk5OTkiLAoicGF5bWVudEluc3RydW1lbnQiOiB7CiJ0eXBlIjogIlBBWV9QQUdFIgp9Cn0="
Step 3. Checksum Calculation

Select one of the salts shared with you and note its index. Construct the X-verify at your server as follows:

String checksum = sha256(base64Body + apiEndPoint + salt) + ### + saltIndex;
Step 4. Check the payment status

Once the payment is completed, please call the Check Transaction Status API to validate the response received via the App. You can call the Check Transaction Status at regular intervals to fetch the response from the PhonePe server in case a response is not received in the application even after 10 minutes of initiating the application.

Step 5. Handling Payment Status

The payment status can be Successful, Failed, Pending or any of the codes. For Pending, you should retry until the status changes to Successful or Failed.