ThreeDSecure/com.braintreepayments.api.threedsecure/ThreeDSecureRequest

ThreeDSecureRequest

data class ThreeDSecureRequest @JvmOverloads constructor(var nonce: String? = null, var amount: String? = null, var mobilePhoneNumber: String? = null, var email: String? = null, var shippingMethod: ThreeDSecureShippingMethod? = null, var billingAddress: ThreeDSecurePostalAddress? = null, var accountType: ThreeDSecureAccountType? = null, var additionalInformation: ThreeDSecureAdditionalInformation? = null, var challengeRequested: Boolean = false, var dataOnlyRequested: Boolean = false, var exemptionRequested: Boolean = false, var requestedExemptionType: ThreeDSecureRequestedExemptionType? = null, var cardAddChallengeRequested: Boolean? = null, var v2UiCustomization: ThreeDSecureV2UiCustomization? = null, var uiType: ThreeDSecureUiType = ThreeDSecureUiType.BOTH, var renderTypes: List<ThreeDSecureRenderType>? = null, var customFields: Map<String, String>? = null) : Parcelable

A class to contain 3D Secure request information used for authentication

Constructors

ThreeDSecureRequest

@JvmOverloads

constructor(nonce: String? = null, amount: String? = null, mobilePhoneNumber: String? = null, email: String? = null, shippingMethod: ThreeDSecureShippingMethod? = null, billingAddress: ThreeDSecurePostalAddress? = null, accountType: ThreeDSecureAccountType? = null, additionalInformation: ThreeDSecureAdditionalInformation? = null, challengeRequested: Boolean = false, dataOnlyRequested: Boolean = false, exemptionRequested: Boolean = false, requestedExemptionType: ThreeDSecureRequestedExemptionType? = null, cardAddChallengeRequested: Boolean? = null, v2UiCustomization: ThreeDSecureV2UiCustomization? = null, uiType: ThreeDSecureUiType = ThreeDSecureUiType.BOTH, renderTypes: List<ThreeDSecureRenderType>? = null, customFields: Map<String, String>? = null)

Properties

accountType

var accountType: ThreeDSecureAccountType?

Optional. 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.

additionalInformation

var additionalInformation: ThreeDSecureAdditionalInformation?

Optional. Additional information used for verification.

amount

var amount: String?

The amount of the transaction in the current merchant account'scurrency. This must be expressed in numbers with an optional decimal (using .) and precision up to the hundredths place. For example, if you're processing a transaction for 1.234,56 € then amount should be 1234.56.

billingAddress

var billingAddress: ThreeDSecurePostalAddress?

Optional. The billing address used for verification.

cardAddChallengeRequested

var cardAddChallengeRequested: Boolean?

Optional. An authentication created using this flag should only be used for adding a payment method to the merchant's vault and not for creating transactions.

challengeRequested

var challengeRequested: Boolean

Optional. If set to true, the customer will be asked to complete the authentication challenge if possible.

customFields

var customFields: Map<String, String>?

Optional. 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.

dataOnlyRequested

var dataOnlyRequested: Boolean

If data was only requested

var email: String?

Optional. The email used for verification.

exemptionRequested

var exemptionRequested: Boolean

Optional. If set to true, an exemption to the authentication challenge will be requested.

mobilePhoneNumber

var mobilePhoneNumber: String?

Optional. The mobile phone number used for verification. Only numbers. Remove dashes, parentheses and other characters.

nonce

var nonce: String?

The nonce that represents a card to perform a 3D Secure verification against.

renderTypes

var renderTypes: List<ThreeDSecureRenderType>?

Optional. List of all the render types that the device supports for displaying specific challenge user interfaces within the 3D Secure challenge. When using ThreeDSecureUIType.BOTH or ThreeDSecureUIType.HTML, all ThreeDSecureRenderType options must be set. When using ThreeDSecureUIType.NATIVE, all ThreeDSecureRenderType options except ThreeDSecureRenderType.RENDER_HTML must be set. Defaults to OTP, OOB, SINGLE_SELECT, MULTI_SELECT, RENDER_HTML

requestedExemptionType

var requestedExemptionType: ThreeDSecureRequestedExemptionType?

Optional. 3D Secure requested exemption type. If an exemption is requested and the exemption's conditions are satisfied, then it will be applied.

shippingMethod

var shippingMethod: ThreeDSecureShippingMethod?

Optional. The 2-digit string indicating the shipping method chosen for the transaction. Possible Values: 01 Same Day 02 Overnight / Expedited 03 Priority (2-3 Days) 04 Ground 05 Electronic Delivery 06 Ship to Store

uiType

var uiType: ThreeDSecureUiType

Optional. Sets all UI types that the device supports for displaying specific challenge user interfaces in the 3D Secure challenge. Possible Values: 01 BOTH 02 Native 03 HTML Defaults to BOTH

v2UiCustomization

var v2UiCustomization: ThreeDSecureV2UiCustomization?

Optional. UI Customization for the 3DS2 challenge views.

Functions

build

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun build(dfReferenceId: String?): String

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)