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 using a payment method nonce received from the client:

PHP
$result = $gateway->paymentMethod()->create([
    'customerId' => '12345',
    'paymentMethodNonce' => nonceFromTheClient
]);
This code snippet now uses gateway instance methods instead of class-level methods. Learn more.

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.

note

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.

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:

PHP
$updateResult = $gateway->paymentMethod()->update(
  'the_token',
  [
    'options' => [
      'makeDefault' => true
    ]
  ]
);
This code snippet now uses gateway instance methods instead of class-level methods. Learn more.

Billing address

Update the billing address:

PHP
$result = $gateway->paymentMethod()->update(
  'the_token',
  [
    'billingAddress' => [
        'streetAddress' => '100 Maple Lane',
        'options' => [
            'updateExisting' => true
        ]
    ]
]);
This code snippet now uses gateway instance methods instead of class-level methods. Learn more.

If the payment method can't be found, you'll receive a Braintree_Exception_NotFound exception.

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:

PHP
$paymentMethod = $gateway->paymentMethod()->find('token');
This code snippet now uses gateway instance methods instead of class-level methods. Learn more.

If the payment method can't be found, you'll receive a Braintree_Exception_NotFound exception.

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

Delete

Use PaymentMethod::delete() to delete a payment method:

PHP
$result = $gateway->paymentMethod()->delete('the_token');

$result->success
#=> true
This code snippet now uses gateway instance methods instead of class-level methods. Learn more.

If the payment method can't be found, you'll receive a Braintree_Exception_NotFound exception.

See also