VisaCTFHelper Class Reference


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

This API binds the Visa token to the device. Using this API will reset the whole binding process. If this is applied on an already bound token, the token will be bound again with a potential new end user authentication.

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public func createBinding(forVProvisionedTokenID vProvisionedTokenID: String,
                          correlationID: String,
                          deviceAuthenticationHandler: @escaping (DeviceAuthentication) -> Void,
                          idvSessionHandler: @escaping (VisaCTFHelper.IDVSession) -> Void,
                          completionHandler: @escaping (VisaCTFHelper.IDVSession?, TMGError?) -> Void)

Parameters

`forVProvisonedTokenID`	The Visa provisioned token ID which is a mandatory input. This value is retrieved during the tokenization process.
`correlationID`	The session ID generated by the app which is a mandatory input.
`deviceAuthenticationHandler`	A completion handler for the app to take action for Device Authentication where a `DeviceAuthentication` parameter is returned. This is a mandatory input.
`idvSessionHandler`	A completion handler for app to take action for Token Binding process where a `IDVSession` parameter is returned. This is a mandatory input.
`completionHandler`	A completion handler to notify the app that Token Binding is successful or failed with an error. This is a mandatory input. On success: Both `TMGError` and `IDVSession` will be returned with a `nil` value. On app action required: An optional `IDVSession` and a `TMGError` will be returned. On failure: A `TMGError` is returned indicating the error encountered. Possible errors: `deviceEnvironmentUnsafe(code:)` `invalidIdvMethod` `invalidConfigParams` `invalidRequiredParams` `invalidOTPMessage` `tokenNotBound` `tokenDeclined` `issuerAuthenticationRequired` `biometricNotSupported` `authenticationFailure(reason:)` `authenticationKeyInvalidated` `tokenAlreadyBound` `internalError(additionalMessage:)` `serverErrorIdvNotAvailable` `serverError(httpStatusCode:additionalMessage:)` `serverErrorCryptoError` `serverErrorInvalidTokenState` `serverErrorNoSessionFound` `serverErrorWrongOTP` `serverErrorExpiredOTP` `serverErrorRetryLimitExceeded` `serverErrorTooManyRequest` `serverIsNotAccessible`


                    
                    
                    resumeBinding(forVProvisionedTokenID:idvSessionHandler:completionHandler:)

Continue with the token which is pending for activation. Use this method when resuming an ongoing binding session.

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public func resumeBinding(forVProvisionedTokenID vProvisionedTokenID: String,
                          idvSessionHandler: @escaping (IDVSession) -> Void,
                          completionHandler: @escaping (IDVSession?, TMGError?) -> Void)

Parameters

`forVProvisonedTokenID`	The Visa provisioned token ID which is a mandatory input.
`idvSessionHandler`	A completion handler for app to take action for Token Binding process where the `IDVSession` parameter is returned. This is a mandatory input.
`completionHandler`	A completion handler to notify the app on whether Token Binding is successful. This is a mandatory input. On success: Both `TMGError` and `IDVSession` will be returned with a `nil` value. On app action required: An optional `IDVSession` and a `TMGError` will be returned. On failure: A `TMGError` is returned indicating the error encountered. Possible errors: `deviceEnvironmentUnsafe(code:)` `invalidIdvMethod` `invalidConfigParams` `invalidRequiredParams` `invalidOTPMessage` `tokenAlreadyBound` `issuerAuthenticationRequired` `biometricNotSupported` `internalError(additionalMessage:)` `serverErrorIdvNotAvailable` `serverError(httpStatusCode:additionalMessage:)` `serverErrorCryptoError` `serverErrorInvalidTokenState` `serverErrorNoSessionFound` `serverErrorWrongOTP` `serverErrorExpiredOTP` `serverErrorRetryLimitExceeded` `serverErrorTooManyRequest` `serverIsNotAccessible`


                    
                    
                    bindingState(forVProvisionedTokenID:)

Retrieves the binding status of a Visa provisioned token ID.

