Vault SDK - iOS integration guide

The Mangopay Vault SDK allows you to securely tokenize an end user’s payment card for use in your application. A tokenized card is a virtual and secure version of the card that can be used for payment.

It is very highly recommended that you use the Mangopay Vault SDK, rather than integrating the API endpoints directly. By doing so, you:

• Avoid sensitive card details transiting your system
• Benefit from PCI-DSS compliance
• Receive ongoing support and updates

To use the Mangopay Vault SDK, you’ll need:

• A Mangopay ClientId and API key
• A User for whom to register the card (see Testing - Payment methods for test cards)
• iOS 13+
• Xcode 12.2
• Swift 5.3+

Follow these steps to integrate the package into your Xcode project with SPM,

1. Open your Xcode project and go to File > Swift Packages > Add Package Dependency.
2. In the prompted dialog, enter the repository URL https://github.com/Mangopay/mangopay-ios-vault-sdk.
3. Select MangoPayVault package by checking the corresponding checkbox.
4. Proceed by following the on-screen instructions to complete the integration.

Open your podfile and add:

pod 'MangopayVaultSDK'

Add these sources above your podfile :

source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/Mangopay/mangopay-ios-vault-sdk'

Run the install command

$pod install

In your backend, create the Card Registration via the Mangopay API, using the Id of the end user as the UserId .

You must also define the currency and type of the card at this stage.

{
    "Tag": "Created with the Mangopay Vault SDK",
    "UserId": "142036728",
    "CardType": "CB_VISA_MASTERCARD",
    "Currency": "EUR"
}

See parameter details →

{
    "Id": "193020188",
    "Tag": null,
    "CreationDate": 1686147148,
    "UserId": "193020185",
    "AccessKey": "1X0m87dmM2LiwFgxPLBJ",
    "PreregistrationData": "XBDYiG8w9PrylPS01KmupZunmK2QRHKIC-yUF6il3aIpAnKba1TGkR9VJe5lHjHt2ddFLVXdicolcUIkv_kKEA",
    "RegistrationData": null,
    "CardId": null,
    "CardType": "CB_VISA_MASTERCARD",
    "CardRegistrationURL": "https://homologation-webpayment.payline.com/webpayment/getToken",
    "ResultCode": null,
    "ResultMessage": null,
    "Currency": "EUR",
    "Status": "CREATED"
}

The data obtained in the response will be used in the CardRegistration defined below.

Initialize the SDK with your `ClientId, select your environment (Sandbox or Production) and your tenant (EU or UK).

import MangopayVaultSDK


MangoPayVault.initialize(clientId: clientId, environment: SANDBOX | PRODUCTION , tenant: eu | uk)

The SDK requires the following information to tokenize the card:

• The Card Registration data previously returned by the Mangopay API (CardRegistration)
• The end user’s card details (CardInfo) entered in the app (see Testing - Payment methods for test cards)

let cardRegistration  = CardRegistration(
            id: id,
                        accessKey: accessKey, 
                        preregistrationData: preregistrationData, 
                        cardRegistrationURL: cardRegistrationURL, 
  )

let cardInfo = CardInfo(
cardNumber: "4970107111111119",
cardExpirationDate: "1224",
cardCvx: "123"
)

You can now tokenize the card with the card data obtained previously using the frontend SDK.

The SDK automatically updates the Card Registration object to provide you with a CardId that can be used for payments.

MangoPayVault.tokenizeCard(
  card: card,
  cardRegistration: cardRegistration) { card, error in
      guard let _ = card else {
          self.showLoader(false)
          self.showAlert(with: error?.localizedDescription ?? "", title: "Failed ❌")
          return
      }
      self.showLoader(false)
      self.showAlert(with: "", title: "Successful 🎉")
  }

You can use the following endpoints to manage cards:

• View a Card provides key information about the card, including its Fingerprint which can be used as an anti-fraud tool
• Deactivate a Card allows you to irreversibly set the card as inactive

A registered card (CardId) is needed for pay-ins with the following objects:

• The Direct Card PayIn object, for one-shot card payments
• The Recurring PayIn Registration object, for recurring card payments
• The Preauthorization object, for 7-day preauthorized card payments
• The Deposit Preauthorization object, for 30-day preauthorized card payments

• Testing - Payment methods
• All supported payment methods