Merge branch 'main' of github.com:juspay/hyperswitch into feat/mockserver

* 'main' of github.com:juspay/hyperswitch: (25 commits)
  chore: `xof` currency to cybersource cards (#8799)
  chore(version): 2025.08.01.0
  feat(core): Implement UCS based  upi for  paytm and phonepe (#8732)
  feat(connector): [katapult]add template code for katapult (#8783)
  feat(router): introduce `feature`  and `feature_data` to gsm (#7771)
  feat(connector): [cybersource] add changes for field CybersourceConsumerAuthInformation (#8768)
  feat(authentication): added authentication sync api (#8596)
  feat(connector): [facilitapay] fix refunds, add webhook and void support (#8778)
  feat(connector): [payload] add recurring payments (#8597)
  chore(version): 2025.07.31.0
  feat(connector): [Flexiti]Add support for flexiti connector  (#8743)
  chore(router): events enhancement for kafka (#8780)
  ci(cypress): Making a mandate payment with large customer user agents (#8790)
  fix(openapi): update create_platform endpoint in api-reference docs (#8782)
  chore(version): 2025.07.30.0
  fix(connector): [GLOBALPAY] Added Tokenization Flow for CITs (#8568)
  feat(routing): Add api-refs for new decision engine endpoints (#8709)
  fix: replace xtrim with xdel to support  older redis version (#8515)
  fix(connector): [Worldpay] handle multiple ddc submission for CompleteAuthorize (#8741)
  feat(connector): [Adyen] receive incoming webhooks for pix expiry (#8720)
  ...

Author: pixincreate

CHANGELOG.md

@@ -4,6 +4,76 @@ All notable changes to HyperSwitch will be documented here.
 
 - - -
 
+## 2025.08.01.0
+
+### Features
+
+- **authentication:** Added authentication sync api ([#8596](https://github.com/juspay/hyperswitch/pull/8596)) ([`794dce1`](https://github.com/juspay/hyperswitch/commit/794dce168e6b4d280c9c742a6e8a3b3283e09602))
+- **connector:**
+  - [payload] add recurring payments ([#8597](https://github.com/juspay/hyperswitch/pull/8597)) ([`64e6dc8`](https://github.com/juspay/hyperswitch/commit/64e6dc860d3c18a87160d374fb4fa6500b0b4285))
+  - [facilitapay] fix refunds, add webhook and void support ([#8778](https://github.com/juspay/hyperswitch/pull/8778)) ([`c38ce38`](https://github.com/juspay/hyperswitch/commit/c38ce386bda3aef1ce8a733c8df2a3a99b068396))
+  - [cybersource] add changes for field CybersourceConsumerAuthInformation ([#8768](https://github.com/juspay/hyperswitch/pull/8768)) ([`6ff7575`](https://github.com/juspay/hyperswitch/commit/6ff757541d3f0bea97edcadd4856a3dfa4ebedb4))
+  - [katapult]add template code for katapult ([#8783](https://github.com/juspay/hyperswitch/pull/8783)) ([`c6e4e72`](https://github.com/juspay/hyperswitch/commit/c6e4e7209f2bff0b72e6616f6b02c9996384413c))
+- **core:** Implement UCS based upi for paytm and phonepe ([#8732](https://github.com/juspay/hyperswitch/pull/8732)) ([`01e9474`](https://github.com/juspay/hyperswitch/commit/01e94748083a7f013d189356022cd241ea65c77f))
+- **router:** Introduce `feature` and `feature_data` to gsm ([#7771](https://github.com/juspay/hyperswitch/pull/7771)) ([`1fa20a9`](https://github.com/juspay/hyperswitch/commit/1fa20a9ae219ab9f1dc7a85f7445c1803cb39ce2))
+
+**Full Changelog:** [`2025.07.31.0...2025.08.01.0`](https://github.com/juspay/hyperswitch/compare/2025.07.31.0...2025.08.01.0)
+
+- - -
+
+## 2025.07.31.0
+
+### Features
+
+- **connector:** [Flexiti]Add support for flexiti connector ([#8743](https://github.com/juspay/hyperswitch/pull/8743)) ([`2bd8c9d`](https://github.com/juspay/hyperswitch/commit/2bd8c9d12d24039494ef76e04a7ce8f47ef2eba8))
+
+### Bug Fixes
+
+- **openapi:** Update create_platform endpoint in api-reference docs ([#8782](https://github.com/juspay/hyperswitch/pull/8782)) ([`8dc4061`](https://github.com/juspay/hyperswitch/commit/8dc4061f9edb1ac2527216b2279a765d0b797523))
+
+### Miscellaneous Tasks
+
+- **router:** Events enhancement for kafka ([#8780](https://github.com/juspay/hyperswitch/pull/8780)) ([`e48e55a`](https://github.com/juspay/hyperswitch/commit/e48e55a04821ab7648ad3434a8483c75e28ba070))
+
+**Full Changelog:** [`2025.07.30.0...2025.07.31.0`](https://github.com/juspay/hyperswitch/compare/2025.07.30.0...2025.07.31.0)
+
+- - -
+
+## 2025.07.30.0
+
+### Features
+
+- **connector:**
+  - [BLUECODE] Added Template Code ([#8756](https://github.com/juspay/hyperswitch/pull/8756)) ([`9f6182b`](https://github.com/juspay/hyperswitch/commit/9f6182b7fbb334447f2dda77f70d780ebbcde0ea))
+  - [FISERV] Added GooglePay Payment Method - Connector Decryption Flow ([#8658](https://github.com/juspay/hyperswitch/pull/8658)) ([`b5586b6`](https://github.com/juspay/hyperswitch/commit/b5586b68d8e7380ee57ebcaf93a68ecd59c686fc))
+  - [Adyen] receive incoming webhooks for pix expiry ([#8720](https://github.com/juspay/hyperswitch/pull/8720)) ([`4587564`](https://github.com/juspay/hyperswitch/commit/4587564824dff214744425d8e6dbfac8850e8416))
+- **routing:** Add api-refs for new decision engine endpoints ([#8709](https://github.com/juspay/hyperswitch/pull/8709)) ([`4dea30f`](https://github.com/juspay/hyperswitch/commit/4dea30ffa0d9bf636af3757c998e12a23f4769bd))
+
+### Bug Fixes
+
+- **connector:**
+  - [Worldpay] handle multiple ddc submission for CompleteAuthorize ([#8741](https://github.com/juspay/hyperswitch/pull/8741)) ([`f6cdddc`](https://github.com/juspay/hyperswitch/commit/f6cdddcb98e08f97dc518c8c14569fe67426bd6f))
+  - [GLOBALPAY] Added Tokenization Flow for CITs ([#8568](https://github.com/juspay/hyperswitch/pull/8568)) ([`f7bc33c`](https://github.com/juspay/hyperswitch/commit/f7bc33cd0f5537e7be05af4064df8715ed47011b))
+- Replace xtrim with xdel to support older redis version ([#8515](https://github.com/juspay/hyperswitch/pull/8515)) ([`3d085ab`](https://github.com/juspay/hyperswitch/commit/3d085abf3853c1658e208a733bf69715f44ba0bb))
+
+**Full Changelog:** [`2025.07.29.0...2025.07.30.0`](https://github.com/juspay/hyperswitch/compare/2025.07.29.0...2025.07.30.0)
+
+- - -
+
+## 2025.07.29.0
+
+### Documentation
+
+- Add initial authentication page ([#8719](https://github.com/juspay/hyperswitch/pull/8719)) ([`5ca0fb5`](https://github.com/juspay/hyperswitch/commit/5ca0fb5f654c9b32186dab8a2a2d475f2eb7df6a))
+
+### Miscellaneous Tasks
+
+- Updated open api spec documentation for create platform account ([#8692](https://github.com/juspay/hyperswitch/pull/8692)) ([`3bf4c49`](https://github.com/juspay/hyperswitch/commit/3bf4c490563d836685157351b66fc662bca0debd))
+
+**Full Changelog:** [`2025.07.28.1...2025.07.29.0`](https://github.com/juspay/hyperswitch/compare/2025.07.28.1...2025.07.29.0)
+
+- - -
+
 ## 2025.07.28.1
 
 ### Features

Cargo.lock

@@ -44,5 +44,4 @@ npx @mintlify/scraping@latest openapi-file v1/openapi_spec_v1.json  -o v1
 
 This will generate files in [api-reference](api-reference) folder. These routes should be added to the [mint.json](mint.json) file under navigation, under respective group.
 
-
-NOTE: For working with V2 API reference, replace every occurrence of `v1` with `v2` in above commands
+NOTE: For working with V2 API reference, replace every occurrence of `v1` with `v2` in above commands

api-reference/README.md

@@ -23,6 +23,7 @@
               {
                 "group": "Essentials",
                 "pages": [
+                  "essentials/authentication",
                   "essentials/error_codes",
                   "essentials/rate_limit",
                   "essentials/go-live"
@@ -146,6 +147,12 @@
                       "v1/business-profile/business-profile--list"
                     ]
                   },
+                  {
+                    "group": "Platform Account",
+                    "pages": [
+                      "v1/platform/platform--create"
+                    ]
+                  },
                   {
                     "group": "API Key",
                     "pages": [
@@ -213,7 +220,10 @@
                       "v1/routing/routing--retrieve-default-for-profile",
                       "v1/routing/routing--update-default-for-profile",
                       "v1/routing/routing--retrieve",
-                      "v1/routing/routing--activate-config"
+                      "v1/routing/routing--activate-config",
+                      "v1/routing/routing--evaluate",
+                      "v1/routing/routing--feedback",
+                      "v1/routing/routing--rule-evaluate"
                     ]
                   },
                   {

api-reference/docs.json

@@ -0,0 +1,110 @@
+---
+title: Authentication Types
+description: Overview of authentication types and authorization keys available in Hyperswitch.
+---
+
+import Note from '@site/src/components/Note'
+import Table from '@site/src/components/Table'
+import Check from '@site/src/components/Check'
+
+Hyperswitch supports multiple API key types, each designed for different authentication and authorization use cases.
+
+<Note>
+For security, **never expose secret or admin keys in client-side or mobile code**. Use publishable keys for public contexts.
+</Note>
+
+## 1. API Key (Secret Key)
+
+- **Primary merchant authentication key for server-side API requests.**
+- Environment-specific prefix (`snd_`, `prod_`, etc.).
+- Used for server to server requests.
+- This key can be **generated and managed from the [Hyperswitch dashboard (sandbox)](https://app.hyperswitch.io/developers?tabIndex=1)**.
+
+- **Never expose this key in public code.**
+
+## 2. Admin API Key
+
+- **Administrative key** with elevated privileges.
+- Used for system-level operations such as creating merchant and connector accounts.
+- Should only be used in secure, internal workflows.
+- Some API calls require an admin API key. **Do not confuse this with a regular API Key.**
+- The **admin API key is a configuration value that can be set at the time of deploying the Hyperswitch server**.
+- **Admin API keys for the hosted Hyperswitch environments (sandbox/production) are managed by Juspay and are not provided publicly.**
+
+<Check>
+You do **not** generate this key from the dashboard.  
+Instead, **set your Admin API Key in your deployment configuration**:
+
+**For Docker Compose:**  
+Update the value in your `docker_compose.toml` file:
+</Check>
+
+```toml
+# docker_compose.toml
+admin_api_key = "your_admin_key_here"
+```
+<Check> **For Helm Chart deployments:** Set the admin API key in your `values.yaml` file. </Check>
+
+```yaml
+# values.yaml
+adminApiKey: your_admin_key_here
+```
+<Note> Do **not** expose your admin API key publicly. Only trusted entities and trusted applications should have access to this value. </Note>
+
+Check the Docker Compose example for extra clarity:
+[See example in the Hyperswitch repository](https://github.com/juspay/hyperswitch/blob/main/config/docker_compose.toml)
+
+
+## 3. Publishable Key
+
+- **Client-side key** with limited permissions.
+- Safe for use in public client-side (web or mobile) code.
+- Prefix: `pk_{environment}_{uuid}`.
+- Generated during merchant account creation.
+
+## 4. Ephemeral Key
+
+- **Temporary key** for limited operations.
+- Used for single or short-lived access (e.g., accessing a specific customer object).
+- Validity is configurable (see `[eph_key] validity` in `development.toml`).
+
+## 5. JWT Key
+
+- **JWT Bearer Token** used for API authentication and session management.  
+- Required for certain JWT-protected endpoints and user authentication flows.  
+- Format: `Authorization: Bearer <jwt_token>`
+
+### When to Use
+
+JWT tokens are primarily used by the Hyperswitch Control Center front end to authenticate API requests. You generally do **not** need to manage or use JWTs unless:
+
+- You’re building a **custom front end** that replaces the Control Center, or  
+- You’re a developer **testing APIs directly** (e.g., using Postman or running the server without the UI).
+
+For most users interacting through the Control Center UI, JWTs are handled automatically and do not need to be generated or included manually.
+
+> **Note:**  
+> JWTs are **not provisioned via the Hyperswitch dashboard**.  
+> They are typically **issued during an authentication flow**, such as during login or session creation.
+
+```http
+Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
+```
+<Note> Keep your JWT tokens secure. Do not expose them in client-side code unless specifically required for session management, and always use HTTPS when transmitting JWTs. </Note>
+
+## Reference Table
+
+<Table>
+| Key Type         | Example Prefix        | Usage                        | Security                |
+|------------------|----------------------|------------------------------|-------------------------|
+| Secret (API Key) | snd_c69***, prod_*** | Backend server API requests  | Keep secret             |
+| Admin API Key    | (admin-specific)     | Admin operations             | Highly confidential     |
+| Publishable Key  | pk_snd_3b3***        | Client-side, public usage    | Safe to expose          |
+| Ephemeral Key    | (short-lived)        | Temporary, limited access    | Short validity, limited |
+| JWT Key          | (JWT Bearer)         | Session/user authentication  | Control center calls         |
+</Table>
+
+<Check>
+Get your [API Key](https://app.hyperswitch.io/developers?tabIndex=1) and [Publishable Key](https://app.hyperswitch.io/home) from the Hyperswitch dashboard.
+</Check>
+---