Related sections

• Definitions are found under Definitions
• Success and error callbacks are found under Success and Error types
• The data flow connected to the different methods are found under Sequence Diagrams
• What the consumer sees during the different flows are found under Execution flow screenshots

Sessions

A valid session id and key are almost always required as arguments in order to call the SDK methods. To create a session, the Mobile App Backend needs to create a session and return it to the Mobile App, either via API or push messages. See the API Reference and Create Wallet Session.

Android vs iOS

Android and iOS methods behave similarly, but iOS methods often requires a keychain group parameter as well.

Generic methods

Current available methods for Android and iOS are outlined below.

deleteWallet

Deletes both Wallet and Secure ID of the consumer. Will call delete on keys in secure hardware and delete other data used by the SDK. Requires consumer authentication

Android Example

walletsSDK.deleteWallet(sessionId, sessionKey, callback)

🆕iOS Example

AeraWalletsSDK.shared.deleteWallet(
  sessionId: sessionId,
  sessionKey: sessionKey,
  keychainGroup: keychainGroup,
  authRedirectUri: redirectUri,
  callback: callback
)

// Using objc header: AeraWalletsSDK.shared.deleteWalletWithSessionId(...

getSDKInfo

Returns SDK information, including Secure ID information.

Arguments

Returns

Android Example

walletsSDK.getSDKInfo(callback)

iOS Example

AeraWalletsSDK.shared.getSDKInfo(
  keychainGroup: keychainGroup,
  callback: callback
)

// Using objc header: AeraWalletsSDK.shared.getSDKInfoWithKeychainGroup(...

getDynamicSDKId

Returns a dynamic and unique Secure ID SDK ID.

Arguments

Returns

Android Example

walletsSDK.getDynamicSDKId(callback)

iOS Example

AeraWalletsSDK.shared.getDynamicSDKId(
  keychainGroup: keychainGroup,
  callback: callback
)

// Using objc header: AeraWalletsSDK.shared.getDynamicSDKIdWithKeychainGroup(...

getOpenWalletURL

Wallets SDK will handle most of the lifecycle for the merchant. The SDK will check device compatibility, if the consumer has been onboarded before, and select the correct onboarding or signing options for SCA before returning a Wallets Frontend URL to the Mobile App. Consumers must authenticate, either by onboarding with pre-defined Identity Providers, or if already onboarded, signing in with app pin (and biometrics when used).

The Mobile App is responsible for calling openUrl to open the wallets dashboard using the url returned in AuthenticateData.

Arguments

Returns

Example

walletsSDK.getOpenWalletUrl(sessionId, sessionKey, callback)

iOS Example

AeraWalletsSDK.shared.getOpenWalletUrl(
  sessionId: sessionId,
  sessionKey: sessionKey,
  keychainGroup: keychainGroup,
	authRedirectUri: authRedirectUri,
  callback: callback
)

// Using objc header: AeraWalletsSDK.shared.getOpenWalletUrlWithSessionId(...

🆕 openURL

Enables opening the wallets dashboard via the Wallets SDK implemented system browser.

⚠️ iOS only: Remember to implement handleDeeplink to ensure the system browser is closed correctly, as it does not close automatically when deeplinks are triggered, e.g. while consumer is inside the wallets dashboard.

Arguments

Example

walletsSDK.openURL(url, callback)

iOS Example

AeraWalletsSDK.shared.openURL(
  url: url,
  callback: callback
)

getPaymentInfo

Wallets SDK will handle retrieval of payment information.

The Mobile App is responsible for opening a payment UI using their own UI and signing the payment with the payment instrument ID selected by the consumer.

Returns payment information to be displayed and used for payment.

The method should first be called when the Mobile App backend has triggered the Mobile App to do so after the Merchant Store (POS) has initiated a sale. See “Data flows” section.

Arguments

Returns

Android Example

walletsSDK.getPaymentInfo(sessionId, sessionKey, callback)

iOS Example

AeraWalletsSDK.shared.getPaymentInfo(
  sessionId: sessionId,
  sessionKey: sessionKey,
  keychainGroup: keychainGroup,
  callback: callback
)

// Using objc header: AeraWalletsSDK.shared.getPaymentInfoWithSessionId(...

signPayment

The method should be called whenever a consumer wants to sign the payment, e.g. clicking a pay button inside the Mobile App Payment UI.

Wallets SDK will handle SCA for signing the payment.

Mobile App is responsible for displaying confirmation/error feedback to the consumer.

Arguments

Returns

Android Example

walletsSDK.signPayment(sessionId, sessionKey, signPaymentData, callback)

iOS Example

 AeraWalletsSDK.shared.signPayment(
   sessionId: sessionId,
   sessionKey: sessionKey,
   keychainGroup: keychainGroup,
   callback: callback
)
   
// Using objc header: AeraWalletsSDK.shared.signPaymentWithSessionId(...

cancelPayment

The method should be called whenever a consumer wants to cancel a payment via the Mobile App Payment UI before a transaction is finished.

After the Mobile App Payment UI is opened, the Mobile App must notify other systems of any payment cancellation initiated by the consumer, e.g. consumer clicking cancel/close buttons or swiping away a dialog. The method should not be called when cancellation occurs after the transaction has been conducted with success or error result.

Arguments

Android Example

walletsSDK.cancelPayment(sessionId, sessionKey, callback)

iOS Example

 AeraWalletsSDK.shared.cancelPayment(
   sessionId: sessionId,
   sessionKey: sessionKey,
   keychainGroup: keychainGroup,
   callback: callback
)
   
// Using objc header: AeraWalletsSDK.shared.cancelPaymentWithSessionId(...

🆕 iOS Methods

🆕 setAuthCallbackAppName

iOS Example

init {
  AeraWalletsSDK.shared.setAuthCallbackAppName(name: "myAppName")
}

🆕 handleDeeplink

iOS Example

.onOpenURL { url in
    AeraWalletsSDK.shared.handleDeeplink(url: url)
}