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
- Revenue Recovery
Payment Method Session
Payment Method Session - List Payment Methods
List payment methods for the given payment method session. This endpoint lists the enabled payment methods for the profile and the saved payment methods of the customer.
GET
/
v2
/
payment-method-session
/
{id}
/
list-payment-methods
Payment Method Session - List Payment Methods
Copy
Ask AI
curl --request GET \
--url https://sandbox.hyperswitch.io/v2/payment-method-session/{id}/list-payment-methods \
--header 'api-key: <api-key>'
Copy
Ask AI
{
"payment_methods_enabled": [
{
"card_networks": [
{
"card_network": "Visa",
"surcharge_details": {
"surcharge": {
"type": "fixed",
"value": 123
},
"tax_on_surcharge": {
"percentage": 123
},
"display_surcharge_amount": 123,
"display_tax_on_surcharge_amount": 123,
"display_total_surcharge_amount": 123
},
"eligible_connectors": [
"stripe",
"adyen"
]
}
],
"payment_method_type": "card",
"payment_method_subtype": "ach",
"required_fields": [
{
"required_field": "<string>",
"display_name": "<string>",
"field_type": "user_card_number",
"value": "<string>"
}
]
}
],
"customer_payment_methods": [
{
"id": "12345_pm_01926c58bc6e77c09e809964e72af8c8",
"payment_token": "7ebf443f-a050-4067-84e5-e6f6d4800aef",
"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>"
}
}
]
}
Authorizations
Ephemeral keys provide temporary access to singular data, such as access to a single customer object for a short period of time.
Path Parameters
The unique identifier for the Payment Method Session
Response
200
application/json
The payment method session is retrieved successfully
The response is of type object
.
Payment Method Session - List Payment Methods
Copy
Ask AI
curl --request GET \
--url https://sandbox.hyperswitch.io/v2/payment-method-session/{id}/list-payment-methods \
--header 'api-key: <api-key>'
Copy
Ask AI
{
"payment_methods_enabled": [
{
"card_networks": [
{
"card_network": "Visa",
"surcharge_details": {
"surcharge": {
"type": "fixed",
"value": 123
},
"tax_on_surcharge": {
"percentage": 123
},
"display_surcharge_amount": 123,
"display_tax_on_surcharge_amount": 123,
"display_total_surcharge_amount": 123
},
"eligible_connectors": [
"stripe",
"adyen"
]
}
],
"payment_method_type": "card",
"payment_method_subtype": "ach",
"required_fields": [
{
"required_field": "<string>",
"display_name": "<string>",
"field_type": "user_card_number",
"value": "<string>"
}
]
}
],
"customer_payment_methods": [
{
"id": "12345_pm_01926c58bc6e77c09e809964e72af8c8",
"payment_token": "7ebf443f-a050-4067-84e5-e6f6d4800aef",
"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>"
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.