atulp-hyperswitch · atulp-hyperswitch · Mar 23, 2026 · Mar 23, 2026
diff --git a/README (1).md b/README (1).md
@@ -2,6 +2,7 @@
 icon: screwdriver-wrench
 cover: .gitbook/assets/Hero visual V6 (2).png
 coverY: 0
+description: At Juspay, we believe payment infrastructure should be transparent, adaptable, and under merchants' control—not confined by vendor restrictions. That's why we've made the bold move to open-source o...
 ---
 
 # Get Started

diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 icon: compass
 cover: .gitbook/assets/Hero visual V6 (2).png
 coverY: 0
+description: Juspay Hyperswitch gives you full control over your payments infrastructure without the complexity of building from scratch. Whether you're validating a prototype or scaling globally, you can get s...
 ---
 
 # Exploration Guide

diff --git a/SUMMARY.md b/SUMMARY.md
@@ -1,3 +1,7 @@
+---
+description: Exploration Guide  Overview.md>)  Payment Suite  Payments Suite
+---
+
 # Table of contents
 
 ## About Hyperswitch

diff --git a/about-hyperswitch/ai-resources/README.md b/about-hyperswitch/ai-resources/README.md
@@ -2,6 +2,7 @@
 hidden: true
 noIndex: true
 icon: brain-circuit
+description: 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 ...
 ---
 
 # AI Resources

diff --git a/about-hyperswitch/ai-resources/setup-mcp-server.md b/about-hyperswitch/ai-resources/setup-mcp-server.md
@@ -1,5 +1,6 @@
 ---
 icon: user-robot-xmarks
+description: This MCP server is only meant for product exploration while using sandbox environment.\
 ---
 
 # Setup MCP Server

diff --git a/about-hyperswitch/payment-suite-1/payment-method-card/README.md b/about-hyperswitch/payment-suite-1/payment-method-card/README.md
@@ -1,5 +1,6 @@
 ---
 icon: hand-holding-circle-dollar
+description: 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 bil...
 ---
 
 # Payment Method (Card)

diff --git a/about-hyperswitch/payment-suite-1/payment-method-card/copy-of-payments.md b/about-hyperswitch/payment-suite-1/payment-method-card/copy-of-payments.md
@@ -1,6 +1,7 @@
 ---
 hidden: true
 icon: money-bills-simple
+description: The Payment Method SDK provides APIs to securely capture and tokenize payment credentials, with support for vaulting payment details during the initial checkout flow. Upon successful vaulting, a pe...
 ---
 
 # Copy of Payments

diff --git a/about-hyperswitch/payment-suite-1/payment-method-card/payments.md b/about-hyperswitch/payment-suite-1/payment-method-card/payments.md
@@ -1,5 +1,6 @@
 ---
 icon: money-bills-simple
+description: The Payment Method SDK and /payment-methods API work in tandem with the /payments API to achieve any business objective as listed below. &#x20;
 ---
 
 # Payments

diff --git a/about-hyperswitch/payment-suite-1/payment-method-management-sdk.md b/about-hyperswitch/payment-suite-1/payment-method-management-sdk.md
@@ -1,5 +1,6 @@
 ---
 hidden: true
+description: 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 ...
 ---
 
 # Payment Method Management SDK

diff --git a/about-hyperswitch/payment-suite-1/payment-with-vault-flow/README.md b/about-hyperswitch/payment-suite-1/payment-with-vault-flow/README.md
@@ -1,5 +1,6 @@
 ---
 hidden: true
+description: 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 multipl...
 ---
 
 # Payment with Vault Flow

diff --git a/about-hyperswitch/payment-suite-1/payments-cards/manual-capture/overcapture.md b/about-hyperswitch/payment-suite-1/payments-cards/manual-capture/overcapture.md
@@ -1,5 +1,6 @@
 ---
 icon: chart-diagram
+description: In card payments, Over Capture occurs when a merchant captures (settles) an amount greater than the originally authorized amount.
 ---
 
 # Overcapture

diff --git a/about-hyperswitch/payment-suite-1/payments-cards/recurring-payments.md b/about-hyperswitch/payment-suite-1/payments-cards/recurring-payments.md
@@ -1,5 +1,6 @@
 ---
 icon: arrows-rotate-reverse
+description: Recurring payments via Hyperswitch can be setup by passing some additional flags, as highligted below. The recurring payments are not tied to a specific amount or cycle and the merchant can charge ...
 ---
 
 # Recurring payments

diff --git a/about-hyperswitch/payment-suite-1/payments-cards/saved-card/README.md b/about-hyperswitch/payment-suite-1/payments-cards/saved-card/README.md
@@ -1,5 +1,6 @@
 ---
 icon: hard-drive
