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
Payments
Payments - Payment Methods List
List the payment methods eligible for a payment. This endpoint also returns the saved payment methods for the customer when the customer_id is passed when creating the payment
GET
/
v2
/
payments
/
{id}
/
payment-methods
Copy
curl --request GET \
--url https://sandbox.hyperswitch.io/v2/payments/{id}/payment-methods \
--header 'X-Client-Secret: <x-client-secret>' \
--header 'X-Profile-Id: <x-profile-id>' \
--header 'api-key: <api-key>'
Copy
{
"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",
"payment_experience": "redirect_to_url",
"required_fields": {
"required_field": "<string>",
"display_name": "<string>",
"field_type": "user_card_number",
"value": "<string>"
},
"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
}
}
],
"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
Publishable keys are a type of keys that can be public and have limited scope of usage.
Headers
Profile ID associated to the payment intent
Client Secret Associated with the payment intent
Path Parameters
The global payment id
Response
200
application/json
Get the payment methods
The response is of type object
.
Was this page helpful?
Copy
curl --request GET \
--url https://sandbox.hyperswitch.io/v2/payments/{id}/payment-methods \
--header 'X-Client-Secret: <x-client-secret>' \
--header 'X-Profile-Id: <x-profile-id>' \
--header 'api-key: <api-key>'
Copy
{
"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",
"payment_experience": "redirect_to_url",
"required_fields": {
"required_field": "<string>",
"display_name": "<string>",
"field_type": "user_card_number",
"value": "<string>"
},
"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
}
}
],
"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.