API Reference

This is the schema-backed reference for every Decision Engine endpoint. Each page below shows the full request and response model and includes an interactive playground, generated from the OpenAPI contract.

Looking for copy-paste examples and end-to-end flows instead? Start with the API Guide.

Two ways to read the API

Surface	Best for
API Guide	Task-oriented curl examples, complete flows, and request variants.
API Reference (this section)	Exact request/response schemas and an interactive playground, one page per endpoint.

For advanced rule examples — AND, OR, nested AND+OR, volume_split_priority, enum arrays, and number-array matching — see the Advanced Routing Example. For the exact POST /routing/create schema, use Create Routing Rule.

Access classes

Class	Routes	Authentication
Public	GET /health, GET /health/ready, GET /health/diagnostics, POST /auth/signup, POST /auth/login	None
Admin bootstrap	POST /merchant-account/create	Admin secret
Protected	All routing, decision, score update, rule config, API key, merchant read/delete, analytics, audit, config, and authenticated auth routes	Authorization: Bearer <jwt_token> or x-api-key: <api_key>
Sandbox	Any Decision Engine route served through https://sandbox.hyperswitch.io	Same auth rules plus x-feature: decision-engine

Endpoint Families

Health

• Health Check
• Health Ready
• Health Diagnostics

Auth And Onboarding

• Signup
• Login
• Logout
• Current User
• List User Merchants
• Switch Merchant
• Onboard Merchant

API Keys

• Create API Key
• List API Keys
• Revoke API Key

Merchant Account

• Create Merchant
• Get Merchant
• Delete Merchant
• Get Merchant Debit Routing
• Update Merchant Debit Routing

Gateway Decision

• Decide Gateway
• Legacy Decision Gateway
• Update Gateway Score
• Legacy Update Score

Routing Rules

• Create Routing Rule
• Activate Routing Rule
• Deactivate Routing Rule
• List Routing Rules
• Get Active Routing Rule
• Evaluate Routing Rule
• Hybrid Routing

Rule Configuration

• Create Rule Config
• Get Rule Config
• Update Rule Config
• Delete Rule Config

Config

• Get Routing Config
• Configure SR Dimensions

Analytics

• Overview
• Gateway Scores
• Decisions
• Routing Stats
• Log Summaries
• Payment Audit
• Preview Trace
• Cost Savings
• Routing Events
• A/B Test Experiment Results
• A/B Test Experiment Transactions

Curl Examples

For local and sandbox smoke-test examples, use API Examples.