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 - Retrieve
Retrieve the payment method session
GET
/
v2
/
payment-method-session
/
{id}
Payment Method Session - Retrieve
Copy
Ask AI
curl --request GET \
--url https://sandbox.hyperswitch.io/v2/payment-method-session/{id} \
--header 'api-key: <api-key>'
Copy
Ask AI
{
"id": "12345_pms_01926c58bc6e77c09e809964e72af8c8",
"customer_id": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
"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>"
},
"psp_tokenization": {
"tokenization_type": "single_use",
"connector_id": "<string>"
},
"network_tokenization": {
"enable": "Enable"
},
"tokenization_data": "<any>",
"expires_at": "2023-01-18T11:04:09.922Z",
"client_secret": "<string>",
"return_url": "<string>",
"next_action": {
"redirect_to_url": "<string>",
"type": "redirect_to_url"
},
"authentication_details": {
"status": "succeeded",
"error": {
"code": "<string>",
"message": "<string>",
"unified_code": "<string>",
"unified_message": "<string>",
"network_advice_code": "<string>",
"network_decline_code": "<string>",
"network_error_message": "<string>"
}
},
"associated_payment_methods": [
"<string>"
],
"associated_token_id": "12345_tok_01926c58bc6e77c09e809964e72af8c8"
}
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 - Retrieve
Copy
Ask AI
curl --request GET \
--url https://sandbox.hyperswitch.io/v2/payment-method-session/{id} \
--header 'api-key: <api-key>'
Copy
Ask AI
{
"id": "12345_pms_01926c58bc6e77c09e809964e72af8c8",
"customer_id": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
"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>"
},
"psp_tokenization": {
"tokenization_type": "single_use",
"connector_id": "<string>"
},
"network_tokenization": {
"enable": "Enable"
},
"tokenization_data": "<any>",
"expires_at": "2023-01-18T11:04:09.922Z",
"client_secret": "<string>",
"return_url": "<string>",
"next_action": {
"redirect_to_url": "<string>",
"type": "redirect_to_url"
},
"authentication_details": {
"status": "succeeded",
"error": {
"code": "<string>",
"message": "<string>",
"unified_code": "<string>",
"unified_message": "<string>",
"network_advice_code": "<string>",
"network_decline_code": "<string>",
"network_error_message": "<string>"
}
},
"associated_payment_methods": [
"<string>"
],
"associated_token_id": "12345_tok_01926c58bc6e77c09e809964e72af8c8"
}
Assistant
Responses are generated using AI and may contain mistakes.