Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions about-hyperswitch/ai-resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@
hidden: true
noIndex: true
icon: brain-circuit
description: Explore AI-powered tools to interact with Juspay Hyperswitch through conversational interfaces and execute API operations
---

# AI Resources

AI resources enable you to intelligently interact with the entire Hyperswitch ecosystem through conversational AI. Whether you're a developer, product manager, or business stakeholder, you can ask both technical and non-technical questions, execute real API operations, and verify results - all through natural language conversations.
AI resources enable you to intelligently interact with the entire Juspay Hyperswitch ecosystem through conversational AI. Whether you're a developer, product manager, or business stakeholder, you can ask both technical and non-technical questions, execute real API operations, and verify results - all through natural language conversations.

## 1. DeepWikis - AI-Powered Documentation

Expand Down Expand Up @@ -67,5 +68,5 @@ Execute real [Hyperswitch API](https://api-reference.hyperswitch.io/introduction

{% hint style="warning" %}
Responses from AI tools can be incorrect, use with caution.\
and reach out to us on [slack](https://inviter.co/hyperswitch-slack) for any questions or further support.
Reach out to us on [Slack](https://inviter.co/hyperswitch-slack) for any questions or further support.
{% endhint %}
5 changes: 3 additions & 2 deletions about-hyperswitch/ai-resources/setup-mcp-server.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
icon: user-robot-xmarks
description: Configure the Juspay Hyperswitch MCP server to execute sandbox API operations directly through conversational AI assistants
---

# Setup MCP Server

{% hint style="danger" %}
This MCP server is only meant for product exploration while using sandbox environment.\
**DO NOT USE Hyperswitch API Key from the PRODUCTION ENVIRONMENT.**
**DO NOT USE Juspay Hyperswitch API Key from the PRODUCTION ENVIRONMENT.**
{% endhint %}

**Prerequisites**: Ensure you have an MCP client installed (Cursor, Claude Desktop, Cline, etc.)
Expand Down Expand Up @@ -51,5 +52,5 @@ You can head on to payment section in [Hyperswitch Control Center](https://app.h

{% hint style="warning" %}
Responses from AI tools can be incorrect, use with caution.\
and reach out to us on [slack](https://inviter.co/hyperswitch-slack) for any questions or further support.
Reach out to us on [Slack](https://inviter.co/hyperswitch-slack) for any questions or further support.
{% endhint %}
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
icon: hand-holding-circle-dollar
description: Understand the payment method lifecycle and two-step integration pattern for secure transaction processing
---

# Payment Method (Card)

Hyperswitch provides flexible payment processing with multiple flow patterns to accommodate different business needs. The system supports one-time payments, saved payment methods, and recurring billing through a comprehensive API design.
Juspay Hyperswitch provides flexible payment processing with multiple flow patterns to accommodate different business needs. The system supports one-time payments, saved payment methods, and recurring billing through a comprehensive API design.

{% hint style="info" %}
### Integration Path
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
hidden: true
icon: money-bills-simple
description: Tokenize and vault payment credentials using the Juspay Hyperswitch Payment Method SDK for secure server-to-server transactions
---

# Copy of Payments
Expand Down Expand Up @@ -44,7 +45,7 @@ Hyperswitch returns the `payment_method_id` in the response. You can use this pa

#### **Payment :** 

To charge the customer you will will have to call the [create and confirm](https://api-reference.hyperswitch.io/v2/payments/payments--create-and-confirm-intent) API and pass the `payment_method_id` along with `confirm` as `true` 
To charge the customer you will have to call the [create and confirm](https://api-reference.hyperswitch.io/v2/payments/payments--create-and-confirm-intent) API and pass the `payment_method_id` along with `confirm` as `true` 

{% hint style="info" %}
All Vault API (V2) requests require authentication using specific API keys generated from your Vault Merchant account. These keys are distinct from your standard payment processing keys.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
description: Hyperswitch is designed to facilitate the management of saved payment methods
description: Manage customer payment methods securely using the Juspay Hyperswitch SDK while minimizing PCI compliance scope
icon: bars-progress
---

# Payment Methods Management

The Hyperswitch Payment Methods Management SDK provides a secure solution for merchants to handle and store payment information without the burden of PCI DSS compliance requirements. By leveraging Hyperswitch's Vault service, merchants can securely store customer payment methods (credit cards, digital wallets, etc.) while minimizing their exposure to sensitive payment data.
The Juspay Hyperswitch Payment Methods Management SDK provides a secure solution for merchants to handle and store payment information without the burden of PCI DSS compliance requirements. By leveraging Hyperswitch's Vault service, merchants can securely store customer payment methods (credit cards, digital wallets, etc.) while minimizing their exposure to sensitive payment data.

### **Key Features of Payment Method Management in Hyperswitch**

Expand Down
47 changes: 22 additions & 25 deletions about-hyperswitch/payment-suite-1/payment-method-card/payments.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
icon: money-bills-simple
description: Execute payment transactions using Juspay Hyperswitch tokenized methods for both guest checkout and returning customer scenarios
---

# Payments
Expand All @@ -8,15 +9,13 @@ The Payment Method SDK and `/payment-methods` API work in tandem with the `/paym

### Guest Checkout Flow (S2S)

1. Collect card details and tokenise with HS [Create PM API](https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--create-v1) to get a [PM ID](https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--create-v1#response-id) (payment\_methd\_id)
1. Collect card details and tokenize with HS [Create PM API](https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--create-v1) to get a [PM ID](https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--create-v1#response-id) (payment_method_id)
2. Use the PM ID to authorize the [payment request](https://api-reference.hyperswitch.io/v1/payments/payments--confirm) during order confirmation
3. For extended sessions, where token expires before order completion, create a new PM ID with the same card details using the Create PM API

{% hint style="info" %}
Note - The PM ID in case of guest checkout is volatile in nature and has a default expiry of 1-hour which can be extended by Merchant at a session level.\
\
For guest checkout flow the PM ID is NOT unique to Customer + Payment method combination.
{% endhint %}
> **Note:** The PM ID in case of guest checkout is volatile in nature and has a default expiry of 1-hour which can be extended by Merchant at a session level.
>
> For guest checkout flow the PM ID is NOT unique to Customer + Payment method combination.

### Customer Checkout Flow - First Time Payment (S2S)

Expand All @@ -25,40 +24,38 @@ For guest checkout flow the PM ID is NOT unique to Customer + Payment method com
3. Use the PM ID to authorize the [payment request](https://api-reference.hyperswitch.io/v1/payments/payments--confirm) during order confirmation
4. For extended sessions, where token expires before order completion update the PM with CVV using the [Update PM API](https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--update-v1) and use this PM ID to complete the payment

{% hint style="info" %}
Note - The CVV storage is volatile in nature and can be stored for 1-hour be default which can be extended by Merchant at a session level. \
\
For logged-in user checkout flow the PM ID is unique to Customer + Payment method combination.
{% endhint %}
> **Note:** The CVV storage is volatile in nature and can be stored for 1-hour by default which can be extended by Merchant at a session level.
>
> For logged-in user checkout flow the PM ID is unique to Customer + Payment method combination.

### Customer Checkout Flow - Repeat Purchase (S2S)

1. Fetch the stored cards for the customer using [List Saved PMs API ](https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--list-customer-saved-payment-methods-v1)which returns the masked card details with corresponding PM ID 
2. Update the PM ID of the user selected card along with CVV value collected from the user using the [Update PM API](https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--update-v1) 
1. Fetch the stored cards for the customer using [List Saved PMs API](https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--list-customer-saved-payment-methods-v1) which returns the masked card details with corresponding PM ID 
2. Update the PM ID of the user selected card along with CVV value collected from the user using the [Update PM API](https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--update-v1)
3. Use the PM ID to authorize the [payment request](https://api-reference.hyperswitch.io/v1/payments/payments--confirm) during order confirmation
4. For extended sessions, where token expires before order completion update the PM again with the collected CVV and use this PM ID to complete the payment

### Payment Method SDK Checkout - Guest, New Customer and Repeat Customer Flows

1. Create a PM session using the [Session Create API ](https://api-reference.hyperswitch.io/v2/payment-method-session/payment-method-session--create-v1)to get a [client secret](https://api-reference.hyperswitch.io/v2/payment-method-session/payment-method-session--create-v1#response-client-secret)
2. For guest user, pass "storage\_type" as "volatile" and skip sending the Customer ID
3. Initialize and mount the [Vault SDK](https://docs.hyperswitch.io/explore-hyperswitch/payments-modules/vault/vault-sdk-integration-1#id-2.2-fetch-the-payment-method-session-and-mount-the-payment-methods-management-element) using the client secret and session\_id 
1. Create a PM session using the [Session Create API](https://api-reference.hyperswitch.io/v2/payment-method-session/payment-method-session--create-v1) to get a [client secret](https://api-reference.hyperswitch.io/v2/payment-method-session/payment-method-session--create-v1#response-client-secret)
2. For guest user, pass `storage_type` as `volatile` and skip sending the Customer ID
3. Initialize and mount the [Vault SDK](https://docs.hyperswitch.io/explore-hyperswitch/payments-modules/vault/vault-sdk-integration-1#id-2.2-fetch-the-payment-method-session-and-mount-the-payment-methods-management-element) using the client secret and session_id 
4. The SDK now takes care of the following flows based on user action:
5. Post which the SDK submits the card details via the [PM Confirm API](https://api-reference.hyperswitch.io/v1/payments/payments--confirm) and returns back a [PM Token](https://api-reference.hyperswitch.io/v1/payments/payments--confirm#response-payment-token-one-of-0) (short-lived) in the response
6. Pass this PM token to Merchant Server and exchange for a PM ID from the server using the [PM token exchange API](https://api-reference.hyperswitch.io/v2/payment-methods/payment-method--payment-method-token-to-payment-method-id-v1)
7. Use this PM ID to authorize the [payment request](https://api-reference.hyperswitch.io/v1/payments/payments--confirm)

{% hint style="info" %}
Note - When using the HS SDK, the response always contains a temp token and you’ll need to exchange it to get the PM ID via a S2S call.
{% endhint %}
Note - When using the HS SDK, the response always contains a temp token and you'll need to exchange it to get the PM ID via a S2S call.
7. Use this PM ID to authorize the [payment request](https://api-reference.hyperswitch.io/v1/payments/payments--confirm)

### HS SDK Checkout for repeat customer - no CVV flow

1. Create a PM session using the [Session Create API ](https://api-reference.hyperswitch.io/v2/payment-method-session/payment-method-session--create-v1)to get a [client secret](https://api-reference.hyperswitch.io/v2/payment-method-session/payment-method-session--create-v1#response-client-secret)
2. Initialize and mount the [Vault SDK](https://docs.hyperswitch.io/explore-hyperswitch/payments-modules/vault/vault-sdk-integration-1#id-2.2-fetch-the-payment-method-session-and-mount-the-payment-methods-management-element) using the client secret and session\_id
3. The SDK lists the previously saved cards for customers to select 
4. If the card has been vaulted previously with an MIT setup for it, CVV is not collected for it and the SDK returns back a [PM Token](https://api-reference.hyperswitch.io/v1/payments/payments--confirm#response-payment-token-one-of-0) (short-lived) in the responseNote - The PM ID in case of guest checkout is volatile in nature and has a default expiry of 1-hour which can be extended by Merchant at a session level
1. Create a PM session using the [Session Create API](https://api-reference.hyperswitch.io/v2/payment-method-session/payment-method-session--create-v1) to get a [client secret](https://api-reference.hyperswitch.io/v2/payment-method-session/payment-method-session--create-v1#response-client-secret)
2. Initialize and mount the [Vault SDK](https://docs.hyperswitch.io/explore-hyperswitch/payments-modules/vault/vault-sdk-integration-1#id-2.2-fetch-the-payment-method-session-and-mount-the-payment-methods-management-element) using the client secret and session_id
3. The SDK lists the previously saved cards for customers to select
4. If the card has been vaulted previously with an MIT setup for it, CVV is not collected for it and the SDK returns back a [PM Token](https://api-reference.hyperswitch.io/v1/payments/payments--confirm#response-payment-token-one-of-0) (short-lived) in the response

Note - The PM ID in case of guest checkout is volatile in nature and has a default expiry of 1-hour which can be extended by Merchant at a session level

{% hint style="info" %}
When using the HS SDK, the response always contains a temp token and youll need to exchange it to get the PM ID via a S2S call. Highlighted in detail in (4.)
When using the HS SDK, the response always contains a temp token and you'll need to exchange it to get the PM ID via a S2S call.
{% endhint %}
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
description: Vault your card and use proxy end point for payment processing
description: Tokenize cards in Juspay Hyperswitch Vault and process payments through the proxy endpoint to any PSP
icon: almost-equal-to
---

# Proxy

The Proxy Payments Service allows merchants to tokenize cards via Hyperswitch Vault and make API calls to PSPs using those tokens. The Vault intercepts these requests, replaces tokens with raw card data (de-tokenization), and forwards them securely to the PSP.
The Proxy Payments Service allows merchants to tokenize cards via Juspay Hyperswitch Vault and make API calls to PSPs using those tokens. The Vault intercepts these requests, replaces tokens with raw card data (de-tokenization), and forwards them securely to the PSP.

Key Highlights:

Expand Down Expand Up @@ -99,7 +99,7 @@ The customer enters their card details directly into the SDK-managed widget. Upo

The merchant server calls the "List Payment Methods" API using the `session_id`. Hyperswitch returns a list of payment methods associated with the customer, from which the merchant server selects the appropriate `PM_ID` (Payment Method ID) to use for the transaction.

**Execute Proxy Payment (Server-Side)** 
**5. Execute Proxy Payment (Server-Side)** 

The merchant server initiates the payment by sending a request to the [Hyperswitch vault proxy](https://docs.hyperswitch.io/~/revisions/01bZ2maqjwpnmrttix7i/explore-hyperswitch/payments-modules/vault/hyperswitch-vault-pass-through-proxy-payments) endpoint using the `payment_method_id` . The proxy securely replaces the token with the actual card data from the Vault and forwards the request to the Payment Service Provider (PSP), returning the final payment response to the merchant.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
hidden: true
description: Integrate the Payment Method Management SDK to securely store and manage customer payment instruments
---

# Payment Method Management SDK

The Hyperswitch Payment Methods Management SDK provides a secure solution for merchants to handle and store payment information without the burden of PCI DSS compliance requirements. By leveraging Hyperswitch's Vault service, merchants can securely store customer payment methods (credit cards, digital wallets, etc.) while minimizing their exposure to sensitive payment data.
The Juspay Hyperswitch Payment Methods Management SDK provides a secure solution for merchants to handle and store payment information without the burden of PCI DSS compliance requirements. By leveraging Hyperswitch's Vault service, merchants can securely store customer payment methods (credit cards, digital wallets, etc.) while minimizing their exposure to sensitive payment data.

#### Why Integrate the Management SDK?

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
hidden: true
description: Explore Payment with Vault flow patterns to balance user experience engineering complexity and PCI compliance
---

# Payment with Vault Flow

In the Payment with Vault flow setup, Hyperswitch acts as the central intelligence layer. You interact with a single unified API, and Hyperswitch manages the entire payment lifecycle across multiple processors.
In the Payment with Vault flow setup, Juspay Hyperswitch acts as the central intelligence layer. You interact with a single unified API, and Hyperswitch manages the entire payment lifecycle across multiple processors.

#### How it Works

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
description: >-
Best for merchants seeking a pre-built, optimized payment UI backed by the
full Hyperswitch stack for secure data storage and routing.
description: Use the pre-built Juspay Hyperswitch SDK with Juspay Hyperswitch Vault for secure payment processing without PCI scope
---

# Hyperswitch SDK + Hyperswitch Vault Setup

In this approach, the Hyperswitch SDK is used on the frontend to capture card details. Card data is securely sent to the Hyperswitch backend and stored in Hyperswitch Vault. Payment orchestration, routing, and connector logic are handled entirely by the Hyperswitch backend.
In this approach, the Juspay Hyperswitch SDK is used on the frontend to capture card details. Card data is securely sent to the Juspay Hyperswitch backend and stored in Juspay Hyperswitch Vault. Payment orchestration, routing, and connector logic are handled entirely by the Hyperswitch backend.

The merchant uses the Hyperswitch Dashboard to configure connectors, routing rules, and orchestration logic. All payment requests are initiated using vault tokens, and raw card data never reaches merchant systems. Since card details are handled entirely by Hyperswitch, merchants are not required to be PCI DSS compliant for card data handling. 

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
description: >-
Best for PCI compliant merchants requiring full control over UI rendering
while leveraging Hyperswitch Vault for secure storage and payment routing.
description: Build custom payment UIs using your own SDK while leveraging Juspay Hyperswitch Vault for secure storage
---

# Merchant SDK + Hyperswitch Vault Setup

In this approach, the merchant uses their own frontend SDK to capture card details. Card data is sent to Hyperswitch backend and stored in Hyperswitch Vault. The merchant must ensure PCI DSS compliance for card capture.
In this approach, the merchant uses their own frontend SDK to capture card details. Card data is sent to Juspay Hyperswitch backend and stored in Juspay Hyperswitch Vault. The merchant must ensure PCI DSS compliance for card capture.

Once tokenized, Hyperswitch backend handles orchestration, routing, retries, and connector execution using vault tokens. All orchestration configuration is managed through the Hyperswitch Dashboard.

Expand Down
Loading