Customers
The customer object is an important component of the Braintree gateway. Use customers to store and organize payment methods. A single customer can have multiple payment methods.
This guide will walk you through the basics. See Customer Request and Customer Response references for complete details. Make sure to include the customer's email and phone information if planning to use Risk Products.
Create
Use Customer: Create
to add new customers.
You can create just a customer without an associated payment method, and the operation will be successful if all customer validations pass:
- Callbacks
- Promises
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
});
Create with payment method
You can also create a customer with an associated payment method:
- Callbacks
- Promises
gateway.customer.create({
firstName: "Charity",
lastName: "Smith",
paymentMethodNonce: nonceFromTheClient
}, (err, result) => {
result.success;
// true
result.customer.id;
// e.g 160923
result.customer.paymentMethods[0].token;
// e.g f28wm
});
Success depends on both customer validations and payment method validations, and whether the payment method is verified (if card verification is enabled).
See the reference and more examples of creating a customer .
Update
Use Customer: Update
to update an existing customer:
- Callbacks
- Promises
gateway.customer.update("theCustomerId", {
firstName: "New First Name",
lastName: "New Last Name"
}, (err, result) => {
});
If the customer can't be found, it will return a notFoundError
.
See the reference and more examples of updating a customer .
Find
Use Customer: Find
to find a customer by ID:
- Callbacks
- Promises
gateway.customer.find("theCustomerId", function(err, customer) {
});
If the customer can't be found, it will return a notFoundError
.
The return value of this call will be a Customer
response object.
Delete
Use Customer: Delete
to delete a customer and its payment methods using the customer's ID:
- Callbacks
- Promises
gateway.customer.delete("theCustomerId", (err) => {
err;
// null
});
If the customer can't be found, it will return a notFoundError
.