Applying 3DS to Transactions and Verifications

RubySDK

• Current Braintree SDKs
• Java
• .NET
• Node.js
• PHP
• Python
• Ruby

Table of Contents

• Create a transaction
  • Using 3D Secure upgraded single-use-token
  • Using 3DS authentication id
• Create a verification
  • Create a new customer with a payment method
  • Create a new payment method
• Requiring 3D Secure
• 3DS Status codes
• Recurring Transactions
  • Recurring Billing
  • Recurring Transactions with fixed amount and schedule
  • Subsequent Transactions without fixed amount or schedule
  • Exception for payment methods stored before September 2019

Create a transaction

Using 3D Secure upgraded single-use-token

To create a 3D Secure transaction, make a server-side sale call using the payment method single-use-token you received from your client when you verified the credit card on the client side.

Collect device data from the client and include the device_data_from_the_client in the transaction.

result = gateway.transaction.sale(
  :amount => "10.00",
  :payment_method_nonce => nonce_from_the_client,
  :device_data => device_data_from_the_client,
  :options => {
    :submit_for_settlement => true
  }
)

important

3D Secure information is lost when a 3D Secured payment_method_nonce is used in a Customer.create() or PaymentMethod.create() call without a verify_card flag.

Using 3DS authentication ID

To create a 3D Secure transaction using an authentication ID, make a server-side sale call using the authentication ID you received from your client when you verified the credit card on the client side. You can use a payment method token instead of a payment method single-use-token if you provide the 3D Secure authentication via an authentication ID.

result = gateway.transaction.sale(
  :amount => "10.00",
  :payment_method_token => token,
  :payment_method_nonce => cvv_only_nonce,
  :three_d_secure_authentication_id => authentication_id,
  :device_data => device_data_from_the_client,
  :options => {
    :submit_for_settlement => true
  }
)

If you want to use a CVV-only nonce when creating a transaction with 3D Secure, you will need to pass a 3D Secure Authentication ID together with the CVV-only nonce.

Create a verification

Create a new customer with a payment method

Make a server-side call using the 3D Secure upgraded payment_method_nonce you received from your client when you verified the credit card on the client side as shown in the customer guide.

As an alternative to passing the 3D Secure upgraded single-use-token, you can pass a three_d_secure_authentication_id using the authentication ID you received from your client when you verified the credit card on the client side. You can use a payment method token instead of a payment method single-use-token if you provide a three_d_secure_authentication_id.

Create a new payment method

Make a server-side call using the payment method single-use-token you received from your client when you verified the credit card on the client side as shown in the payment method guide.

As an alternative to passing the 3D Secure upgraded single-use-token, you can pass a three_d_secure_authentication_id using the authentication ID you received from your client when you verified the credit card on the client side. You can use a payment method token instead of a payment method single-use-token if you provide a three_d_secure_authentication_id.

Requiring 3D Secure

We expose additional information about the authentication request that you can use for more advanced UI flows or risk assessment. You should be aware that making such assessments may result in accepting the liability for fraudulent transactions.

You can pass a parameter called required with the transaction,to specify whether or not you require 3D Secure authentication to have succeeded on a transaction. When you create a transaction with a 3D Secure enriched single-use-token, the options.three_d_secure.required parameter defaults to true. This implies that all transactions without a successful 3D Secure authentication will be rejected. If 3D Secure is not present, the required parameter defaults to false, which means that transactions will not be rejected based on 3D Secure.

We strongly recommend you allow this parameter to default to true, as it helps protect against malicious users tampering with your front-end code and bypassing 3D Secure completely. That being said, you do have the option of determining your own level of risk and pushing the transaction through regardless of its 3D Secure status by setting required to false on a per-transaction basis.

important

If you pass required as true on transactions that do not go through 3D Secure, those transactions will be gateway rejected.

3DS Status codes

Below are the possible 3D secure statuses, along with their expected 3D Secure liability shift and enrolled values. This table also shows whether a transaction will be rejected by the PayPal Braintree gateway when options.three_d_secure.required is set to true when creating a transaction, or when creating or updating a subscription.

Recurring Transactions

Recurring Billing

If you use Braintree's recurring billing, follow the steps below to apply 3D Secure to subscriptions.

1. Generate a payment method nonce out of a vaulted payment method token.
2. Launch the 3D Secure authentication flow for your customer.

• For JavaScript, use the client-side verifyCard() function. The resulting nonce in verifyPayload will contain a new, 3D Secure enriched nonce.
• For Android / iOS, verify using 3D Secure in your client. Successful results will have a new payment method nonce that is enriched with 3D Secure data.

3. Use the generated 3D Secure enriched nonce in the Subscription.create() call.

Sometimes, you will need to re-establish SCA on an existing subscription, for example, if the price of the subscription has increased or the subscription will be updated with a new payment method. If you need to re-establish SCA then repeat the above steps but call Subscription.update() instead of Subscription.create()

Recurring Transactions with fixed amount and schedule

For other types of recurring transactions that don't involve Braintree's recurring billing, the recommended flow for recurring billing would be to request a cardholder challenge in order to establish Strong Customer Authentication (SCA) when the card is first authorized as part of storing it within the Braintree vault. This can be with a verification, or the first transaction of a recurring billing event. By applying 3D Secure to the first transaction or verification, you signal to the card issuer that you have established a mandate between you and your customer to charge their payment method for subsequent recurring payments as detailed in your terms and conditions. Such subsequent transactions are out of scope from PSD2 SCA requirements.

Establishing SCA on verifications will be useful for scenarios where the cardholder will not be present when the charge is issued, and the amount isn’t known when the payment method is stored. For example, if you have a metered billing flow and invoice customers at the end of a month based on their usage, you can use 3D Secure on your initial card verification to establish a mandate to create future merchant initiated transactions (MIT) without requiring 3D Secure authentication.

For subsequent transactions from that payment method, use the recurring value in the TransactionSource parameter of the Transaction.Sale() API call.

Subsequent Transactions without fixed amount or schedule

Other MIT transactions will be processed much the same way that recurring transactions would be. You would again request a cardholder challenge to establish SCA when the card is first authorized, establishing a mandate between you and your customer.

For subsequent transactions from that payment method, which would be outside of the scope of PSD2 SCA, use the unscheduled value in the TransactionSource parameter of the Transaction.Sale() API call.

Exception for payment methods stored before September 2019

Exceptions would apply for recurring transactions using a payment method that has been vaulted prior to September 14, 2019. Recurring transactions from these payment methods will be considered outside of the scope of PSD2 SCA as long as the payment method was successfully charged at least once prior to September 14, 2019.

For any vaulted payment methods not successfully charged prior to this date, the first recurring transaction attempt will result in a 2099 - Cardholder Authentication Required soft decline code. Some issuers may not yet support this decline code, and will instead return other soft decline codes. In this case, the cardholder must perform 3D Secure authentication in order to process the transaction.