+description: 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, ...
 ---
 
 # Saved Card

diff --git a/about-hyperswitch/payment-suite-1/payments/README.md b/about-hyperswitch/payment-suite-1/payments/README.md
@@ -1,5 +1,6 @@
 ---
 icon: file-invoice-dollar
+description: 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 bil...
 ---
 
 # Payments (cards)

diff --git a/about-hyperswitch/payment-suite.md b/about-hyperswitch/payment-suite.md
@@ -2,6 +2,7 @@
 hidden: true
 noIndex: true
 icon: suitcase
+description: Hyperswitch provides a open-source, lightweight and full-stack solution to effortlessly and effectively manage payments. It provides you with:
 ---
 
 # Payment Suite

diff --git a/about-hyperswitch/payments-modules/README.md b/about-hyperswitch/payments-modules/README.md
@@ -1,5 +1,6 @@
 ---
 icon: diamonds-4
+description: Hyperswitch offers a modular, open-source payments infrastructure designed for flexibility and control. Apart from our Payment Suite offering, this solution allows businesses to pick and integrate ...
 ---
 
 # Payments Modules

diff --git a/connector-service/README.md b/connector-service/README.md
@@ -1,3 +1,7 @@
+---
+description: One integration. Any payment processor. Zero lock-in.
+---
+
 <div align="center">
 
 

diff --git a/connector-service/SUMMARY.md b/connector-service/SUMMARY.md
@@ -1,3 +1,7 @@
+---
+description: - Overview - Getting Started - Installation - Quick Start - Concepts
+---
+
 # Summary
 
 ## Getting Started

diff --git a/connector-service/architecture/README.md b/connector-service/architecture/README.md
@@ -1,3 +1,7 @@
+---
+description: If you've integrated multiple payment providers, you know the pain: - Stripe uses PaymentIntents
+---
+
 ## The Problem
 
 If you've integrated multiple payment providers, you know the pain:

diff --git a/connector-service/architecture/autogeneration-frameworks/code-generation.md b/connector-service/architecture/autogeneration-frameworks/code-generation.md
@@ -1,3 +1,7 @@
+---
+description: You get a working connector adapter in hours instead of weeks. Prism uses Grace, a code generation tool that reads payment provider API specs and produces Rust connector integration code with prope...
+---
+
 # Code Generation
 
 You get a working connector adapter in hours instead of weeks. Prism uses Grace, a code generation tool that reads payment provider API specs and produces Rust connector integration code with proper request/response transformations.

diff --git a/connector-service/architecture/autogeneration-frameworks/docs-generation.md b/connector-service/architecture/autogeneration-frameworks/docs-generation.md
@@ -1,3 +1,7 @@
+---
+description: You get API reference docs that stay current without anyone manually updating markdown files every time a field changes. Prism generates all /docs-generated content from the source proto definition...
+---
+
 # Documentation Generation
 
 You get API reference docs that stay current without anyone manually updating markdown files every time a field changes. Prism generates all `/docs-generated` content from the source proto definitions and a rules file that enforces consistency.

diff --git a/connector-service/architecture/autogeneration-frameworks/sdk-generation.md b/connector-service/architecture/autogeneration-frameworks/sdk-generation.md
@@ -1,3 +1,7 @@
+---
+description: You get idiomatic SDKs in Node.js, Python, Java, Rust, and Go without maintaining five separate codebases. Prism generates language-specific bindings from the same protobuf definitions, ensuring ev...
+---
+
 # SDK Generation
 
 You get idiomatic SDKs in Node.js, Python, Java, Rust, and Go without maintaining five separate codebases. Prism generates language-specific bindings from the same protobuf definitions, ensuring every SDK stays synchronized with the core API.

diff --git a/connector-service/architecture/autogeneration-frameworks/test-generation.md b/connector-service/architecture/autogeneration-frameworks/test-generation.md
@@ -1,3 +1,7 @@
+---
+description: You get regression tests for every connector without writing them by hand. Prism generates test suites from the proto definitions and a declarative test spec, then runs them against live sandboxes ...
+---
+
 # Test Generation
 
 You get regression tests for every connector without writing them by hand. Prism generates test suites from the proto definitions and a declarative test spec, then runs them against live sandboxes to catch breaking changes before they hit production.

