BTThreeDSecureRequest
@objcMembers
public class BTThreeDSecureRequest : NSObject
Used to initialize a 3D Secure payment flow
-
A delegate for receiving information about the ThreeDSecure payment flow.
Declaration
Swift
public weak var threeDSecureRequestDelegate: BTThreeDSecureRequestDelegate?
-
init(amount:nonce: accountType: additionalInformation: billingAddress: cardAddChallengeRequested: challengeRequested: customFields: dataOnlyRequested: dfReferenceID: email: exemptionRequested: mobilePhoneNumber: renderTypes: requestedExemptionType: shippingMethod: uiType: v2UICustomization: requestorAppURL: ) Creates a
BTThreeDSecureRequestDeclaration
Swift
public init( amount: String, nonce: String, accountType: BTThreeDSecureAccountType = .unspecified, additionalInformation: BTThreeDSecureAdditionalInformation? = nil, billingAddress: BTThreeDSecurePostalAddress? = nil, cardAddChallengeRequested: Bool = false, challengeRequested: Bool = false, customFields: [String: String]? = nil, dataOnlyRequested: Bool = false, dfReferenceID: String? = nil, email: String? = nil, exemptionRequested: Bool = false, mobilePhoneNumber: String? = nil, renderTypes: [BTThreeDSecureRenderType]? = nil, requestedExemptionType: BTThreeDSecureRequestedExemptionType = .unspecified, shippingMethod: BTThreeDSecureShippingMethod = .unspecified, uiType: BTThreeDSecureUIType = .both, v2UICustomization: BTThreeDSecureV2UICustomization? = nil, requestorAppURL: String? = nil )Parameters
amountRequired. The amount for the transaction.
nonceRequired. A nonce to be verified by ThreeDSecure.
accountTypeOptional. The account type selected by the cardholder. Some cards can be processed using either a credit or debit account and cardholders have the option to choose which account to use.
additionalInformationOptional. The additional information used for verification.
billingAddressOptional. The billing address used for verification.
cardAddChallengeRequestedOptional. An authentication created using this flag should only be used for vaulting operations (creation of customers’ credit cards or payment methods) and not for creating transactions. If set to
true, a card-add challenge will be requested from the issuer. If set tofalse, a card-add challenge will not be requested. If the parameter is missing, a card-add challenge will only be requested for $0 amount.challengeRequestedOptional. If set to true, an authentication challenge will be forced if possible.
customFieldsOptional. Object where each key is the name of a custom field which has been configured in the Control Panel. In the Control Panel you can configure 3D Secure Rules which trigger on certain values.
dataOnlyRequestedOptional. Indicates whether to use the data only flow. In this flow, frictionless 3DS is ensured for Mastercard cardholders as the card scheme provides a risk score for the issuer to determine whether to approve. If data only is not supported by the processor, a validation error will be raised. Non-Mastercard cardholders will fallback to a normal 3DS flow.
dfReferenceIDOptional. The dfReferenceID for the session, particularly useful for merchants performing 3DS lookup.
emailOptional. The email used for verification.
exemptionRequestedOptional. If set to true, an exemption to the authentication challenge will be requested.
mobilePhoneNumberOptional. The mobile phone number used for verification. Only numbers. Remove dashes, parentheses and other characters.
renderTypesOptional: List of all the render types that the device supports for displaying specific challenge user interfaces within the 3D Secure challenge. When using
BTThreeDSecureUIType.bothorBTThreeDSecureUIType.html, allBTThreeDSecureRenderTypeoptions must be set. When usingBTThreeDSecureUIType.native, allBTThreeDSecureRenderTypeoptions except.htmlmust be set.requestedExemptionTypeOptional. The exemption type to be requested. If an exemption is requested and the exemption’s conditions are satisfied, then it will be applied.
shippingMethodOptional. The shipping method chosen for the transaction.
uiTypeOptional: Sets all UI types that the device supports for displaying specific challenge user interfaces in the 3D Secure challenge. Defaults to
.both.v2UICustomizationOptional. UI Customization for 3DS2 challenge views.
requestorAppURLOptional. Three DS Requester APP URL Merchant app declaring their URL within the CReq message so that the Authentication app can call the Merchant app after out of band authentication has occurred.
View on GitHub