PaymentMethod::update()

See also the PaymentMethod response object.

$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
    ]
  ]
);

Card verification

By default we will run credit card validations but not perform verification. Set the $verifyCard option to verify the card.

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

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.

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

To verify the AVS information of an existing payment method, pass the update request with an empty array and the 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. Navigate to Settings > Processing > CVV
3. Click Options
4. Uncheck CVV Not Provided (I)

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.