@compass-labs/api-sdk 2.2.70-rc.0 → 2.2.70-rc.1

package/openapi_prepped_for_speakeasy.json

@@ -8130,6 +8130,218 @@
         },
         "x-speakeasy-name-override": "tokenized_assets_transact_sell"
       }
+    },
+    "/v2/onramp/quote": {
+      "post": {
+        "tags": [
+          "Onramp"
+        ],
+        "summary": "Get a fiat on-ramp quote (card -> USDC on Ethereum)",
+        "description": "Get an indicative quote for buying USDC on Ethereum with a card.\n\nReturns the estimated USDC the user will receive for a given fiat amount,\nthe exchange rate, fee breakdown (`business_fees` is `0`), and the provider\nmin/max limits. The output is always **USDC on Ethereum** delivered to the\n`destination_address` \u2014 this is a non-custodial on-ramp, so Compass never\nholds the funds.\n\nThis quote is indicative and may expire (`expires_at`). To actually start a\npayment, call `POST /v2/onramp/create`.",
+        "operationId": "v2_onramp_quote",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/OnrampQuoteRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampQuote"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "`INVALID_ONRAMP_REQUEST` \u2014 bad fiat amount or unsupported currency.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampErrorResponse"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "`UNSUPPORTED_ONRAMP_OUTPUT` \u2014 delivery is limited to USDC on Ethereum.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampErrorResponse"
+                }
+              }
+            }
+          },
+          "502": {
+            "description": "`HALLIDAY_API_UNAVAILABLE` \u2014 the on-ramp provider is unavailable.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampErrorResponse"
+                }
+              }
+            }
+          }
+        },
+        "x-speakeasy-name-override": "onramp_quote"
+      }
+    },
+    "/v2/onramp/create": {
+      "post": {
+        "tags": [
+          "Onramp"
+        ],
+        "summary": "Create a fiat on-ramp payment + get the checkout link",
+        "description": "Create a fiat on-ramp payment and return the browser-checkout handoff.\n\nA fiat card + identity-verification flow can only render in a browser, so\nthis endpoint returns a **`checkout_url`** (a Compass-hosted page) together\nwith `payment_id`, the one-time-wallet `deposit_address`, an initial\n`status`, and a `user_instructions` string.\n\n**How to drive this (CLI / MCP agent / UI):**\n\n1. **Present `checkout_url` to the user and open it in a browser.** It\n   renders the card payment + identity verification and delivers USDC on\n   Ethereum to the destination wallet. (An MCP agent cannot open a browser\n   itself \u2014 show the link and ask the user to open it.)\n2. **Poll `GET /v2/onramp/status?payment_id=...`** until `status` becomes\n   `delivered` (or `failed`). `pending` = awaiting payment, `processing` =\n   payment received and bridging/swapping to USDC.\n3. Once `delivered`, the USDC is in the user's own wallet \u2014 continue with\n   the tokenized buy.\n\nFunds are never held by Compass: the `deposit_address` is a one-time wallet\nowned solely by the user's wallet.",
+        "operationId": "v2_onramp_create",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/OnrampCreateRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampCreate"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "`INVALID_ONRAMP_REQUEST` \u2014 bad fiat amount or unsupported currency.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampErrorResponse"
+                }
+              }
+            }
+          },
+          "402": {
+            "description": "`KYC_REQUIRED` \u2014 identity verification is required; complete it in the hosted checkout (`checkout_url`).",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampErrorResponse"
+                }
+              }
+            }
+          },
+          "410": {
+            "description": "`QUOTE_EXPIRED` \u2014 the quote is stale; re-quote and retry.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampErrorResponse"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "`UNSUPPORTED_ONRAMP_OUTPUT` \u2014 delivery is limited to USDC on Ethereum.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampErrorResponse"
+                }
+              }
+            }
+          },
+          "502": {
+            "description": "`HALLIDAY_API_UNAVAILABLE` \u2014 the on-ramp provider is unavailable.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampErrorResponse"
+                }
+              }
+            }
+          }
+        },
+        "x-speakeasy-name-override": "onramp_create"
+      }
+    },
+    "/v2/onramp/status": {
+      "get": {
+        "tags": [
+          "Onramp"
+        ],
+        "summary": "Get the status of a fiat on-ramp payment",
+        "description": "Get the current status of a fiat on-ramp payment.\n\nPoll this after `create` until `status` is `delivered`. The `status` field\nis one of:\n\n- `pending` \u2014 awaiting the card payment in the hosted checkout.\n- `processing` \u2014 payment received; bridging/swapping the proceeds to USDC.\n- `delivered` \u2014 USDC has been delivered to the destination wallet\n  (`delivery_tx_hash` and `output_amount_delivered` are populated).\n- `failed` \u2014 the payment failed, expired, or was refunded.\n\nState is re-read live from the on-ramp provider on every call \u2014 Compass\nstores nothing of its own.",
+        "operationId": "v2_onramp_status",
+        "parameters": [
+          {
+            "name": "payment_id",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "description": "The `payment_id` returned by `POST /v2/onramp/create`.",
+              "title": "Payment Id"
+            },
+            "description": "The `payment_id` returned by `POST /v2/onramp/create`."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampStatus"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "`PAYMENT_NOT_FOUND` \u2014 no payment matches the provided id.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampErrorResponse"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "`UNSUPPORTED_ONRAMP_OUTPUT` \u2014 delivery is limited to USDC on Ethereum.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampErrorResponse"
+                }
+              }
+            }
+          },
+          "502": {
+            "description": "`HALLIDAY_API_UNAVAILABLE` \u2014 the on-ramp provider is unavailable.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OnrampErrorResponse"
+                }
+              }
+            }
+          }
+        },
+        "x-speakeasy-name-override": "onramp_status"
+      }
     }
   },
   "components": {
@@ -18187,6 +18399,333 @@
         "title": "OneInchSwapParams",
         "description": "Parameters for 1inch swap operations."
       },
