|
1 | 1 | # API Overview |
2 | 2 |
|
3 | | -The canonical API contract for the docs site is `docs/openapi.json`. |
4 | | - |
5 | | -Use this page to find the right endpoint family. Use the OpenAPI-backed endpoint pages for schema details. |
| 3 | +The canonical OpenAPI contract for the docs site is `docs/openapi.json`. Use this page for schema-oriented navigation. Use [API Examples](/api-refs/api-ref) for curl-first flows, valid payloads, and route variants. |
6 | 4 |
|
7 | 5 | ## Endpoint Families |
8 | 6 |
|
9 | 7 | ### Health |
10 | 8 |
|
11 | | -- [Health Check](api-reference/endpoint/healthCheck) |
| 9 | +- [Health Check](/api-reference/endpoint/healthCheck) |
| 10 | +- [Health Ready](/api-reference/endpoint/healthReady) |
| 11 | +- [Health Diagnostics](/api-reference/endpoint/healthDiagnostics) |
12 | 12 |
|
13 | | -### Gateway Decision |
| 13 | +### Auth And Onboarding |
14 | 14 |
|
15 | | -- [Decide Gateway](api-reference/endpoint/decideGateway) |
| 15 | +- [Signup](/api-reference/endpoint/signup) |
| 16 | +- [Login](/api-reference/endpoint/login) |
| 17 | +- [Logout](/api-reference/endpoint/logout) |
| 18 | +- [Current User](/api-reference/endpoint/me) |
| 19 | +- [List User Merchants](/api-reference/endpoint/listUserMerchants) |
| 20 | +- [Switch Merchant](/api-reference/endpoint/switchMerchant) |
| 21 | +- [Onboard Merchant](/api-reference/endpoint/onboardMerchant) |
16 | 22 |
|
17 | | -### Score Feedback |
| 23 | +### API Keys |
18 | 24 |
|
19 | | -- [Update Gateway Score](api-reference/endpoint/updateGatewayScore) |
| 25 | +- [Create API Key](/api-reference/endpoint/createApiKey) |
| 26 | +- [List API Keys](/api-reference/endpoint/listApiKeys) |
| 27 | +- [Revoke API Key](/api-reference/endpoint/revokeApiKey) |
20 | 28 |
|
21 | 29 | ### Merchant Account |
22 | 30 |
|
23 | | -- [Create Merchant](api-reference/endpoint/createMerchant) |
24 | | -- [Get Merchant](api-reference/endpoint/getMerchant) |
25 | | -- [Delete Merchant](api-reference/endpoint/deleteMerchant) |
| 31 | +- [Create Merchant](/api-reference/endpoint/createMerchant) |
| 32 | +- [Get Merchant](/api-reference/endpoint/getMerchant) |
| 33 | +- [Delete Merchant](/api-reference/endpoint/deleteMerchant) |
| 34 | +- [Get Merchant Debit Routing](/api-reference/endpoint/getMerchantDebitRouting) |
| 35 | +- [Update Merchant Debit Routing](/api-reference/endpoint/updateMerchantDebitRouting) |
| 36 | + |
| 37 | +### Gateway Decision |
| 38 | + |
| 39 | +- [Decide Gateway](/api-reference/endpoint/decideGateway) |
| 40 | +- [Legacy Decision Gateway](/api-reference/endpoint/legacyDecisionGateway) |
| 41 | +- [Update Gateway Score](/api-reference/endpoint/updateGatewayScore) |
| 42 | +- [Legacy Update Score](/api-reference/endpoint/legacyUpdateScore) |
26 | 43 |
|
27 | 44 | ### Routing Rules |
28 | 45 |
|
29 | | -- [Create Routing Rule](api-reference/endpoint/createRoutingRule) |
30 | | -- [Activate Routing Rule](api-reference/endpoint/activateRoutingRule) |
31 | | -- [List Routing Rules](api-reference/endpoint/listRoutingRules) |
32 | | -- [Get Active Routing Rule](api-reference/endpoint/getActiveRoutingRule) |
33 | | -- [Evaluate Routing Rule](api-reference/endpoint/evaluateRoutingRule) |
| 46 | +- [Create Routing Rule](/api-reference/endpoint/createRoutingRule) |
| 47 | +- [Activate Routing Rule](/api-reference/endpoint/activateRoutingRule) |
| 48 | +- [List Routing Rules](/api-reference/endpoint/listRoutingRules) |
| 49 | +- [Get Active Routing Rule](/api-reference/endpoint/getActiveRoutingRule) |
| 50 | +- [Evaluate Routing Rule](/api-reference/endpoint/evaluateRoutingRule) |
| 51 | +- [Hybrid Routing](/api-reference/endpoint/hybridRouting) |
34 | 52 |
|
35 | 53 | ### Rule Configuration |
36 | 54 |
|
37 | | -- [Create Rule Config](api-reference/endpoint/createRuleConfig) |
38 | | -- [Get Rule Config](api-reference/endpoint/getRuleConfig) |
39 | | -- [Update Rule Config](api-reference/endpoint/updateRuleConfig) |
40 | | -- [Delete Rule Config](api-reference/endpoint/deleteRuleConfig) |
| 55 | +- [Create Rule Config](/api-reference/endpoint/createRuleConfig) |
| 56 | +- [Get Rule Config](/api-reference/endpoint/getRuleConfig) |
| 57 | +- [Update Rule Config](/api-reference/endpoint/updateRuleConfig) |
| 58 | +- [Delete Rule Config](/api-reference/endpoint/deleteRuleConfig) |
| 59 | + |
| 60 | +### Config |
| 61 | + |
| 62 | +- [Get Routing Config](/api-reference/endpoint/getRoutingConfig) |
| 63 | +- [Configure SR Dimensions](/api-reference/endpoint/configSrDimension) |
| 64 | + |
| 65 | +### Analytics |
| 66 | + |
| 67 | +- [Overview](/api-reference/endpoint/analyticsOverview) |
| 68 | +- [Gateway Scores](/api-reference/endpoint/analyticsGatewayScores) |
| 69 | +- [Decisions](/api-reference/endpoint/analyticsDecisions) |
| 70 | +- [Routing Stats](/api-reference/endpoint/analyticsRoutingStats) |
| 71 | +- [Log Summaries](/api-reference/endpoint/analyticsLogSummaries) |
| 72 | +- [Payment Audit](/api-reference/endpoint/analyticsPaymentAudit) |
| 73 | +- [Preview Trace](/api-reference/endpoint/analyticsPreviewTrace) |
41 | 74 |
|
42 | 75 | ## Curl Examples |
43 | 76 |
|
44 | | -For local smoke-test examples, use [Curl API References](api-refs/api-ref). |
| 77 | +For local and sandbox smoke-test examples, use [API Examples](/api-refs/api-ref). |
0 commit comments