Customer
Customer: Create
See also the Customer response object.
You can create a customer by itself, with a payment method, or with a credit card with a billing address.
- Node
gateway.customer.create({
firstName: "Jen",
lastName: "Smith",
company: "Braintree",
email: "jen@example.com",
phone: "312.555.1234",
fax: "614.555.5678",
website: "www.example.com"
}, (err, result) => {
result.success;
// true
result.customer.id;
// e.g. 494019
});
Parameters
company
Stringcompany
StringcountryCodeAlpha2
StringThe ISO 3166-1 alpha-2 country code specified in an address. The gateway only accepts specific alpha-2 values.
countryCodeAlpha3
StringThe ISO 3166-1 alpha-3 country code specified in an address. The gateway only accepts specific alpha-3 values.
countryCodeNumeric
StringThe ISO 3166-1 numeric country code specified in an address. The gateway only accepts specific numeric values.
countryName
StringThe country name specified in an address. We only accept specific country names.
extendedAddress
StringfirstName
StringcountryCode
StringnationalNumber
StringlastName
Stringlocality
StringphoneNumber
StringDeprecated.
We recommend using international_phone
. This functionality still exists in the gateway but is no longer documented. This parameter will be removed in the future.
postalCode
Stringregion
StringstreetAddress
StringcardholderName
Stringcvv
StringTypically 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.
expirationDate
StringTypically 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
StringTypically 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
StringTypically 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
StringTypically 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).
makeDefault
boolskipAdvancedFraudChecking
booleanIf the payment method is a credit card, prevents the verification from being evaluated as part of Premium Fraud Management Tools checks. Use with caution – once you've skipped checks for a verification, it is not possible to run them retroactively.
verificationAmount
StringSpecify the merchant account ID that you want to use to verify a card. Can't be a Braintree Marketplace sub-merchant account. For more details on merchant accounts in general, see merchantAccountId
on Transaction: Sale
.
verifyCard
boolIf 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.
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 Credit Card Verification
result if verification runs and is unsuccessful.
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
StringCardholder 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
StringTransaction identifier resulting from 3D Secure 2 authentication. This field must be supplied for Mastercard Identity Check.
eciFlag
StringThe value of the electronic commerce indicator (ECI) flag, which indicates the outcome of the 3DS authentication.
Accepted values for Mastercard:
00
= Failed or not attempted01
= Attempted02
= Success04
= Data-Only (Applies to limited processors)
Accepted values for all other card brands:
07
= Failed or not attempted06
= Attempted05
= Success
threeDSecureVersion
StringThe 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
StringTransaction 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
StringAn 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.
A collection of custom field/value pairs. Fields and values must be less than 255 characters. You must set up each custom field in the Control Panel prior to passing it with a request. Querying this value returns a collection of custom field values stored on the customer object.
deviceData
StringCustomer device information. Pass this value only if you have Premium Fraud Management Tools enabled and are adding credit card data to your Vault. Be sure to provide the full string received from the Braintree client SDK.
email
Stringfax
StringfirstName
Stringid
StringcountryCode
StringnationalNumber
StringlastName
StringpaymentMethodNonce
Stringphone
StringDeprecated.
We recommend using international_phone
. This functionality still exists in the gateway but is no longer documented. This parameter will be removed in the future.
Customer device information, which is sent directly to supported processors for fraud analysis. These fields are automatically populated if using Premium Fraud Management Tools. Currently only available when processing American Express via Amex Direct. Contact us with any questions.
customerBrowser
StringcustomerIp
StringtaxIdentifiers
arraycountryCode
StringThe ISO 3166-1 alpha-2 country code specified in an address. The gateway only accepts specific alpha-2 values.
identifier
Stringwebsite
StringExamples
Specify your own customer ID
You can optionally choose what you would like the ID to be. Customer IDs are case insensitive.
- Callback
- Promise
gateway.customer.create({
id: "customer_123",
firstName: "Katrina"
}, (err, result) => {
});
Blank customer
If you're only interested in storing a payment method without any customer information, you can create a blank customer:
Customer with a payment method
You can also create a payment method along with a customer. If all customer validations and credit card validations or PayPal account validations pass, and the credit card is verified (if supplied and verification is requested), success will return true.
If you do not specify a token for the payment method, as in the example above, the gateway will generate one. If you are using a custom integration, you can also choose what you want the token to be.
- Callback
- Promise
gateway.customer.create({
creditCard: {
token: "creditCard123",
},
paymentMethodNonce: nonceFromTheClient
}, (err, result) => {
});
Customer with a payment method and billing address
You can also pass in a billing address when creating a customer and payment method.
- Callback
- Promise
gateway.customer.create({
paymentMethodNonce: nonceFromTheClient,
creditCard: {
billingAddress: {
firstName: "Jen",
lastName: "Smith",
company: "Braintree",
streetAddress: "123 Address",
locality: "City",
region: "State",
postalCode: "12345"
}
}
}, (err, result) => {
});
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.
- Callback
- Promise
gateway.customer.create({
paymentMethodNonce: nonceFromTheClient,
firstName: "Fred",
lastName: "Jones",
creditCard: {
options: {
verifyCard: true
}
}
}, (err, result) => {
});
Use custom fields
Use custom fields to store additional data about your customers in Braintree. You'll need to configure your custom fields in the Control Panel to use them via the API.
Here is an example of setting custom fields with API names of custom_field_one
and custom_field_two
:
- Callback
- Promise
gateway.customer.create({
firstName: "Bob",
lastName: "Smith",
customFields: {
customFieldOne: "value one",
customFieldTwo: "value two"
}
}, (err, result) => {
result.customer.customFields["customFieldOne"]
// value one
result.customer.customFields["customFieldTwo"]
// value two
});