See also the PaymentMethod response object.

To create a new payment method for an existing customer, the only required attributes are the customer ID and payment method nonce.

note

You can also create a payment method when you create a customer.

C♯
var request = new PaymentMethodRequest
{
    CustomerId = "131866",
    PaymentMethodNonce = NonceFromTheClient
};

Result<PaymentMethod> result = gateway.PaymentMethod.Create(request);
Parameters
BillingAddress

A billing address associated with a specific customer ID. It can be further associated with a specific payment method. The maximum number of addresses per customer is 50.

Company string

Company name. 255 character maximum.

CountryCodeAlpha2 string

The ISO 3166-1 alpha-2 country code specified in an address. The gateway only accepts specific alpha-2 values.

CountryCodeAlpha3 string

The ISO 3166-1 alpha-3 country code specified in an address. The gateway only accepts specific alpha-3 values.

CountryCodeNumeric string

The ISO 3166-1 numeric country code specified in an address. The gateway only accepts specific numeric values.

CountryName string

The country name specified in an address. Braintree only accepts specific country names.

ExtendedAddress string

The extended address information—such as apartment or suite number. 255 character maximum.

FirstName string

The first name. The first name value must be less than or equal to 255 characters.

LastName string

The last name. The last name value must be less than or equal to 255 characters.

Locality string

The locality/city. 255 character maximum.

PostalCode string

The postal code. Postal code must be a string of 4-9 alphanumeric characters, optionally separated by a dash or a space. Spaces and hyphens are ignored.

Region string

The state or province. For PayPal addresses, the region must meet PayPal's state restrictions; for all other payment methods, it must be less than or equal to 255 characters.

StreetAddress string

The street address. Street address must be less than or equal to 255 characters. Required to perform card verification when AVS rules are configured to require street address.

BillingAddressId string

The two-letter value for an address associated with a specific customer ID. The maximum number of addresses per customer is 50.

CardholderName string

The cardholder name associated with the credit card. 175 character maximum.

CustomerId required, string

A string value representing an existing customer in your Vault that you want to create a payment method for.

Cvv string

Typically requires PCI SAQ D compliance

We recommend using PaymentMethodNonce to avoid any PCI concerns with raw credit card data being present on your server.

A 3 or 4 digit card verification value assigned to a credit card. The CVV will never be stored in the gateway, but it can be provided with one-time requests to verify the card.

DeviceData string

Customer device information. Pass this value only if you have Advanced Fraud Tools enabled and are adding credit card data to your Vault. Be sure to provide the full string received from the Braintree client SDK.

ExpirationDate string

Typically requires PCI SAQ D compliance

We recommend using PaymentMethodNonce to avoid any PCI concerns with raw credit card data being present on your server.

The expiration date of a credit card, formatted MM/YY or MM/YYYY. May be used instead of ExpirationMonth and ExpirationYear.

ExpirationMonth string

Typically requires PCI SAQ D compliance

We recommend using PaymentMethodNonce to avoid any PCI concerns with raw credit card data being present on your server.

The expiration month of a credit card, formatted MM. May be used with ExpirationYear, and instead of ExpirationDate.

ExpirationYear string

Typically requires PCI SAQ D compliance

We recommend using PaymentMethodNonce to avoid any PCI concerns with raw credit card data being present on your server.

The two or four digit year associated with a credit card, formatted YYYY or YY. May be used with ExpirationMonth, and instead of ExpirationDate.

Number string

Typically requires PCI SAQ D compliance

We recommend using PaymentMethodNonce to avoid any PCI concerns with raw credit card data being present on your server.

The 12-19 digit value on a credit card consisting of a bank identification number (BIN) and primary account number (PAN).

Options

Optional values that can be passed with a request.

FailOnDuplicatePaymentMethod bool

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 option will be ignored for PayPal, Pay with Venmo, Apple Pay, Google Pay, and Samsung Pay payment methods.

MakeDefault bool

This option makes the specified payment method the default for the customer.

VerificationAmount string

Specify a non-negative amount that you want to use to verify a card. If you do not pass this option, the gateway will automatically use a verification amount of $0 or $1, depending on the processor and/or card type.

VerificationMerchantAccountId string

Specify the merchant account ID that you want to use to verify a card. See the MerchantAccountId on Transaction.Sale() to learn more. The merchant account can't be a marketplace sub-merchant account. See the Braintree Marketplace Guide to learn more.

VerifyCard bool

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.

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.

Only returns a CreditCardVerification result if verification runs and is unsuccessful.

PaymentMethodNonce required, string

One-time-use reference to payment information provided by your customer, such as a credit card or PayPal account.

The ability to transact on credit card information will not be verified automatically on create – you must explicitly perform card verification.

ThreeDSecurePassThru

Results of a merchant-performed 3D Secure authentication. You will only need to use these fields if you've performed your own integration with a 3D Secure MPI provider (e.g. Cardinal Centinel). Otherwise, Braintree's SDKs handle this for you in our standard 3D Secure integration.

