Get Started [BETA]
Essentials [BETA]
Payments Core APIs [BETA]
- Payments
- Payment Methods
- Payment Method Session
- Customers
- Refunds
Account management APIs [BETA]
- Organization
- Merchant Account
- Profile
- Connector Account
- API Key
- Routing
Other APIs [BETA]
- Proxy
- Tokenization
Customers
Payment Method - List Customer Saved Payment Methods
List the payment methods saved for a customer
GET
/
v2
/
customers
/
{id}
/
saved-payment-methods
Copy
curl --request GET \
--url https://sandbox.hyperswitch.io/v2/customers/{id}/saved-payment-methods \
--header 'api-key: <api-key>'
Copy
{
"customer_payment_methods": [
{
"id": "12345_pm_01926c58bc6e77c09e809964e72af8c8",
"customer_id": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
"payment_method_type": "card",
"payment_method_subtype": "ach",
"recurring_enabled": true,
"payment_method_data": {
"card": {
"issuer_country": "AF",
"last4_digits": "<string>",
"expiry_month": "<string>",
"expiry_year": "<string>",
"card_holder_name": "<string>",
"card_fingerprint": "<string>",
"nick_name": "<string>",
"card_network": "Visa",
"card_isin": "<string>",
"card_issuer": "<string>",
"card_type": "<string>",
"saved_to_locker": true
}
},
"bank": {
"mask": "<string>"
},
"created": "2023-01-18T11:04:09.922Z",
"requires_cvv": true,
"last_used_at": "2024-02-24T11:04:09.922Z",
"is_default": true,
"billing": {
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
},
"network_tokenization": {
"payment_method_data": {
"last4_digits": "<string>",
"issuer_country": "AF",
"network_token_expiry_month": "<string>",
"network_token_expiry_year": "<string>",
"nick_name": "<string>",
"card_holder_name": "<string>",
"card_isin": "<string>",
"card_issuer": "<string>",
"card_network": "Visa",
"card_type": "<string>",
"saved_to_locker": true
}
},
"psp_tokenization_enabled": true
}
]
}
Authorizations
Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.
Path Parameters
The unique identifier for the customer
Response
200
application/json
Payment Methods Retrieved
The response is of type object
.
Was this page helpful?
Copy
curl --request GET \
--url https://sandbox.hyperswitch.io/v2/customers/{id}/saved-payment-methods \
--header 'api-key: <api-key>'
Copy
{
"customer_payment_methods": [
{
"id": "12345_pm_01926c58bc6e77c09e809964e72af8c8",
"customer_id": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
"payment_method_type": "card",
"payment_method_subtype": "ach",
"recurring_enabled": true,
"payment_method_data": {
"card": {
"issuer_country": "AF",
"last4_digits": "<string>",
"expiry_month": "<string>",
"expiry_year": "<string>",
"card_holder_name": "<string>",
"card_fingerprint": "<string>",
"nick_name": "<string>",
"card_network": "Visa",
"card_isin": "<string>",
"card_issuer": "<string>",
"card_type": "<string>",
"saved_to_locker": true
}
},
"bank": {
"mask": "<string>"
},
"created": "2023-01-18T11:04:09.922Z",
"requires_cvv": true,
"last_used_at": "2024-02-24T11:04:09.922Z",
"is_default": true,
"billing": {
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
},
"network_tokenization": {
"payment_method_data": {
"last4_digits": "<string>",
"issuer_country": "AF",
"network_token_expiry_month": "<string>",
"network_token_expiry_year": "<string>",
"nick_name": "<string>",
"card_holder_name": "<string>",
"card_isin": "<string>",
"card_issuer": "<string>",
"card_network": "Visa",
"card_type": "<string>",
"saved_to_locker": true
}
},
"psp_tokenization_enabled": true
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.