Getting Started

GoPayEnterprise SDK — Client Integration Guide

This guide provides step-by-step instructions for integrating the GoPayEnterprise SDK into your iOS application.

Distribution Package

The SDK is distributed as two files. Both must be placed in the same directory in your project:

YourProject/
├── GoPayEnterprise.podspec
└── GoPayEnterprise_{VERSION}.tar.gz

The tar.gz expands to:

Frameworks/
├── GoPayEnterprise.xcframework        (static)
├── GoPayWebkitEnterprise.xcframework  (static)
├── DigitalIdentity.xcframework        (static)
├── GoToPin.xcframework                (static)
└── Ojo.xcframework                    (dynamic)
Resources/
├── GoPayEnterpriseResources.bundle
├── GoPayWebkitEnterpriseResources.bundle
├── GoToPinResources.bundle
└── DigitalIdentityResources.bundle

CocoaPods extracts and links these automatically — you do not need to unzip manually.


Requirements

RequirementMinimum
iOS14.0
Xcode16.0
Swift5.0
CocoaPodsLatest

Installation

1. Place SDK files

Copy both GoPayEnterprise.podspec and GoPayEnterprise_{VERSION}.tar.gz into your project directory (alongside your Podfile), where {VERSION} is the version number provided with the SDK distribution.

2. Configure Podfile

platform :ios, '14.0'

source 'https://cdn.cocoapods.org/'

target 'YourApp' do
  use_frameworks!

  pod 'GoPayEnterprise', :podspec => './GoPayEnterprise.podspec'
end

post_install do |installer|
  installer.generated_projects.each do |project|
    project.targets.each do |target|
      target.build_configurations.each do |config|
        config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
      end
    end
  end

  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
    end
  end
end

The post_install hook is required. It ensures all pods and generated projects are built with BUILD_LIBRARY_FOR_DISTRIBUTION enabled. Without it, you may see compiler or linker errors from transitive dependencies.

3. Install

pod install

4. Open workspace

open YourApp.xcworkspace

CocoaPods will automatically:

  • Extract and link all XCFrameworks
  • Copy all resource bundles into your app
  • Resolve and install all declared dependencies

CocoaPods Dependencies

The podspec declares all required dependencies. CocoaPods resolves them automatically.

DependencyVersion
SwiftProtobuf~> 1.30.0
SSZipArchive~> 2.4.3
GRDB.swift~> 6.7.0
Starscream4.0.5
ReachabilitySwift>= 5.0.0
RxSwift>= 6.9.0
Clickstream= 2.0.49
CourierCore= 1.0.2
CourierMQTT= 1.0.2
MQTTClientGJ= 1.0.2

Required Permissions

Add these entries to your Info.plist:

<key>NSCameraUsageDescription</key>
<string>Camera access is required for identity verification</string>

Update LSApplicationQueriesSchemes in Info.plist

  • LSApplicationQueriesSchemes: For security purposes, we need to add the following JB app-related schemes in the LSApplicationQueriesSchemes key:
    • zbra
    • cydia
    • undecimus
    • sileo
    • filza