Payment Methods

PaymentMethod objects represent your customer’s payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

Related guides: Payment Methods and More Payment Scenarios.

Endpoints

Create a PaymentMethod

• POST /v1/payment_methods

Update a PaymentMethod

• POST /v1/payment_methods/:id

Retrieve a PaymentMethod

• GET /v1/payment_methods/:id

Retrieve a Customer's PaymentMethod

• GET /v1/customers/:id/payment_methods/:id

List PaymentMethods

• GET /v1/payment_methods

List a Customer's PaymentMethods

• GET /v1/customers/:id/payment_methods

Attach a PaymentMethod to a Customer

• POST /v1/payment_methods/:id/attach

Detach a PaymentMethod from a Customer

• POST /v1/payment_methods/:id/detach

Events

• payment_method.attached Occurs whenever a new payment method is attached to a customer.

• payment_method.automatically_updated Occurs whenever a payment method’s details are automatically updated by the network.

• payment_method.detached Occurs whenever a payment method is detached from a customer.

• payment_method.updated Occurs whenever a payment method is updated via the PaymentMethod update API.