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

Ruby
result = Braintree::PaymentMethod.create(
  :customer_id => "131866",
  :payment_method_nonce => nonce_from_the_client
)

Alternatively, you can create a new customer with a payment method using Braintree::Customer.create() with the payment_method_nonce parameter.

Once successfully created, you can use Braintree::Transaction.sale() with the payment_method_token parameter to create a transaction.

Update

Use Braintree::PaymentMethod.update() to update an existing payment method.

Make default

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

Ruby
result = Braintree::PaymentMethod.update(
  "the_token",
  :options => {
    :make_default => true
  }
)

Billing address

Update the billing address:

Ruby
result = Braintree::PaymentMethod.update(
  "the_token",
  :billing_address => {
    :street_address => "1 E Main St",
    :extended_address => "Suite 3",
    :locality => "Chicago",
    :region => "IL",
    :postal_code => "60622",
    :options => {
      :update_existing => true
    }
  }
)

If the payment method cannot be found, it will raise a Braintree::NotFoundError.

You can also omit the update_existing 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:

Ruby
payment_method = Braintree::PaymentMethod.find("token")

If the payment method cannot be found, it will raise a Braintree::NotFoundError.

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:

Ruby
result = Braintree::PaymentMethod.delete("the_token")

result.success?
# true

If the payment method cannot be found, it will raise a Braintree::NotFoundError.

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.