Cavv string

Cardholder authentication verification value or CAVV. The main encrypted message issuers and card networks use to verify authentication has occurred. Mastercard uses an AVV message and American Express uses an AEVV message, each of which should also be passed in the Cavv parameter.

DsTransactionId string

Transaction identifier resulting from 3D Secure 2 authentication. This field must be supplied for Mastercard Identity Check.

EciFlag required, string

The value of the electronic commerce indicator (ECI) flag, which indicates the outcome of the 3DS authentication.

Accepted values for Mastercard:

  • 00 = Failed or not attempted
  • 01 = Attempted
  • 02 = Success

Accepted values for all other card brands:

  • 07 = Failed or not attempted
  • 06 = Attempted
  • 05 = Success
ThreeDSecureVersion string

The version of 3D Secure authentication used for the transaction. Required on Visa and Mastercard authentications. Must be composed of digits separated by periods (e.g. 1.0.2).

Xid string

Transaction identifier resulting from 3D Secure authentication. Uniquely identifies the transaction and sometimes required in the authorization message. Must be base64-encoded. This field will no longer be used in 3D Secure 2 authentications.

Token string

An alphanumeric value that references a specific payment method stored in your Vault. Must be less than or equal to 36 characters. If using a custom integration, you can specify what you want the token to be. If not specified, the gateway will generate one that can be accessed on the result. If using our Drop-in UI with a customer ID to vault payment methods, you can't specify your own token. Length and format of gateway-generated tokens and IDs may change at any time.

Examples

Specify a token

If you are using a custom integration and want to specify what you would like the token to be, pass it with the other parameters, as in the example below. If you do not specify a payment method token, the gateway will generate a random one. Note that if you are using our Drop-in UI, you can't specify your own token.

C♯
var request = new PaymentMethodRequest
{
    CustomerId = "131866",
    Token = "the_token",
    PaymentMethodNonce = nonceFromTheClient
};

Result<PaymentMethod> result = gateway.PaymentMethod.Create(request);

New default payment method

If a customer has multiple payment methods, the first payment method created will be the customer's default. The default payment method is used when creating transactions with CustomerId. To set a new payment method as the default, use the MakeDefault option.

C♯
var request = new PaymentMethodRequest
{
    CustomerId = "131866",
    PaymentMethodNonce = nonceFromTheClient,
    Options = new PaymentMethodOptionsRequest
    {
        MakeDefault = true
    }
};

Result<PaymentMethod> result = gateway.PaymentMethod.Create(request);

New payment method with billing address

To specify a billing address when creating a new payment method, use the BillingAddress option (ignored if the payment method is a PayPal account). Note that the specified billing address will override any address specified during nonce creation.

C♯
var request = new PaymentMethodRequest
{
    CustomerId = "131866",
    PaymentMethodNonce = nonceFromTheClient,
    BillingAddress = new PaymentMethodAddressRequest
    {
        StreetAddress = "123 Abc Way"
    }
};

Result<PaymentMethod> result = gateway.PaymentMethod.Create(request);

New payment method with existing billing address

If a customer already has an address you'd like to use, you can create a new payment method with that address.

C♯
var request = new PaymentMethodRequest
{
    CustomerId = "131866",
    PaymentMethodNonce = nonceFromTheClient,
    BillingAddressId = "the-billing-address-id"
};

Result<PaymentMethod> result = gateway.PaymentMethod.Create(request);

Preventing duplicate payment methods

If a payment method exists in your Vault and you do not want to create a new payment method, you can reject duplicates by using the FailOnDuplicatePaymentMethod option. Note: This option will be ignored for PayPal, Pay with Venmo, Apple Pay, Google Pay, and Samsung Pay payment methods.

C♯
var request = new PaymentMethodRequest
{
    CustomerId = "131866",
    PaymentMethodNonce = nonceFromTheClient,
    Options = new PaymentMethodOptionsRequest
    {
        FailOnDuplicatePaymentMethod = true
    }
};

Result<PaymentMethod> result = gateway.PaymentMethod.Create(request);

Card verification

By default we will run credit card validations but not perform verification. 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. If you choose to manually verify cards, set verifyCard to true.

C♯
PaymentMethodRequest request = new PaymentMethodRequest
{
    CustomerId = "the_customer_id",
    PaymentMethodNonce = nonceFromTheClient,
    Options = new PaymentMethodOptionsRequest
    {
        VerifyCard = true
    }
};

Result<PaymentMethod> result = gateway.PaymentMethod.Create(request);
important

If you are using our Advanced Fraud Tools, we strongly recommend passing deviceData each time you verify a card.

Payment method nonces vs. raw card data

While it is possible to pass both raw card data and a payment method nonce in the same call, we recommend passing only a payment method nonce.

Passing both will result in a payment method that has a mix of their attributes, with precedence given to the fields individually, then to the attributes of the payment method nonce. For example, if you pass both a card number and a payment method nonce, the payment method will have the number you passed explicitly, but the rest of the attributes will be obtained through the nonce.