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 Braintree_PaymentMethod::create() to create a payment method for an existing customer:

PHP
$result = Braintree_PaymentMethod::create([
    'customerId' => '12345',
    'paymentMethodNonce' => nonceFromTheClient
]);

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

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

Update

Use Braintree_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 = Braintree_PaymentMethod::update(
  'the_token',
  [
    'options' => [
      'makeDefault' => true
    ]
  ]
);

Billing address

Update the billing address:

PHP
$result = Braintree_PaymentMethod::update(
  'the_token',
  [
    'billingAddress' => [
        'streetAddress' => '100 Maple Lane',
        'options' => [
            'updateExisting' => true
        ]
    ]
]);

If the payment method cannot 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 Braintree_Customer::update().

Find

Use Braintree_PaymentMethod::find() to find a payment method:

PHP
$paymentMethod = Braintree_PaymentMethod::find('token');

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

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

Delete

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

PHP
$result = Braintree_PaymentMethod::delete('the_token');

$result->success
#=> true

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

See also

Still Have Questions?

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