Payment Method Select
Displays the customer's saved payment methods and allows selection or adding new ones.
Usage
const paymentSelect = client.components.paymentMethodSelect({
containerId: 'payment-methods',
customerId: 'cus_xxx',
onSelect: (paymentMethod) => {
console.log('Selected:', paymentMethod.id);
},
onAddNew: (type) => {
console.log('Add new payment method:', type);
},
});Configuration
PaymentMethodSelectConfig
containerId
string
Yes
ID of the container element
customerId
string
Yes
Customer ID to fetch payment methods for
selectedPaymentMethodId
string
No
Pre-select a payment method
theme
ThemeConfig
No
Custom theme configuration
onSelect
(pm: PaymentMethod) => void
No
Called when a payment method is selected
onAddNew
(type: PaymentMethodType) => void
No
Called when "Add New" is clicked
onBack
() => void
No
Called when "Back" is clicked
onError
(error: Error) => void
No
Called on errors
Payment Method Types
The component supports these payment method types:
CARD
Credit or debit card
ACH
Bank account (ACH transfer)
PaymentMethod Object
The onSelect callback receives a PaymentMethod object:
Example
Display
The component shows:
List of saved payment methods with icons
Card brand and last 4 digits for cards
Bank name and last 4 digits for ACH
Radio buttons for selection
"Add Credit Card" and "Add Bank Account" buttons
"Continue to Payment" button when a method is selected
Last updated
Was this helpful?
