iOS SDK интерфейс

source 'https://gitlab.services.mts.ru/mobile-sdk/ios/podspecs'

pod 'MTSPaySDK' ~> 6.0

pod "MTSPaySDK/Core" ~> 6.0

pod "MTSPaySDK", :git => "https://gitlab.services.mts.ru/mobile-sdk/ios/paymentsdk"

gem install cocoapods-art
pod repo-art add mts-artifactory-api-pods-ios-sdk-mtspay-cocoapods-local https://artifactory.mts.ru/artifactory/api/pods/ios-sdk-mtspay-cocoapods-local

plugin "cocoapods-art", :sources => [
  "mts-artifactory-api-pods-ios-sdk-mtspay-cocoapods-local"
]

let configuration = MTSPayConfiguration(
    authorization: .authorized(ssoTokenId: "ssoTokenId"),
    environment: .production,
    applePay: .enabled(merchantId: "Apple Pay Merchant Id"),
    darkMode: .automatic,
    merchantCapabilities: [.canOpenSupport, .canOpenAutoPayments, .canOpenLewisCard],
    appReturnUrl: "paysdk://appReturn"
)
 
     
let mtsPay = MTSPay(configuration: configuration)

enum Authorization {
    /// Пользователь не авторизован.
    ///
    /// Оплата производится в неавторизованной зоне.
    /// Привязанные платежные инструменты недостпуны
    case unauthorized
 
    /// Пользователь авторизован
    ///
    /// Доступны привязанные платежные инструменты
    ///
    /// - Parameter ssoTokenId: id токен
    case authorized(ssoTokenId: String)
 
    /// Отложенная авторизация
    ///
    /// Токен будет запрошен во время работы сценария оплаты
    ///
    /// - Parameter AsyncAuthProvider: провайдер токена
    case asyncAuth(AsyncAuthProvider)
}

enum Environment {
    /// Боевой стенд (прод)
    case production
 
    /// Тестовый стенд
    case stage
 
    /// Кастомный стенд (для разработки)
    case dev(publicUrl: URL)
}

enum ApplePay {
    case enabled(merchantId: String)
    case disabled
}

enum DarkMode {
    case automatic
    case dark
    case light
}

enum BottomSheetStyle {
        /// Динамическая высота. Подстраивается под размер контента
        case `dynamic`

        /// Фиксированная высота. Высота до `safeArea.top`
        case top

        /// Полноэкранное представление
        case fullscreen
} 

/// Обработчик задержки перед открытием приложения банка
///
/// Для Моего МТС для разблокировки траффика
protocol SbpDelayHandler {
   func handleDelay(completion: () -> Void)
} 

struct MerchantCapabilities: OptionSet {
    /// Интегратор может открыть страницу автоплатежей пользователя
    ///
    /// Влияет на чьей стороне будет обработка нажатия на кнопку "К моим автоплатежам"
    public static let canOpenAutoPayments = MerchantCapabilities(rawValue: 1 << 0)
 
    /// Интегратор может открыть страницу поддержки
    ///
    /// Влияет на чьей стороне будет обработка нажатия на кнопку "Обратиться в поддержку"
    public static let canOpenSupport = MerchantCapabilities(rawValue: 1 << 1)
 
    /// Интегратор может открыть функционал выпуска карты МТС Деньги (Льюис)
    ///
    /// Влияет на отображение баннера выпуска карты МТС Деньги (Льюис)
    public static let canOpenLewisCard = MerchantCapabilities(rawValue: 1 << 2)
}

/// Предвыбранный платежный инструмент
public struct PreSelectedPaymentTool {

    /// Тип платежного инструмента
    public let type: ComplexType

    /// Идентификатор платежного инструмента (только для типа ewalletBinding)
    public let id: String?

    public init(
        type: ComplexType,
        id: String?
    ) {
        self.type = type
        self.id = type == .ewalletBinding ? id : nil
    }
}

/// Успешная оплата
public struct PaymentCompleted: Equatable {
    /// Дата платежа
    public let paymentDate: Date

    /// Идентификатор платежа
    public let paymentId: Int

    /// Статус платежа
    public let status: Status

    /// Платежный инструмент
    public let paymentTool: PaymentTool

    /// Информация о сумме списания
    public let amountInfo: AmountInfo
}

import MTSPaySDK
  
func pay() {
    let configuration = MTSPayConfiguration(
        authorization: .authorized(ssoTokenId: "ssoTokenId"),
        environment: .production
    )
         
    let paymentFlowParams = PaymentFlowParams(
        sessionId: sessionId,
        preSelectedPaymentTool: .init(type: .sbp), // Предвыбранный платежный иструмент
        hasSuccessScreen: true // Отображать экран успешной оплаты
    )
         
    let mtsPay = MTSPay(configuration: configuration)
 
    mtsPay.startPaymentFlow(
        on: self, // UIViewController
        paymentFlowParams: paymentFlowParams
    ) { mtsPayResult in
        switch mtsPayResult.flowResult {
        case .flowComplete(let paymentCompleted):
            print("Дата платежа: \(paymentCompleted.paymentDate)")
        case .fatalPaymentErrorOccured(let fatalPaymentError):
            print "Фатальная ошибка оплаты: \(fatalPaymentError.userMessage)"
        case .flowNotFinished:
            print("Оплата была отменена клиентом")
        }
    }
}

public enum RefillAccount: Equatable {
    /// Номер телефона 10 цифр без кода страны
    case phone(String)
 
    /// 9-ти или 11..13-ти значный номер лицевого счета
    case bill(String)
}

