Payment Methods

A payment method represents transactable payment information such as credit card details or a customer's authorization to charge a PayPal or Venmo account. Payment methods belong to a customer, are securely stored in the Braintree Vault, and have a paymentMethodToken attribute that you can store on your servers (with reduced PCI compliance burden) and later use to create transactions.

Create

Use paymentMethod.create() to create a payment method for an existing customer:

gateway.paymentMethod.create({
  customerId: "12345",
  paymentMethodNonce: nonceFromTheClient
}, function (err, result) { });
Node.js

Alternatively, you can create a new customer with a payment method using customer.create() with the paymentMethodNonce parameter.

Once successfully created, you can use transaction.sale() with the paymentMethodToken parameter to create a transaction.

Credit card verification

If the payment method is a credit card, you can use options.verifyCard to ensure that Braintree attempts to verify that the credit card number matches a valid, open account.

gateway.paymentMethod.create({
  customerId: "theCustomerId",
  paymentMethodNonce: nonceFromTheClient,
  options: {
    verifyCard: true,
    verificationMerchantAccountId: "theMerchantAccountId",
  }
}, function (err, result) {
});
Node.js

If you wish to always run verification regardless of the presence of verifyCard, you can turn on card verification in the Control Panel.

Card verification can be performed through the customer API or the credit card API. See also:

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

Verification results

The result of a paymentMethod.create() may contain a verification result object. The verification result object will only be present if a verification ran and was returned with a status of "processor_declined" or "gateway_rejected". You can check the processor response code and processor response text for the specific reason that a verification was "processor_declined". Successful results will not return a verification result object.

gateway.paymentMethod.create({
    customerId: "the_customer_id",
    paymentMethodNonce: nonceFromTheClient,
    options: {
      verifyCard: true
    }
}, function (err, result) {
  result.success;
  // false

  result.verification.status;
  // "processor_declined"

  result.verification.processorResponseCode;
  // "2000"

  result.verification.processorResponseText;
  // "Do Not Honor"
});
Node.js

If the status is "gateway_rejected", you can check the gatewayRejectionReason for the specific reason. Learn more about gateway rejections.

result.success;
// false

result.verification.status;
// "gateway_rejected"

result.verification.gatewayRejectionReason;
// "cvv"
Node.js

Update

Use paymentMethod.update() to update an existing payment method.

Make default

Use the makeDefault option to set a payment method as the default for its customer:

gateway.paymentMethod.update("theToken", {
  options: {
    makeDefault: true
  }
}, function (err, result) {
});
Node.js

Billing address

Update the billing address:

gateway.paymentMethod.update("theToken", {
  billingAddress: {
    streetAddress: "100 Maple Lane",
    options: {
      updateExisting: true
    }
  }
}, function (err, result) {
});
Node.js

You can also omit the updateExisting option to create a new billing address for just this payment method.

See the reference and more examples of updating a payment method. If you want to update both payment method and customer information together, use customer.update().

Find

Use paymentMethod.find() to find a payment method:

gateway.paymentMethod.find("token", function (err, paymentMethod) {});
Node.js

If the payment method cannot be found, the err in the callback will be set to a not found error.

gateway.paymentMethod.find("unknown", function (err, paymentMethod) {
  err.type; // braintree.errorTypes.notFoundError
});
Node.js

The return value of the paymentMethod.find() call will be a PaymentMethod response object.

Delete

Use paymentMethod.delete() to delete a payment method:

gateway.paymentMethod.delete("theToken", function (err) {});
Node.js

Still Have Questions?

If you can’t find an answer, give us a call at 877.434.2894 or email our Support team.