MastercardTAFHelper Class Reference


                    
                    
                    createBinding(forTokenID:correlationID:idvSessionHandler:deviceAuthenticationHandler:completionHandler:)

This API binds the Mastercard token to the device.

Declaration

Swift

public func createBinding(forTokenID tokenID: String,
                          correlationID: String,
                          idvSessionHandler: @escaping (IDVSession) -> Void,
                          deviceAuthenticationHandler: @escaping (DeviceAuthentication) -> Void,
                          completionHandler: @escaping (IDVSession?, TMGError?) -> Void)

Parameters

`forTokenID`	A Mastercard token ID. This is a mandatory input that is retrieved during the tokenization process.
`correlationID`	A mandatory input session ID that is generated by the app.
`idvSessionHandler`	A completion handler for app to take action for Token Binding process. A `IDVSession` will be returned as a parametter. This is a mandatory input.
`deviceAuthenticationHandler`	A completion handler for app to take action for device authentication where a `DeviceAuthentication` parameter is returned. This is a mandatory input.
`completionHandler`	A completion handler to notify to app that Token Binding is success or failed with error. This is a mandatory input. On success: A `nil` value for both `TMGError` and `IDVSession` will be returned. On app action required: An optional `IDVSession` and a `TMGError` will be returned. On failure: A `TMGError` indicating the error encountered. Possible errors: `deviceEnvironmentUnsafe(code:)` `invalidIdvMethod` `invalidConfigParams` `invalidRequiredParams` `invalidOTPMessage` `serverErrorIdvNotAvailable` `internalError(additionalMessage:)` `serverError(httpStatusCode:additionalMessage:)` `serverErrorCryptoError` `serverErrorInvalidTokenState` `serverErrorNoSessionFound` `serverErrorWrongOTP` `serverErrorExpiredOTP` `serverErrorRetryLimitExceeded` `serverErrorTooManyRequest` `serverIsNotAccessible`


                    
                    
                    bindingState(forTokenID:)

Gets the binding status.

Throws

TMGError: When an error occurs during the get binding status process.
- Possible errors:

Declaration

Swift

public func bindingState(forTokenID tokenID: String) throws -> BindingState

Parameters


                                forTokenID

The Mastercard provisioned token ID for which the binding state is queried. This is a mandatory input.

Return Value

BindingState: If the binding is performed successfully, BindingState.bound is returned, otherwise BindingState.unbound is returned.


                    
                    
                    authenticateTransaction(forTokenID:context:deviceAuthenticationHandler:completionHandler:)

Authenticates the transaction for tokenID.

Declaration

Swift

public func authenticateTransaction(forTokenID tokenID: String,
                                    context: TransactionContext,
                                    deviceAuthenticationHandler: @escaping (DeviceAuthentication) -> Void,
                                    completionHandler: @escaping (String?, TMGError?) -> Void)

Parameters

`forTokenID`	A Mastercard token ID. This is a mandatory input that is retrieved during the tokenization process.
`context`	The context of the transaction, containing critical details about the transaction such as merchant information, amount, and currency. This parameter cannot be null.
`deviceAuthenticationHandler`	A completion handler for app to take action for device authentication where a `DeviceAuthentication` parameter is returned. This is a mandatory input.
`completionHandler`	A completion handler to notify the app on whether the transaction is authenticated successfully. This is a mandatory input. Possible errors: `deviceEnvironmentUnsafe(code:)` `invalidRequiredParams` `internalError(additionalMessage:)`


                    
                    
                    IDVType

The list of Identity and Verification method types in IDVType.

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public enum IDVType : String, Codable


                    
                    
                    IDVMethod

IDVMethod defines the Mastercard IDV methods that are available to the end user.

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public struct IDVMethod : Codable


                    
                    
                    IDVSession

IDVSession is used to get the available IDVMethod, submit the user’s selection and then validate the OTP to complete IDV flow.

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public class IDVSession


                    
                    
                    BindingState

The BindingState enum defines the current state of the tokenId.

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public enum BindingState : String


                    
                    
                    TransactionContext

TransactionContext defines the context of a transaction, encompassing details such as the merchant name, transaction amount, and currency code.

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public struct TransactionContext