Getting started with iOS SDK

Features

The Trust Payments iOS SDK allows you to seamlessly integrate a prebuilt or custom UI in your app to accept card payments & comply with the Strong Customer Authentication (SCA) mandate.

Use this integration if you need a pre-built “Drop-In” UI that supports the following features:

• Card payments
• Tokenization payments
• Customisation of UI components to fit with your business branding
• Locale and custom translations

Otherwise if you have already built your own payment checkout views in your iOS app, but need a method to process payments to the Trust Payments gateway, you can use our payment transaction manager API.

  Click here to learn more.

1. Install the SDK in your app

To embed the iOS SDK into your Xcode project, you will need to use one of the following dependency managers:

1. CocoaPods

CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate Trust Payments into your Xcode project using CocoaPods, specify it in your Podfile as follows:

pod 'TrustPayments'

2. Carthage

Carthage is a decentralised dependency manager that builds the necessary dependencies and provides you with binary frameworks. To integrate Trust Payments into your Xcode project using Carthage, specify it in your Cartfile as follows:

git "https://gitlab.com/trustpayments-public/mobile-sdk/ios"

Once you have Carthage installed, you can begin adding frameworks to your project. Click here to learn how.

2. Initialise the iOS SDK in your app

Configure the instance

Before you can perform any payment request, you will need to set the username, gateway and environment, as shown in the example below:

TrustPayments.instance.configure(
  username: username_from_trustpayments,
  gateway: .eu,
  environment: .staging,
  translationsForOverride: nil
)

View controllers

The following is an example of how to create a Drop-In View Controller using only the required fields:

let dropInVC = try ViewControllerFactory.shared.dropInViewController(
  jwt: jwt,
  payButtonTappedClosureBeforeTransaction: {
    (controller: DropInController) in
  },
  transactionResponseClosure: {
    (
      jwt: [String],
      threeDResponse: ThreeDResponse?,
      error: APIClientError?
    )
    in
  }
)

	Parameter	Description
	cardinalDarkModeStyleManager	Specifies light/dark mode for the ACS view (3-D Secure).
	cardinalStyleManager	Specifies interface style for the ACS view (3-D Secure).
	customDropInView	DropInViewProtocol compliant view for additional views, e.g. for adding a tip to a payment.
	dropInViewDarkModeStyleManager	Specifies light/dark mode for the Drop-In View Controller.
	dropInViewStyleManager	Used to customise the Drop-In View Controller.
	jwt	The signed JWT. Click here to learn how generate the JWT.
	payButtonTappedClosureBeforeTransaction	Closure triggered by pressing the pay button (just before the transaction – you can use this closure to update the JWT token) You can use this closure to update the JWT token by calling the updateJWT() function on the controller that is passed as an argument.
	transactionResponseClosure	Closure triggered when the transaction is completed, with the following properties: JWT key array with responses from all requests (the signature of each key should be verified before decoding). An object that contains 3-D Secure authentication data sent with the AUTH request. An error object indicating if there were errors in connecting to the gateway server or during 3-D Secure authentication.

The following is an alternative example of how to create a Drop-In View Controller containing more optional parameters:

let dropInVC = try ViewControllerFactory.shared.dropInViewController(

  jwt: jwt,
  customDropInView: dropInCustomView,
  visibleFields: [.securityCode3],
  dropInViewStyleManager: dropInViewStyleManager,
  dropInViewDarkModeStyleManager: dropInViewDarkModeStyleManager,
  cardinalStyleManager: cardinalStyleManager,
  cardinalDarkModeStyleManager: cardinalDarkModeStyleManager,

  payButtonTappedClosureBeforeTransaction: {
    (
      controller: DropInController
    )
    in
  },

  transactionResponseClosure: {
    (
      jwt: [String],
      threeDResponse: ThreeDResponse?,
      error: APIClientError?
    )
    in
  }

)

Plain card input field

The below demonstrates how to create card detail input views without performing any requests on your behalf:

Creating separate UI components:

lazy var cardNumberInput: CardNumberInputView = {
  CardNumberInputView(inputViewStyleManager: inputViewStyleManager)
}()

lazy var expiryDateInput: ExpiryDateInputView = {
  ExpiryDateInputView(inputViewStyleManager: inputViewStyleManager)
}()

lazy var cvvInput: CVVInputView = {
  CVVInputView(inputViewStyleManager: inputViewStyleManager)
}()

Then listen for CardNumberInput delegate method and adjust the security code to reflect required number of digits for given card:

extension SingleInputView: CardNumberInputViewDelegate {
  func cardNumberInputViewDidComplete(_ cardNumberInputView: CardNumberInputView) {
    cvvInput.cardType = cardNumberInputView.cardType
    cvvInput.isEnabled = cardNumberInputView.isCVVRequired
  }

  func cardNumberInputViewDidChangeText(_ cardNumberInputView: CardNumberInputView) {
    cvvInput.cardType = cardNumberInputView.cardType
    cvvInput.isEnabled = cardNumberInputView.isCVVRequired
  }
}

Payment Transaction Manager

If you already have / intend to build your own payment checkout views in your iOS app, but need a method to process payments to the Trust Payments gateway, you can use our transaction manager API.

let paymentTransactionManager = try PaymentTransactionManager(jwt: .empty)

paymentTransactionManager.performTransaction(jwt: jwt, card: card, transactionResponseClosure: {jwt, threeDResponse, error in})

3. Configure webhooks

It is strongly recommended that you configure webhooks on your Mobile SDK solution. When configured, URL notifications are sent to your system when payments are processed on your account.

1. Sign in to MyST.
   
   
2. Search for your sitereference using the search box found at the top of the page.
   
   
3. When viewing your site details, click “Rule manager“.
   
   
   
   
4. Select the action type “URL notification” from the drop-down and your browser will be redirected.
   
   
   
   
5. Create a new URL notification rule:
   • (A) Click “Add new condition” and specify the circumstances in which the URL notification is to be triggered following a transaction. In the Requests box displayed, ensure “AUTH” is ticked (meaning the notification is triggered following payment authorisations).
     Click here to learn more about configuring conditions.
   • (B) Click “Add new action” and specify the endpoint for the URL notification.
     Click here to learn more about URL notification actions.
   • (C) Using the drop-down boxes, assign the condition to the action and click “Create rule“.
     
     
   
   
   
6. Ensure the rule is active (this is shown with a tick under the Active column). Once enabled, the rule will be applied to all payment sessions for the given sitereference, and the URL notification will be triggered whenever the condition specified is met.
   
   Note: All new rules should be created on your test sitereference and tested to ensure they work as expected before being added to your live sitereference.
   
   
7. You must configure your system to respond to all URL notifications received from Trust Payments with an HTTP 200 OK response.
   For example: “HTTP/1.0 200 OK”.
   Your system must reply within 8 seconds of receiving a notification.