diff --git a/connector-service/architecture/concepts/connector-settings-and-overrides.md b/connector-service/architecture/concepts/connector-settings-and-overrides.md
@@ -1,3 +1,7 @@
+---
+description: Sometimes you need to adjust behavior for a specific connector without changing your core integration logic. Prism gives you fine-grained control through settings and overrides that apply per-conne...
+---
+
 # Connector Settings and Overrides
 
 Sometimes you need to adjust behavior for a specific connector without changing your core integration logic. Prism gives you fine-grained control through settings and overrides that apply per-connector, per-request, or per-environment.

diff --git a/connector-service/architecture/concepts/connectors-services-subservices-methods.md b/connector-service/architecture/concepts/connectors-services-subservices-methods.md
@@ -1,3 +1,7 @@
+---
+description: Prism organizes payment operations into services that reflect how payments actually work in the real world. Some operations are independent. Others are follow-on actions that only make sense after ...
+---
+
 # Services and Methods
 
 Prism organizes payment operations into services that reflect how payments actually work in the real world. Some operations are independent. Others are follow-on actions that only make sense after a payment exists.

diff --git a/connector-service/architecture/concepts/core-components.md b/connector-service/architecture/concepts/core-components.md
@@ -1,3 +1,7 @@
+---
+description: Prism breaks down into four components that each solve a specific integration pain point. Understanding them helps you decide how to deploy and extend the system.
+---
+
 # Core Components
 
 Prism breaks down into four components that each solve a specific integration pain point. Understanding them helps you decide how to deploy and extend the system.

diff --git a/connector-service/architecture/concepts/environment-settings.md b/connector-service/architecture/concepts/environment-settings.md
@@ -1,3 +1,7 @@
+---
+description: Your code behaves differently in development, staging, and production. Prism lets you configure environments explicitly so test transactions don't hit live payment processors and production keys do...
+---
+
 # Environment Settings
 
 Your code behaves differently in development, staging, and production. Prism lets you configure environments explicitly so test transactions don't hit live payment processors and production keys don't leak into debug logs.

diff --git a/connector-service/architecture/concepts/error-handling.md b/connector-service/architecture/concepts/error-handling.md
@@ -1,3 +1,7 @@
+---
+description: Payment failures happen. Cards get declined. Networks timeout. Prism gives you structured error information that tells you exactly what went wrong and how to fix it, regardless of which payment pro...
+---
+
 # Error Handling
 
 Payment failures happen. Cards get declined. Networks timeout. Prism gives you structured error information that tells you exactly what went wrong and how to fix it, regardless of which payment processor generated the error.

diff --git a/connector-service/architecture/concepts/error-mapping.md b/connector-service/architecture/concepts/error-mapping.md
@@ -1,3 +1,7 @@
+---
+description: Payment processors speak different error languages. Stripe says "carddeclined." Adyen says "Refused." PayPal says "INSTRUMENTDECLINED." Prism translates all of them into a single set of error codes...
+---
+
 # Error Mapping
 
 Payment processors speak different error languages. Stripe says "card_declined." Adyen says "Refused." PayPal says "INSTRUMENT_DECLINED." Prism translates all of them into a single set of error codes your application handles once.

diff --git a/connector-service/architecture/concepts/id-and-object-modelling.md b/connector-service/architecture/concepts/id-and-object-modelling.md
@@ -1,3 +1,7 @@
+---
+description: Payment processors can't agree on how to name their IDs. Stripe uses pi3MqSCR2eZvKYlo2C1. Adyen uses 7914073381344578. Razorpay uses payABCdef123. This inconsistency breaks code completion, confuse...
+---
+
 # ID and Object Modeling
 
 Payment processors can't agree on how to name their IDs. Stripe uses `pi_3MqSCR2eZvKYlo2C1`. Adyen uses `7914073381344578`. Razorpay uses `pay_ABCdef123`. This inconsistency breaks code completion, confuses LLMs, and forces you to maintain different ID handling logic for each connector.

diff --git a/connector-service/architecture/concepts/library-modes-of-usage.md b/connector-service/architecture/concepts/library-modes-of-usage.md
@@ -1,3 +1,7 @@
+---
+description: Prism fits into your architecture two ways: as an embedded library or as a standalone microservice. The choice depends on your scale, team structure, and how you want to manage payment logic.
+---
+
 # Library Modes of Usage
 
 Prism fits into your architecture two ways: as an embedded library or as a standalone microservice. The choice depends on your scale, team structure, and how you want to manage payment logic.

diff --git a/connector-service/architecture/concepts/specs-and-dsl.md b/connector-service/architecture/concepts/specs-and-dsl.md
@@ -1,3 +1,7 @@
+---
+description: Prism uses a domain-specific language (DSL) built on Protocol Buffers that catches integration errors at compile time. Instead of discovering you forgot a required field in production, you get a co...
+---
+
 # Specs and DSL
 
 Prism uses a domain-specific language (DSL) built on Protocol Buffers that catches integration errors at compile time. Instead of discovering you forgot a required field in production, you get a compiler error immediately.

