Interface Request

Used to initialize a 3D Secure payment flow.

interface Request {
    accountType?: AccountType;
    additionalInformation?: AdditionalInformation;
    amount?: string;
    billingAddress?: CdvPurchase.Braintree.ThreeDSecure.PostalAddress;
    cardAddChallenge?: boolean;
    challengeRequested?: boolean;
    email?: string;
    exemptionRequested?: boolean;
    mobilePhoneNumber?: string;
    nonce?: string;
    shippingMethod?: CdvPurchase.Braintree.ThreeDSecure.ShippingMethod;
    versionRequested?: Version;
}

Properties

accountType? additionalInformation? amount? billingAddress? cardAddChallenge? challengeRequested? email? exemptionRequested? mobilePhoneNumber? nonce? shippingMethod? versionRequested?

Properties

Optional accountType

accountType?: AccountType

The account type selected by the cardholder.

Note: Some cards can be processed using either a credit or debit account and cardholders have the option to choose which account to use.

Optional additionalInformation

additionalInformation?: AdditionalInformation

The additional information used for verification.

Optional amount

amount?: string

Amount for the transaction.

String representation of a decimal number.

Automatically filled from the PaymentRequest.

Optional billingAddress

billingAddress?: CdvPurchase.Braintree.ThreeDSecure.PostalAddress

The billing address used for verification. Optional.

Automatically filled from the PaymentRequest

Optional cardAddChallenge

cardAddChallenge?: boolean

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

If set to true (REQUESTED), the authentication challenge will be requested from the issuer to confirm adding new card to the merchant’s vault. If set to false (NOT_REQUESTED) the authentication challenge will not be requested from the issuer. If set to BTThreeDSecureAddCardChallengeUnspecified, when the amount is 0, the authentication challenge will be requested from the issuer. If set to undefined (UNSPECIFIED), when the amount is greater than 0, the authentication challenge will not be requested from the issuer.

Optional challengeRequested

challengeRequested?: boolean

If set to true, an authentication challenge will be forced if possible.

Optional email

email?: string

The email used for verification. Optional.

Automatically filled from the PaymentRequest

Optional exemptionRequested

exemptionRequested?: boolean

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

Optional mobilePhoneNumber

mobilePhoneNumber?: string

The mobile phone number used for verification.

Only numbers. Remove dashes, parentheses and other characters.

Optional nonce

nonce?: string

A nonce to be verified by ThreeDSecure.

Optional shippingMethod

shippingMethod?: CdvPurchase.Braintree.ThreeDSecure.ShippingMethod

The shipping method chosen for the transaction.

Optional versionRequested

versionRequested?: Version

Set to V2 if ThreeDSecure V2 flows are desired, when possible. Defaults to V2

Settings

Member Visibility

Theme

On This Page

accountTypeadditionalInformationamountbillingAddresscardAddChallengechallengeRequestedemailexemptionRequestedmobilePhoneNumbernonceshippingMethodversionRequested