PaymentMethod::update()

See also the PaymentMethod response object.

note

If you have card verification enabled, any updates made to credit cards are subject to those rules.

$result = $gateway->paymentMethod()->update(
  'the_token',
  [
    'billingAddress' => [
        'streetAddress' => '100 Maple Lane',
        'options' => [
            'updateExisting' => true
        ]
    ]
]);

If the payment method can't be found, you'll receive a Braintree\Exception\NotFound exception.

Arguments

Additional Parameters

Examples

Update billing address

To update the existing billing address when updating a payment method use the updateExisting option. If any other payment methods are associated with the same billing address, this will also update the billing address for those payment methods.

$result = $gateway->paymentMethod()->update(
  'the_token',
  [
    'billingAddress' => [
        'streetAddress' => '100 Maple Lane',
        'options' => [
            'updateExisting' => true
        ]
    ]
]);

If the payment method can't be found, you'll receive a Braintree\Exception\NotFound exception.

New billing address

If you don't use the updateExisting option, a new address will be created. The existing billing address will remain in the Vault associated with the customer.

$result = $gateway->paymentMethod()->update(
  'the_token',
  [
    'billingAddress' => [
        'firstName' => 'Drew',
        'lastName' => 'Smith',
        'company' => 'Smith Co.',
        'streetAddress' => '1 E Main St',
        'region' => 'IL',
        'postalCode' => '60622'
    ]
  ]
);

Update with existing billing address

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

$result = $gateway->paymentMethod()->update(
  'the_token',
  [
    'billingAddressId' => 'theBillingAddressId'
  ]
);

Updating a PayPal account token

The only fields that may be updated on a PayPal account are the token associated with that account, and setting the account as the default payment method for a customer.

$result = $gateway->payPalAccount()->update($originalToken, [
    'token' => $newToken
]);

Make default

If the payment method is a credit card or PayPal account, you can use this call to set the payment method as the customer's default. For all other payment method types, use defaultPaymentMethodToken on Customer::update() instead.

$updateResult = $gateway->paymentMethod()->update(
  'the_token',
  [
    'options' => [
      'makeDefault' => true
    ]
  ]
);

note

This only works with credit cards and PayPal accounts. We recommend updating the customer to set a default payment method.

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.

$result = $gateway->paymentMethod()->update('the_payment_method_token', [
    'paymentMethodNonce' => nonceFromTheClient,
    'options' => [
        'verifyCard' => true
    ]
]);

important

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

Updating with a nonce and additional parameters

When updating the credit card information with a nonce, you may pass additional parameters to update as well. Here is an example of updating a payment method and explicitly verifying the card.

important

If a field is passed from the client and included in the nonce data (such as postal code) it should not be passed as an explicit argument as well.

$result = $gateway->paymentMethod()->update(
  'the_token',
  [
    'paymentMethodNonce' => nonceFromTheClient,
    'billingAddress' => [
        'firstName' => 'Drew',
        'lastName' => 'Smith',
        'company' => 'Smith Co.',
        'streetAddress' => '1 E Main St',
        'region' => 'IL'
    ]
  ]
);

important

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

To verify the AVS information of an existing payment method, pass the update request with verify_card set to "true". Note that an update will create a transaction, so if your processing options are set to reject transactions without CVV, you will need to include CVV as a parameter, or disable this rule (see below).

To disable the CVV requirement:

1. Log into the Control Panel
2. Click on the gear icon in the top right corner
3. Click Fraud Management from the drop-down menu
4. Next to CVV, click the Options link
5. Under the Reject Transactions & Verifications If section, uncheck the CVV Not Provided (I) box

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.