Throws

Throws:

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

Version

Version 3.0

Since

Since 3..0

Declaration

Swift

public func bindingState(forVProvisionedTokenID vProvisionedTokenID: String) throws -> BindingState

Parameters


                                forVProvisionedTokenID

The Visa provisioned token ID which is a mandatory input.

Return Value

BindingState : The state of the Visa provisioned token ID.


                    
                    
                    syncBindingState(forVProvisionedTokenID:correlationID:completionHandler:)

Synchronises the binding state between Server and Client.

Version

Version 3.0

Since

Since 3..0

Declaration

Swift

public func syncBindingState(forVProvisionedTokenID vProvisionedTokenID: String,
                             correlationID: String,
                             completionHandler: @escaping (VisaCTFHelper.BindingState, TMGError?) -> Void)

Parameters

`forVProvisionedTokenID`	The Visa provisioned token ID which is a mandatory input.
`correlationID`	The session ID generated by the app which is a mandatory input.
`completionHandler`	A completion handler to notify the app of the state of a token upon completion. On success: Returns the binding state. On failure: Returns `BindingState.unbound` and a `TMGError`. Possible errors: `deviceEnvironmentUnsafe(code:)` `invalidConfigParams` `invalidRequiredParams` `internalError(additionalMessage:)` `tokenNotBound`


                    
                    
                    authenticateTransaction(forVProvisionedTokenID:deviceAuthenticationHandler:completionHandler:)

Authenticates a transaction for a specified Visa provisioned token ID.

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public func authenticateTransaction(forVProvisionedTokenID vProvisionedTokenID: String,
                                    deviceAuthenticationHandler: @escaping (DeviceAuthentication) -> Void,
                                    completionHandler: @escaping (String?, TMGError?) -> Void)

Parameters

`forVProvisionedTokenID`	The Visa provisioned token ID which is a mandatory input.
`deviceAuthenticationHandler`	A completion handler for the app to take action for device authentication where a `DeviceAuthentication` parameter is returned. This is a mandatory input.
`completionHandler`	A completion handler that provides the result of the transaction. On success: Returns a `String`. On failure: Returns a `TMGError` indicating the error encountered. Possible errors: `deviceEnvironmentUnsafe(code:)` `invalidConfigParams` `invalidRequiredParams` `tokenNotBound` `tokenPending` `internalError(additionalMessage:)` `biometricNotSupported` `authenticationFailure(reason:)` `authenticationKeyInvalidated`


                    
                    
                    removeBinding(forVProvisionedTokenID:correlationID:completionHandler:)

Removes the specified Visa provisioned token ID from the device.

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public func removeBinding(forVProvisionedTokenID vProvisionedTokenID: String,
                          correlationID: String,
                          completionHandler: @escaping (TMGError?) -> Void)

Parameters

`forVProvisionedTokenID`	The Visa provisioned token ID which is a mandatory input.
`correlationID`	The session ID generated by the app which is a mandatory input.
`completionHandler`	A completion handler that provides the result of the removal process. On success: Returns a `nil` value. On failure: Returns a `TMGError` indicating the error encountered. Possible errors: `deviceEnvironmentUnsafe(code:)` `invalidConfigParams` `invalidRequiredParams` `tokenNotBound` `internalError(additionalMessage:)` `serverErrorTooManyRequest` `serverIsNotAccessible`


                    
                    
                    IDVMethod

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

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public struct IDVMethod


                    
                    
                    BindingState

The BindingState enum defines the current state of the vProvisionedTokenID parameter.

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public enum BindingState : String


                    
                    
                    OTPActivationStatus

The OTPActivationStatus struct captures the OTP activation status during selectIDVMethod and sends it to the merchant application.

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public struct OTPActivationStatus


                    
                    
                    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


                    
                    
                    IDVSession

IDVSession is used to retrieve the vProvisionedTokenId session details with pending activation.

Version

Version 3.0

Since

Since 3.0

Declaration

Swift

public class IDVSession