Deep linking from your iOS mobile app

You can use deep linking to navigate users from your mobile app to payment screens in the AffiniPay, CPACharge, or LawPay mobile app (the target app). Using these payment screens and an optional AffiniPay card reader or manual entry, your users submit card payment information securely in the target app and then return seamlessly to your mobile app. Your backend system then submits the charge.

To take advantage of deep linking:

• You must have an AffiniPay payment integration. You’ll use the credentials you obtained during the OAuth process to submit payment information on behalf of your users, who are AffiniPay merchants.
• Your users must have both your mobile app and the target app installed.

Obtain the payment token

1: Set a scheme name to identify your mobile app

To set a scheme name for your mobile app:

1. In Xcode, select your mobile app project in the sidebar.
2. Click the Info** tab.
3. In the URL Types** section, add a URL type and set the identifier and the URL scheme. In the following examples, partnerapp is the scheme name.

2: Create a deep link URL with payment details

You must create the URL that will initiate the deep linking process from your mobile app. Here is an example URL:

ioslawpay://charge?amount=100&publicKey=m_Nz_JZ1wDEoSP7uRTQnIqY&accountName=Operating&demoMode=1&disableCardReader=0&requireCvv=0&requireSwipeCvv=1&trustAccount=0&&requiredPaymentFields=cvv,address1,postal_code&swipeRequiredPaymentFields=cvv,address1,postal_code&continue=partnerapp://

The deep link URL starts with the scheme name for the target app. In this example, ioslawpay is the scheme name and it provides a deep link to the LawPay app.

• To deep link to the AffiniPay app, use iosaffinipay.
• To deep link to the CPACharge app, use ioscpacharge.

You must include the required parameters publicKey and continue in the deep link URL.

Required parameters

Optional parameters

3: Send the payment token request to the target app

To send the payment request (including the deep link URL) to the target app:

1. Add the following lines of code to ViewController.swift.

   @IBAction func openapp(_ sender: UIButton) {
        let originalUrlString = "ioslawpay://charge?amount=100&publicKey=m_Nz_JZ1wDEoSP7uRTQnIqY&accountName=Operating&demoMode=1&disableCardReader=0&requireCvv=0&requireSwipeCvv=1&trustAccount=0&&requiredPaymentFields=cvv,address1,postal_code&swipeRequiredPaymentFields=cvv,address1,postal_code&continue=partnerapp://"
        let urlString = originalUrlString.replacingOccurrences(of: "", with: "%20")
        let customURL = URL(string: urlString)
        if UIApplication.shared.canOpenURL(customURL!) {
              if #available(iOS 10.0, *) {
                  UIApplication.shared.open(customURL!, options: [:], completionHandler: nil)
              } else {
                  UIApplication.shared.openURL(customURL!)
              }
          } else {
                //Print alert here
          }
    }

   Copy

2. Add the following lines of code to AppDelegate.swift.

   func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {​​​​​​​​
     if (options[UIApplication.OpenURLOptionsKey.sourceApplication] as! String == "com.affinipay.IOSLawPay") {​​​​​​​​
      handleResponseFromLawPay(url: url)
     }​​​​​​​​
     return true
   }​​​​​​​​

   Copy

4: Parse the response

After the payment details are processed, the target app returns the following parameters:

Add the following code to AppDelegate.swift to parse this data.

func handleResponseFromLawPay(url: URL) {​​​​​​​​
    let queryParams = url.queryParameters
    print("query params: ", queryParams!)
    if queryParams!["success"] == "true" {​​​​​​​​
          showSuccessAlert(oneTimeToken: queryParams!["oneTimeToken"]!)
    }​​​​​​​​
    else if queryParams!["success"] == "true" {​​​​​​​​
          if (queryParams!["reason"] != nil) {​​​​​​​​
              showFailedAlert(errorMessage: queryParams!["reason"]!)
          }​​​​​​​​ else {​​​​​​​​
              showFailedAlert(errorMessage: "Unknown error. Please try again.")
          }​​​​​​​​
    }​​​​​​​​
}​​​​​​​​

func showSuccessAlert(oneTimeToken: String) {​​​​​​​​
    let alert = UIAlertController(title: "Success", message: "One-time-token generated : " + oneTimeToken, preferredStyle: .alert)
    alert.addAction(UIAlertAction(
        title: "Ok",
        style: .cancel,
        handler: {​​​​​​​​ (action) in }​​​​​​​​
    ))
    window?.rootViewController?.present(alert, animated: true, completion: nil)
}​​​​​​​​

func showFailedAlert(errorMessage: String) {​​​​​​​​
    let alert = UIAlertController(title: "Error", message: errorMessage, preferredStyle: .alert)
    alert.addAction(UIAlertAction(
        title: "Ok",
        style: .cancel,
        handler: {​​​​​​​​ (action) in }​​​​​​​​
    ))
    window?.rootViewController?.present(alert, animated: true, completion: nil)
}​​​​​​​​

Copy

Submit the charge

To submit the charge:

1. Hand off the payment token and payment details to your backend server, which is already integrated with AffiniPay.
2. Create a charge from your backend server.