let refillPredefinedDetails = RefillPredefinedDetails(
    account: .phone("9147773322"), // Реквизит пополнения. Необязательный параметр. Служит для предзаполнения номера телефона, либо счета
    amount: 500.0  // Предзаполненная сумма пополнения. Необязательный параметр. Если не будет передан, будет проставлена минимальная возможная.
)
     
let refillFlowParams = RefillFlowParams(
    serviceToken: "SERVICE TOKEN", // Токен вашего сервиса. Обязательный параметр. Отвечает за список доступных сервисов(услуг) к пополнению
    predefinedDetails: refillPredefinedDetails
)
 
mtsPay.startRefillFlow(
    on: self, // UIViewController
    refillFlowParams: refillFlowParams,
) { mtsPayResult in
    switch mtsPayResult.flowResult {
        case .flowComplete(let paymentCompleted):
            print("Платеж выполнен. Дата платежа: \(paymentCompleted.paymentDate)")
        case .fatalPaymentErrorOccured(let fatalPaymentError):
            print "Фатальная ошибка оплаты: \(fatalPaymentError.userMessage)"
        case .flowNotFinished:
            print("Пользователь вышел из платежного сценария, не завершив оплату")
    }
 
    switch mtsPayResult.userAction {
        case .openAutoPayments:
            // Пользователь выбрал открыть настройки автоплатежей по завершению сценария
        case .openSupport:
            // Пользователь выбрал открыть страницу поддержки по завершению сценария (в случае получения ошибки)
        case .openCardLewis:
            // Пользователь нажал на баннер открытия карты МТС Деньги (Lewis) после оплаты
        case .openCardLewisAndReturnRefill(account: let account):
            // Пользователь нажал на баннер открытия карты МТС Деньги (Lewis) до оплаты
            // Необходимо после выпуска/пополнения карты вернуть пользователя в обратно в пополнение по реквизиту `account`
        default:
            return
     }
}  

public struct RefillLewisCardFlowParams {
    /// Идентификатор сервисного токена приложения пополнения карты
    public let serviceToken: String
     
    /// Номер телефона (только цифры, 11 символов)
    public let phone: String
     
    /// Идентификатор карты, которую будут пополнять
    public let cardId: String
     
    /// Маскированный номер карты
    public let maskedPan: String
 
    /// Предзаполненная сумма пополнения (опциональный параметр)
    public let amount: Decimal?
 
      /// Отображать ли экран результата платежа в случае успешного пополнения
    public let hasSuccessScreen: Bool
 
    /// Параметры для автоматического запуска сценария refill
    /// после успешного пополнения карты (необязательный параметр)
    public let refillParams: RefillFlowParams?
 
    public init(
        serviceToken: String,
        phone: String,
        cardId: String,
        maskedPan: String,
        amount: Decimal? = nil,
        hasSuccessScreen: Bool = true,
        refillParams: RefillFlowParams? = nil
    ) {
        self.serviceToken = serviceToken
        self.phone = phone
        self.cardId = cardId
        self.maskedPan = maskedPan
        self.amount = amount
        self.hasSuccessScreen = hasSuccessScreen
        self.refillParams = refillParams
    }
}

let refillLewis = RefillLewisCardFlowParams(
    serviceToken: "SERVICE_TOKEN",
    phone: "79030000050",
    cardId: "CARD_ID",
    maskedPan: "220208******5253"
)
 
mtsPay.startRefillLewisCardFlow(
    on: self, // UIViewController
   refillLewisCardFlowParams: flowParams
) { mtsPayResult.flowResult in
    switch mtsPayResult.flowResult {
        case .flowComplete(let paymentCompleted):
            print("Дата платежа: \(paymentCompleted.paymentDate)")
        case .fatalPaymentErrorOccured(let fatalPaymentError):
            print("Фатальная ошибка оплаты: \(fatalPaymentError.userMessage)"
        case .flowNotFinished:
            print("Оплата была отменена клиентом")
    }
}

mtsPay.startNewCardFlow(
    on: self, // UIViewController
) { mtsPayResult.flowResult in
    switch mtsPayResult.flowResult {
        case .flowComplete(let cardBinding):
            print("Карта \(cardBinding.userCardMnemonic) добавлена")
        case .fatalPaymentErrorOccured(let fatalPaymentError):
            print("Фатальная при добавлении карты: \(fatalPaymentError.userMessage)"
        case .flowNotFinished:
            print("Пользователь покинул флоу до завершения")
    }
}

/// Модуль списка карт пользователя
public protocol CardListModule: UIView {
    /// Обновить список карт
    /// - Parameter isForceUpdate: признак игнорирования кэша
    func refreshCardList(isForceUpdate: Bool)
     
    /// Блок, вызываемый по завершению обновления списка.
    /// Необходим для скрытия pull to refresh контрола
    var onCardListRefreshed: (() -> Void)? { get set }
     
    /// Блок, вызываемый при обновлении ui
    /// Необходим для триггера лэйаута контейнера
    var onViewStateChanged: (() -> Void)? { get set }
}

let cardListView = mtsPay.makeCardListView(
    navigationController: navigationController
)

let checkUserHasCardsUseCase = mtsPay.makeCheckUserHasAnyCardsUseCase()
let checkResult = await checkUserHasCardsUseCase.check(
    ignoreCache: false // признак ингнорирования кеша
)
 
switch checkResult {
    case .success(let hasAnyCards):
        // hasAnyCards - признак наличия карт
    case .failure(let error):
        // ошибка получения признака
}

/// Протокол объекта, реализующего отправку аналитических данных
public protocol AnalyticsListener {
 
    /// Произошло событие
    /// - Parameter event: аналитическое событие
    func didCommit(event: AnalyticEvent)
}

pod "MTSPaySDK/PaymentLight"