@stridge/openapi 0.2.1 → 0.4.0

package/dist/openapi.json

@@ -25,6 +25,10 @@
       "name": "UDA",
       "description": "Universal Deposit Addresses — allocate cross-chain deposit addresses, fetch indicative quotes, and track settlements.\n"
     },
+    {
+      "name": "Routing Policies",
+      "description": "Tenant-scoped, centrally-editable routing policies — ordered, first-match-wins rule sets that divert UDA settlements. Editing a policy applies to every UDA that references it (or inherits the tenant default) with no per-UDA changes. Read-only over the API; create and edit them from the dashboard. Routing policies apply to UDA settlements only — gateway flows ignore them.\n"
+    },
     {
       "name": "Payout",
       "description": "Non-custodial vaults and the payouts they fund. Inspect a vault's addresses, per-asset balances, and total value, then send funds from a vault to an external address — payouts are idempotent by reference, tracked through a lifecycle, and have native gas funded automatically.\n"
@@ -756,7 +760,7 @@
           "Payout"
         ],
         "summary": "Create payout",
-        "description": "Create a payout from the tenant's vault wallet to an external address. Provide either `amount` (crypto) or `usd_amount` (converted to crypto at the current rate). Payouts are idempotent by `(vault_id, reference_id)` — resubmitting a `reference_id` returns `409` instead of paying twice.\n",
+        "description": "Create a payout from the tenant's vault wallet to an external address. Provide either `amount` (crypto) or `usd_amount` (converted to crypto at the current rate). Payouts are idempotent by `(vault_id, reference_id)` — resubmitting a `reference_id` returns `409` instead of paying twice. Set `type` to `forceful` for a single fail-fast attempt — gas is still refilled when needed, but the refill and transfer are each tried once with no retry; the default `normal` refills and retries until `expired_at`.\n",
         "security": [
           {
             "ApiKeyAuth": []
@@ -1159,6 +1163,97 @@
           }
         }
       }
+    },
+    "/routing-policies": {
+      "get": {
+        "operationId": "list-routing-policies",
+        "tags": [
+          "Routing Policies"
+        ],
+        "summary": "List routing policies",
+        "description": "List the routing policies configured for your tenant, including the default policy. Read-only — create and edit policies from the dashboard.\n",
+        "security": [
+          {
+            "ApiKeyAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/LimitParam"
+          },
+          {
+            "$ref": "#/components/parameters/OffsetParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A page of routing policies.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RoutingPolicyList"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "500": {
+            "$ref": "#/components/responses/ServerError"
+          }
+        }
+      }
+    },
+    "/routing-policies/{id}": {
+      "get": {
+        "operationId": "get-routing-policy",
+        "tags": [
+          "Routing Policies"
+        ],
+        "summary": "Get a routing policy",
+        "description": "Fetch a single routing policy by id.",
+        "security": [
+          {
+            "ApiKeyAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "Routing policy id.",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The routing policy.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RoutingPolicy"
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFound"
+          },
+          "500": {
+            "$ref": "#/components/responses/ServerError"
+          }
+        }
+      }
     }
   },
   "components": {
@@ -1451,6 +1546,11 @@
               "$ref": "#/components/schemas/RoutingRuleInput"
             },
             "description": "Optional; max 3. Specificity-wins precedence: a rule pinning both `source_network_id` and `source_asset_symbol` beats a network-only rule. When nothing matches, settlements use the default destination.\n"
+          },
+          "routing_policy_id": {
+            "type": "string",
+            "description": "Routing policy to attach to this UDA. Omit or send an empty string to attach the tenant's default policy. Per-UDA inline `routing_rules` still take precedence over the policy.\n",
+            "example": "rpol_2f8c1a9d4e5f6071"
           }
         },
         "required": [
@@ -1655,6 +1755,61 @@
             "items": {
               "$ref": "#/components/schemas/RoutingRule"
             }
+          },
+          "routing_policy_id": {
+            "type": "string",
+            "description": "The routing policy attached to this UDA, when set. Omitted for legacy UDAs that inherit the tenant default policy.\n",
+            "example": "rpol_2f8c1a9d4e5f6071"
+          }
+        }
+      },
+      "RoutingPolicy": {
+        "type": "object",
+        "description": "A tenant-scoped, ordered routing-policy. Rules are evaluated first-match-wins; an empty rule set falls through to the UDA's default destination.\n",
+        "properties": {
+          "id": {
+            "type": "string",
+            "example": "rpol_2f8c1a9d4e5f6071"
+          },
+          "name": {
+            "type": "string",
+            "example": "vip_tier"
+          },
+          "is_default": {
+            "type": "boolean",
+            "description": "Whether this is the tenant's default policy (one per tenant).",
+            "example": false
+          },
+          "rules": {
+            "type": "array",
+            "description": "Ordered, first-match-wins routing rules (dual form).",
+            "items": {
+              "$ref": "#/components/schemas/RoutingRule"
+            }
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "example": "2026-05-20T14:03:12Z"
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time",
+            "example": "2026-05-20T14:03:12Z"
+          }
+        }
+      },
+      "RoutingPolicyList": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RoutingPolicy"
+            }
+          },
+          "pagination": {
+            "$ref": "#/components/schemas/Pagination"
           }
         }
       },
@@ -2067,13 +2222,15 @@
           },
           "eip155_id": {
             "type": "integer",
+            "description": "Chain-specific numeric id: the EIP-155 chain id for EVM networks, or the analogous numeric chain id Stridge uses for non-EVM (TVM, SVM) networks. Always present.\n",
             "example": 1
           },
           "chain_type": {
             "type": "string",
             "enum": [
               "EVM",
-              "TVM"
+              "TVM",
+              "SVM"
             ],
             "example": "EVM"
           },
@@ -2338,11 +2495,20 @@
             "description": "Free-form note stored on the payout.",
             "example": "Payment for order #12345"
           },
+          "type": {
+            "type": "string",
+            "enum": [
+              "normal",
+              "forceful"
+            ],
+            "default": "normal",
+            "description": "Payout strategy. `normal` (default) refills gas when needed and retries until `expired_at`. `forceful` still refills when needed but is single-attempt — the refill and the transfer are each tried once, with no retry and no `expired_at`; it fails immediately if either can't complete.\n"
+          },
           "expired_at": {
             "type": "string",
             "format": "date-time",
-            "description": "Cutoff after which a non-confirmed payout expires.",
-            "example": "2026-12-31T23:59:59Z"
+            "description": "Cutoff after which a non-confirmed payout expires. Defaults to 1 hour from creation; capped at 12 hours ahead. Ignored for `forceful` payouts.\n",
+            "example": "2026-01-01T01:00:00Z"
           }
         },
         "required": [
@@ -2360,7 +2526,8 @@
           "reference_id": "order-12345",
           "amount": "100.50",
           "remark": "Payment for order #12345",
-          "expired_at": "2026-12-31T23:59:59Z"
+          "type": "normal",
+          "expired_at": "2026-01-01T01:00:00Z"
         }
       },
       "Payout": {
@@ -2409,6 +2576,15 @@
             "type": "string",
             "example": "Payment for order #12345"
           },
+          "type": {
+            "type": "string",
+            "enum": [
+              "normal",
+              "forceful"
+            ],
+            "description": "Payout strategy the payout was created with.",
+            "example": "normal"
+          },
           "status": {
             "type": "string",
             "enum": [
@@ -2443,7 +2619,7 @@
           "expired_at": {
             "type": "string",
             "format": "date-time",
-            "example": "2026-12-31T23:59:59Z"
+            "example": "2026-01-01T01:00:00Z"
           }
         }
       },