diff --git a/connector-service/architecture/overview.md b/connector-service/architecture/overview.md
@@ -1,3 +1,7 @@
+---
+description: title: Architecture Overview description: How Prism library is architected for multi-language SDKs and unified payment processing
+---
+
 # Architecture Overview
 
 ##

diff --git a/connector-service/architecture/versioning.md b/connector-service/architecture/versioning.md
@@ -1,3 +1,7 @@
+---
+description: Prism follows Semantic Versioning 2.0.0. A minor version upgrade or a patch will never break your existing integration.
+---
+
 # Versioning
 
 Prism follows [Semantic Versioning 2.0.0](https://semver.org/). A minor version upgrade or a patch will never break your existing integration.

diff --git a/connector-service/blogs/why-we-built-a-unified-payment-integration-library.md b/connector-service/blogs/why-we-built-a-unified-payment-integration-library.md
@@ -1,3 +1,7 @@
+---
+description: If you have ever integrated a payment processor, you know the drill. You read through a PDF that was last updated in 2019, figure out what combination of API keys goes in which header, discover tha...
+---
+
 # Why we built a Unified Payment Integration Library?
 
 If you have ever integrated a payment processor, you know the drill. You read through a PDF that was last updated in 2019, figure out what combination of API keys goes in which header, discover that "decline code 51" means something subtly different on this processor than the last one you dealt with, and then do it all over again when your business decides to add a second processor.

diff --git a/connector-service/docs-strategy.md b/connector-service/docs-strategy.md
@@ -1,3 +1,7 @@
+---
+description: This document outlines the documentation structure, organization, and strategy for the Unified Prism (UCS) project.
+---
+
 # Documentation Strategy
 
 

diff --git a/connector-service/frameworks/integrity-and-source-verification.md b/connector-service/frameworks/integrity-and-source-verification.md
@@ -1,3 +1,7 @@
+---
+description: Every payload from a payment processor carries two risks: tampering (someone modified the data in transit) and impersonation (someone forged the sender's identity). The Prism provides the tools to ...
+---
+
 # Integrity and Source Verification
 
 Every payload from a payment processor carries two risks: tampering (someone modified the data in transit) and impersonation (someone forged the sender's identity). The Prism provides the tools to eliminate both risks:

diff --git a/connector-service/frameworks/money-struct.md b/connector-service/frameworks/money-struct.md
@@ -1,3 +1,7 @@
+---
+description: Payment integrations are often confusing due to different formats in which payment amount is accepted and processed. A small error can cause large ramifications in terms of business impact.
+---
+
 # The Money Struct
 
 Payment integrations are often confusing due to different formats in which payment amount is accepted and processed. A small error can cause large ramifications in terms of business impact.

diff --git a/connector-service/frameworks/source-verification.md b/connector-service/frameworks/source-verification.md
@@ -1,3 +1,7 @@
+---
+description: A customer returns from a 3D Secure challenge. The URL shows status=success. Do you ship the order? Not yet. That URL could be forged. Prism verifies the source before you fulfill a single order.
+---
+
 # Source Verification
 
 A customer returns from a 3D Secure challenge. The URL shows `status=success`. Do you ship the order? Not yet. That URL could be forged. Prism verifies the source before you fulfill a single order.

diff --git a/connector-service/getting-started/create-order.md b/connector-service/getting-started/create-order.md
@@ -1,3 +1,7 @@
+---
+description: Now that the library is installed, let's create your first payment order (different payment processor's use different terminology - order, intent, transaction and so on). Conceptually, it represent...
+---
+
 # Quick Start
 
 Now that the library is installed, let's create your first payment order (different payment processor's use different terminology - order, intent, transaction and so on). Conceptually, it represents the user's intent to start a payment session. 

diff --git a/connector-service/getting-started/extend-to-more-flows.md b/connector-service/getting-started/extend-to-more-flows.md
@@ -1,3 +1,7 @@
+---
+description: YOu have implemmented the basic plumbing for routing payment processor agnostic APIs. All methods work the same way with the single interface regardless of which payment processor you use. That's t...
+---
+
 # Extending to More Flows
 
 YOu have implemmented the basic plumbing for routing payment processor agnostic APIs. All methods work the same way with the single interface regardless of which payment processor you use. That's the power you get with the library.

diff --git a/connector-service/getting-started/extending-to-more-flows.md b/connector-service/getting-started/extending-to-more-flows.md
@@ -1,3 +1,7 @@
+---
+description: After completing your first payment, this guide shows you how to implement additional payment flows and capabilities.
+---
+
 # Extending to More Flows
 
 After completing your [first payment](./first-payment.md), this guide shows you how to implement additional payment flows and capabilities.

diff --git a/connector-service/getting-started/first-payment.md b/connector-service/getting-started/first-payment.md
@@ -1,3 +1,7 @@
+---
+description: You will have paymentmethodid from Stripe if you depend on your processor for PCI compliance. Alternatively if your Stripe API keys are enabled to accept PCI compliant raw card data, that will suff...
+---
+
 # First Payment with Error Handling
 
 You will have `payment_method_id` from Stripe if you depend on your processor for PCI compliance. Alternatively if your Stripe API keys are enabled to accept PCI compliant raw card data, that will suffice to make the first payment.

diff --git a/connector-service/getting-started/installation.md b/connector-service/getting-started/installation.md
@@ -1,3 +1,7 @@
+---
+description: Start by installing the library for the programming language of your choice.
+---
+
 # Installation
 
 Start by installing the library for the programming language of your choice.

diff --git a/connector-service/rfcs/unified-payment-protocol-spec.md b/connector-service/rfcs/unified-payment-protocol-spec.md
@@ -1,3 +1,7 @@
+---
+description: | Field       | Value                                    | |-------------|------------------------------------------| | Status  | Draft                                    |
+---
+
 # RFC: Unified Payment Protocol (UPP)
 
 | Field       | Value                                    |

diff --git a/explore-hyperswitch/account-management/README.md b/explore-hyperswitch/account-management/README.md
@@ -1,5 +1,6 @@
 ---
 icon: joystick
+description: Hyperswitch Control Center streamlines the complexities of managing payments, ensuring operational efficiency and control over every aspect of payment flow. From account management to real-time ana...
 ---
 
 # Payment Operations

diff --git a/explore-hyperswitch/account-management/beta-embeddable-components/README.md b/explore-hyperswitch/account-management/beta-embeddable-components/README.md
@@ -1,5 +1,6 @@
 ---
 icon: laptop-code
+description: As a SaaS platform or marketplace, your value lies in your core product, not in rebuilding payment setting screens. Yet, to offer financial services to your users ("sub-merchants"), you often face ...
 ---
 
 # Embeddable Components

diff --git a/...-hyperswitch/account-management/beta-embeddable-components/integration-guide.md b/...-hyperswitch/account-management/beta-embeddable-components/integration-guide.md
@@ -1,5 +1,6 @@
 ---
 hidden: true
+description: This SDK allows you to embed the Hyperswitch connector configuration directly into your React application. It uses a provider pattern to manage authentication sessions via JWTs, ensuring your API k...
 ---
 
 # Integration Guide

diff --git a/...erswitch/account-management/beta-embeddable-components/integration-reference.md b/...erswitch/account-management/beta-embeddable-components/integration-reference.md
@@ -1,3 +1,7 @@
+---
+description: This SDK allows you to embed the Hyperswitch connector configuration directly into your React application. It uses a provider pattern to manage authentication sessions via JWTs, ensuring your API k...
+---
+
 # Integration Reference
 
 This SDK allows you to embed the Hyperswitch connector configuration directly into your React application. It uses a provider pattern to manage authentication sessions via JWTs, ensuring your API keys never leak to the client.

diff --git a/explore-hyperswitch/account-management/data-migration/README.md b/explore-hyperswitch/account-management/data-migration/README.md
@@ -1,5 +1,6 @@
 ---
 icon: utility-pole-double
+description: Migration of data is a crucial step in ensuring business continuity without any interruptions. We will work with you and your current payment service provider (PSP) to transfer the data securely.
 ---
 
 # Data migration

diff --git a/...e-hyperswitch/account-management/data-migration/export-data-from-hyperswitch.md b/...e-hyperswitch/account-management/data-migration/export-data-from-hyperswitch.md
@@ -1,5 +1,6 @@
 ---
 icon: left-from-bracket
+description: We believe customers fully own their data. If you decide to export data from Hyperswitch, we will work with your new payment service provider to safely export your data.
 ---
 
 # Export data from Hyperswitch

diff --git a/...ore-hyperswitch/account-management/data-migration/import-data-to-hyperswitch.md b/...ore-hyperswitch/account-management/data-migration/import-data-to-hyperswitch.md
@@ -1,5 +1,6 @@
 ---
 icon: right-from-bracket
+description: We help you with smooth migration from your current payment processor, ensuring uninterrupted business operations.
 ---
 
 # Import data to Hyperswitch