+      "OnrampCreate": {
+        "properties": {
+          "payment_id": {
+            "type": "string",
+            "title": "Payment Id",
+            "description": "Halliday's payment id. Use it to poll status."
+          },
+          "deposit_address": {
+            "type": "string",
+            "title": "Deposit Address",
+            "description": "The one-time-wallet (OTW) deposit address for this payment, owned solely by the user's wallet (non-custodial)."
+          },
+          "checkout_url": {
+            "type": "string",
+            "title": "Checkout Url",
+            "description": "Compass-hosted checkout page to open in a browser. It renders the card + identity-verification flow and delivers USDC to the destination wallet."
+          },
+          "user_instructions": {
+            "type": "string",
+            "title": "User Instructions",
+            "description": "Short, agent-actionable guidance: open the checkout link, pay, then poll status until delivered."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "pending",
+              "processing",
+              "delivered",
+              "failed"
+            ],
+            "title": "Status",
+            "description": "Initial lifecycle state (typically `pending`)."
+          },
+          "quote": {
+            "$ref": "#/components/schemas/OnrampQuote",
+            "description": "The resolved quote this payment was created against."
+          }
+        },
+        "type": "object",
+        "required": [
+          "payment_id",
+          "deposit_address",
+          "checkout_url",
+          "user_instructions",
+          "status",
+          "quote"
+        ],
+        "title": "OnrampCreate",
+        "description": "A created on-ramp payment, with the browser-handoff affordances.\n\nThe caller (CLI / MCP agent / UI) presents ``checkout_url`` to the user to\npay by card and complete identity verification, then polls\n``GET /v2/onramp/status`` until ``status`` is ``delivered``."
+      },
+      "OnrampCreateRequest": {
+        "properties": {
+          "fiat_amount": {
+            "type": "string",
+            "title": "Fiat Amount",
+            "description": "Amount of fiat to spend, as a decimal string (e.g. `100`)."
+          },
+          "fiat_currency": {
+            "type": "string",
+            "title": "Fiat Currency",
+            "description": "ISO-4217 fiat currency code. Defaults to `USD`.",
+            "example": "USD"
+          },
+          "destination_address": {
+            "type": "string",
+            "title": "Destination Address",
+            "description": "The wallet that will receive the USDC on Ethereum. Funds are delivered here directly \u2014 Compass never holds them."
+          },
+          "quote_id": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Quote Id",
+            "description": "Optional Halliday quote handle to confirm against. Omit to confirm against a fresh quote derived from the amount and currency."
+          }
+        },
+        "type": "object",
+        "required": [
+          "fiat_amount",
+          "destination_address"
+        ],
+        "title": "OnrampCreateRequest",
+        "description": "Create a fiat on-ramp payment delivering USDC on Ethereum.\n\nCarries the same fields as the quote (a quote is implicit \u2014 we do not\npersist a quote handle). ``quote_id`` is optional and only echoed upstream\nif Halliday's ``/payments/confirm`` requires a previously-issued quote\nhandle; omit it to confirm against a fresh quote."
+      },
+      "OnrampErrorResponse": {
+        "properties": {
+          "error": {
+            "type": "string",
+            "title": "Error",
+            "description": "Short human-readable error label (e.g. `Payment not found.`, `On-ramp provider unavailable`, `Identity verification required`)."
+          },
+          "message": {
+            "type": "string",
+            "title": "Message",
+            "description": "Human-readable explanation."
+          }
+        },
+        "type": "object",
+        "required": [
+          "error",
+          "message"
+        ],
+        "title": "OnrampErrorResponse",
+        "description": "Standard error envelope returned by every non-2xx on-ramp response.\n\nSurfaced in OpenAPI ``responses`` declarations so SDK consumers can decode\nfailures uniformly without inspecting per-status-code shapes."
+      },
+      "OnrampFees": {
+        "properties": {
+          "provider_fee": {
+            "type": "string",
+            "title": "Provider Fee",
+            "description": "Fee charged by the on-ramp provider, in fiat."
+          },
+          "network_fee": {
+            "type": "string",
+            "title": "Network Fee",
+            "description": "Estimated network/gas fee, in fiat."
+          },
+          "business_fees": {
+            "type": "string",
+            "title": "Business Fees",
+            "description": "Compass business fee, in fiat. Always `0` for now.",
+            "example": "0"
+          }
+        },
+        "type": "object",
+        "required": [
+          "provider_fee",
+          "network_fee"
+        ],
+        "title": "OnrampFees",
+        "description": "Fee breakdown for an on-ramp quote.\n\n``business_fees`` is a fixed ``\"0\"`` for now \u2014 monetization is a single\nfuture lever and is intentionally not charged."
+      },
+      "OnrampQuote": {
+        "properties": {
+          "fiat_amount": {
+            "type": "string",
+            "title": "Fiat Amount",
+            "description": "Fiat amount to spend."
+          },
+          "fiat_currency": {
+            "type": "string",
+            "title": "Fiat Currency",
+            "description": "ISO-4217 fiat currency code."
+          },
+          "output_amount": {
+            "type": "string",
+            "title": "Output Amount",
+            "description": "Estimated USDC delivered, human-readable (6-decimal token)."
+          },
+          "output_asset": {
+            "type": "string",
+            "const": "USDC",
+            "title": "Output Asset",
+            "description": "Delivered asset. Always USDC for this on-ramp.",
+            "example": "USDC"
+          },
+          "output_chain": {
+            "type": "string",
+            "const": "ethereum",
+            "title": "Output Chain",
+            "description": "Delivery chain. Always Ethereum for this on-ramp.",
+            "example": "ethereum"
+          },
+          "exchange_rate": {
+            "type": "string",
+            "title": "Exchange Rate",
+            "description": "USDC received per unit of fiat."
+          },
+          "fees": {
+            "$ref": "#/components/schemas/OnrampFees",
+            "description": "Fee breakdown."
+          },
+          "min_amount": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Min Amount",
+            "description": "Minimum fiat amount accepted, if advertised by the provider."
+          },
+          "max_amount": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Max Amount",
+            "description": "Maximum fiat amount accepted, if advertised by the provider."
+          },
+          "expires_at": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Expires At",
+            "description": "ISO-8601 timestamp after which this quote is stale, if any."
+          }
+        },
+        "type": "object",
+        "required": [
+          "fiat_amount",
+          "fiat_currency",
+          "output_amount",
+          "exchange_rate",
+          "fees"
+        ],
+        "title": "OnrampQuote",
+        "description": "An indicative fiat -> USDC-on-Ethereum quote."
+      },
+      "OnrampQuoteRequest": {
+        "properties": {
+          "fiat_amount": {
+            "type": "string",
+            "title": "Fiat Amount",
+            "description": "Amount of fiat to spend, as a decimal string (e.g. `100`)."
+          },
+          "fiat_currency": {
+            "type": "string",
+            "title": "Fiat Currency",
+            "description": "ISO-4217 fiat currency code. Defaults to `USD`.",
+            "example": "USD"
+          },
+          "destination_address": {
+            "type": "string",
+            "title": "Destination Address",
+            "description": "The wallet that will receive the USDC on Ethereum. Funds are delivered here directly \u2014 Compass never holds them."
+          }
+        },
+        "type": "object",
+        "required": [
+          "fiat_amount",
+          "destination_address"
+        ],
+        "title": "OnrampQuoteRequest",
+        "description": "An indicative fiat -> USDC-on-Ethereum quote request.\n\nThe output asset and chain are fixed to USDC on Ethereum and are not\nuser-supplied \u2014 this product group delivers only USDC to the user's own\nwallet (non-custodial)."
+      },
+      "OnrampStatus": {
+        "properties": {
+          "payment_id": {
+            "type": "string",
+            "title": "Payment Id",
+            "description": "Halliday's payment id, echoed straight through."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "pending",
+              "processing",
+              "delivered",
+              "failed"
+            ],
+            "title": "Status",
+            "description": "Lifecycle state: `pending` (awaiting card payment), `processing` (payment received, bridging/swapping to USDC), `delivered` (USDC received in the destination wallet), or `failed`."
+          },
+          "output_amount_delivered": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Output Amount Delivered",
+            "description": "USDC delivered so far, human-readable. Set once delivered."
+          },
+          "delivery_tx_hash": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Delivery Tx Hash",
+            "description": "Ethereum tx hash of the USDC delivery, once available."
+          },
+          "destination_address": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Destination Address",
+            "description": "The wallet the USDC is delivered to."
+          },
+          "updated_at": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Updated At",
+            "description": "ISO-8601 timestamp of the last status change, if provided."
+          }
+        },
+        "type": "object",
+        "required": [
+          "payment_id",
+          "status"
+        ],
+        "title": "OnrampStatus",
+        "description": "Current state of a fiat on-ramp payment.\n\nRe-read on demand from Halliday (the system of record) \u2014 Compass holds no\nstate of its own."
+      },
       "OpenPosition": {
         "properties": {
           "marketId": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "2.2.70-rc.0",
+  "version": "2.2.70-rc.1",
   "author": "royalnine",
   "type": "module",
   "tshy": {