CloudPayments SDK позволяет интегрировать прием платежей в мобильные приложение для платформы iOS.
Для работы CloudPayments SDK необходим iOS версии 11.0 и выше.
Для подключения SDK мы рекомендуем использовать Cocoa Pods. Добавьте в файл Podfile зависимость:
pod 'Cloudpayments', :git => "https://github.com/cloudpayments/CloudPayments-SDK-iOS", :branch => "master"
pod 'CloudpaymentsNetworking', :git => "https://github.com/cloudpayments/CloudPayments-SDK-iOS", :branch => "master"
- demo - Пример реализации приложения с использованием SDK
- sdk - Исходный код SDK
Вы можете использовать SDK одним из трех способов:
- использовать стандартную платежную форму Cloudpayments
- реализовать свою платежную форму с использованием функций CloudpaymentsApi без вашего сервера
- реализовать свою платежную форму, сформировать криптограмму и отправить ее на свой сервер
- Создайте объект PaymentData, передайте в него Public Id из личного кабинета Cloudpayments, сумму платежа и валюту. Если хотите иметь возможность оплаты с помощью Apple Pay, передайте также Apple pay merchant id.
let paymentData = PaymentData.init(publicId: Constants.merchantPulicId) // Ваш PublicId
.setAmount(String(totalAmount)) // Сумма платежа
.setCurrency(.ruble) // Валюта
.setApplePayMerchantId(Constants.applePayMerchantID) // Apple pay merchant id
// Указывайте дополнительные данные если это необходимо
let jsonData: [String: Any] = ["age":27, "name":"Ivan", "phone":"+79998881122"] // Данные в формате JSON
let paymentData = PaymentData.init(publicId: Constants.merchantPublicId) // Ваш PublicId
.setAmount(String(totalAmount)) // Сумма платежа
.setCurrency(.ruble) // Валюта
.setApplePayMerchantId(Constants.applePayMerchantID) // Apple pay merchant id
.setDescription("Корзина цветов")
.setAccountId("111")
.setIpAddress("98.21.123.32")
.setInvoiceId("123")
.setJsonData(jsonData)
- Создайте объект PaymentConfiguration, передайте в него объект PaymentData. Реализуйте протокол PaymentDelegate, чтобы узнать о завершении платежа
let configuration = PaymentConfiguration.init(
paymentData: paymentData,
delegate: self,
uiDelegate: self,
scanner: nil,
useDualMessagePayment: true, // Использовать двухстадийную схему проведения платежа, по умолчанию используется одностадийная схема
disableApplePay: true // Выключить Apple Pay, по умолчанию Apple Pay включен
)
- Вызовите форму оплаты внутри своего контроллера
PaymentForm.present(with: configuration, from: self)
- Сканер карт
Вы можете подключить любой сканер карт. Для этого нужно реализовать протокол PaymentCardScanner и передать объект, реализующий протокол, при создании PaymentConfiguration. Если протокол не будет реализован, то кнопка сканирования не будет показана
Пример со сканером CardIO
- Создайте контроллер со сканером и верните его в функции протокола PaymentCardScanner
extension CartViewController: PaymentCardScanner {
func startScanner(completion: @escaping (String?, UInt?, UInt?, String?) -> Void) -> UIViewController? {
self.scannerCompletion = completion
let scanController = CardIOPaymentViewController.init(paymentDelegate: self)
return scanController
}
}
- После завершения сканирования вызовите замыкание и передайте данные карты
extension CartViewController: CardIOPaymentViewControllerDelegate {
func userDidCancel(_ paymentViewController: CardIOPaymentViewController!) {
paymentViewController.dismiss(animated: true, completion: nil)
}
func userDidProvide(_ cardInfo: CardIOCreditCardInfo!, in paymentViewController: CardIOPaymentViewController!) {
self.scannerCompletion?(cardInfo.cardNumber, cardInfo.expiryMonth, cardInfo.expiryYear, cardInfo.cvv)
paymentViewController.dismiss(animated: true, completion: nil)
}
}
- Создайте криптограмму карточных данных
// Обязательно проверяйте входящие данные карты (номер, срок действия и cvc код) на корректность, иначе функция создания криптограммы вернет nil.
let cardCryptogramPacket = Card.makeCardCryptogramPacket(with: cardNumber, expDate: expDate, cvv: cvv, merchantPublicID: Constants.merchantPulicId)
- Выполните запрос на проведения платежа. Создайте объект CloudpaymentApi и вызовите функцию charge для одностадийного платежа или auth для двухстадийного. Укажите email, на который будет выслана квитанция об оплате.
let api = CloudpaymentsApi.init(publicId: Constants.merchantPulicId)
api.auth(cardCryptogramPacket: cardCryptogramPacket, cardHolderName: cardHolderName, email: nil, amount: String(total)) { [weak self] (response, error) in
if let response = response {
self?.checkTransactionResponse(transactionResponse: response, completion: completion)
} else if let error = error {
completion?(false, error.localizedDescription)
}
}
- Если необходимо, покажите 3DS форму для подтверждения платежа
let data = ThreeDsData.init(transactionId: transactionId, paReq: paReq, acsUrl: acsUrl)
let threeDsProcessor = ThreeDsProcessor()
threeDsProcessor.make3DSPayment(with: data, delegate: self)
- Для получения формы 3DS и получения результатов прохождения 3DS аутентификации реализуйте протокол ThreeDsDelegate.
extension CheckoutViewController: ThreeDsDelegate {
// Вы получаете объект WKWebView, который сами показываете нужным вам способом и в нужном вам месте
func willPresentWebView(_ webView: WKWebView) {
self.showThreeDsForm(webView)
}
// Для завершения оплаты в выполните метод post3ds CloudpaymentsApi.
// threeDsCallbackId - идентификатор, полученный в ответ на запрос на проведение платежа
func onAuthotizationCompleted(with md: String, paRes: String) {
hideThreeDs()
post3ds(transactionId: md, paRes: paRes, threeDsCallbackId: threeDsCallbackId)
}
func onAuthorizationFailed(with html: String) {
hideThreeDs()
print("error: \(html)")
}
}
- Создайте массив объектов PKPaymentSummaryItem используя информацию о товарах выбранных вашим клиентом
var paymentItems: [PKPaymentSummaryItem] = []
for product in CartManager.shared.products {
let paymentItem = PKPaymentSummaryItem.init(label: product.name, amount: NSDecimalNumber(value: Int(product.price)!))
paymentItems.append(paymentItem)
}
- Укажите ваш Apple Pay ID и допустимые платежные системы
let applePayMerchantID = "merchant.com.YOURDOMAIN" // Ваш ID для Apple Pay
let paymentNetworks = [PKPaymentNetwork.visa, PKPaymentNetwork.masterCard] // Платежные системы для Apple Pay
- Проверьте, доступны ли пользователю эти платежные системы
buttonApplePay.isHidden = !PKPaymentAuthorizationViewController.canMakePayments(usingNetworks: paymentNetworks) // Скройте кнопку Apple Pay если пользователю недоступны указанные вами платежные системы
- Создайте и выполните запрос к Apple Pay
let request = PKPaymentRequest()
request.merchantIdentifier = applePayMerchantID
request.supportedNetworks = paymentNetworks
request.merchantCapabilities = PKMerchantCapability.capability3DS // Возможно использование 3DS
request.countryCode = "RU" // Код страны
request.currencyCode = "RUB" // Код валюты
request.paymentSummaryItems = paymentItems
let applePayController = PKPaymentAuthorizationViewController(paymentRequest: request)
applePayController?.delegate = self
self.present(applePayController!, animated: true, completion: nil)
- Обрабатываем ответ от Apple Pay
extension CheckoutViewController: PKPaymentAuthorizationViewControllerDelegate {
func paymentAuthorizationViewController(_ controller: PKPaymentAuthorizationViewController, didAuthorizePayment payment: PKPayment, completion: @escaping ((PKPaymentAuthorizationStatus) -> Void)) {
completion(PKPaymentAuthorizationStatus.success)
// Конвертируйте объект PKPayment в строку криптограммы
guard let cryptogram = payment.convertToString() else {
return
}
// Используйте методы API для выполнения оплаты по криптограмме
// (charge (для одностадийного платежа) или auth (для двухстадийного))
//charge(cardCryptogramPacket: cryptogram, cardHolderName: "")
auth(cardCryptogramPacket: cryptogram, cardHolderName: "")
}
func paymentAuthorizationViewControllerDidFinish(_ controller: PKPaymentAuthorizationViewController) {
controller.dismiss(animated: true, completion: nil)
}
}
При обработке успешного ответа от Apple Pay, обязательно выполните преобразование объекта PKPayment в криптограмму для передачи в платежное API CloudPayments
let cryptogram = payment.convertToString()
После успешного преобразования криптограмму можно использовать для проведения оплаты.
- Проверка карточного номера на корректность
Card.isCardNumberValid(cardNumber)
- Проверка срока действия карты
Card.isExpDateValid(expDate) // expDate в формате MM/yy
- Определение типа платежной системы
let cardType: CardType = Card.cardType(from: cardNumberString)
- Определение банка эмитента
CloudpaymentsApi.getBankInfo(cardNumber: cardNumber) { (info, error) in
if let error = error {
print("error: \(error.message)")
} else {
if let bankName = info?.bankName {
print("BankName: \(bankName)")
} else {
print("BankName is empty")
}
if let logoUrl = info?.logoUrl {
print("LogoUrl: \(logoUrl)")
} else {
print("LogoUrl is empty")
}
}
}
- Шифрование карточных данных и создание криптограммы для отправки на сервер
let cardCryptogramPacket = Card.makeCardCryptogramPacket(with: cardNumber, expDate: expDate, cvv: cvv, merchantPublicID: Constants.merchantPulicId)
- Шифрование cvv при оплате сохраненной картой и создание криптограммы для отправки на сервер
let cvvCryptogramPacket = Card.makeCardCryptogramPacket(with: cvv)
- Преобразование PKPayment в строку-криптограмму для отправки на сервер
let payment: PKPayment
let cryptogram = payment.convertToString()
- Отображение 3DS формы и получении результата 3DS аутентификации
let data = ThreeDsData.init(transactionId: transactionId, paReq: paReq, acsUrl: acsUrl)
let threeDsProcessor = ThreeDsProcessor()
threeDsProcessor.make3DSPayment(with: data, delegate: self)
public protocol ThreeDsDelegate: class {
func willPresentWebView(_ webView: WKWebView)
func onAuthotizationCompleted(with md: String, paRes: String)
func onAuthorizationFailed(with html: String)
}
По возникающим вопросам техничечкого характера обращайтесь на support@cloudpayments.ru