Client Token

Client Token: Generate

Returns a string which contains all authorization and configuration information your client needs to initialize the client SDK to communicate with Braintree.

  1. Ruby
@client_token = gateway.client_token.generate
Parameters
:customer_idString

Only applies to the Drop-in UI; not needed when generating client tokens for custom integrations.

A string value representing an existing customer in your Vault. Passing this option allows customers to manage their vaulted payment methods via the Drop-in UI; see Drop-in Customization for details.

:merchant_account_idString

Specify the merchant account ID that you want to use to generate the client token. If no merchant account ID is specified, or if the merchant account ID does not match any of your merchant accounts, we will use your default merchant account.

Depending on its settings, the merchant account you use will determine:

  • whether the PayPal button should be displayed
  • whether the 3D Secure authentication flow can be invoked
:fail_on_duplicate_payment_methodbool

If this option is passed and the same payment method has already been added to the Vault for any customer, the request will fail. This can only be passed if a customer_id is passed as well. If the check fails, this option will stop the Drop-in from returning a payment_method_nonce. This option will be ignored for PayPal, Pay with Venmo, Apple Pay, Google Pay, Samsung Pay and ACH payment methods.

:fail_on_duplicate_payment_method_for_customerbool

If this option is passed and the same payment method has already been added to the Vault for the customer, the request will fail. This can only be passed if a customer_id is passed as well. If the check fails, this option will stop the Drop-in from returning a payment_method_nonce. This option will be ignored for PayPal, Pay with Venmo, Apple Pay, Google Pay, Samsung Pay and ACH payment methods.

:make_defaultbool
This option makes the specified payment method the default for the customer. This can only be passed if a customer_id is passed as well.
:verify_cardbool

If the payment method is a credit card, this option prompts the gateway to verify the card's number and expiration date. It also verifies the AVS and CVV information if you've enabled AVS and CVV rules. This option can only be passed if a customer_id is passed as well. If the verification fails, this option will stop the Drop-in from returning a payment_method_nonce.

note

Braintree strongly recommends verifying all cards before they are stored in your Vault by enabling card verification for your entire account in the Control Panel.

In some cases, cardholders may see a temporary authorization on their account after their card has been verified. The authorization will fall off the cardholder's account within a few days and will never settle.

:versionString
The version of the client token to generate. The default value is 2. Current supported versions are 1, 2, and 3. Please check your client-side SDKs in use before changing this value.

Examplesanchor

Specify a customer IDanchor

The Drop-in UI supports presenting returning customers with their saved payment methods. To generate a token for a customer in your vault provide the customer's ID.

  1. Ruby
# pass client_token to your front-end
@client_token = gateway.client_token.generate(
  :customer_id => a_customer_id
)

If the customer can't be found, it will raise an ArgumentError.