@stable_sea/sdk 0.2.7 → 0.2.9

package/README.md

@@ -207,6 +207,35 @@ registry metadata remains available. These figures are informational. Use a
 quote to obtain the price for a trade. See the
 [securities reference](https://docs.stablesea.com/api/reference/#GET/v1/securities).
 
+## Transaction receipts and settlement references
+
+Retrieve `GET /v1/transactions/{id}` with `money:read` for `financial_details`:
+the same input/output, fee, net trade value, fund price and commission figures
+as Terminal. Values use decimal strings. `estimated: true` means a figure can
+change; false does not prove settlement. Optional `quoted` values are the native
+receipt's comparison figures, with the currently disclosed fee held constant
+for net trade comparisons. They are not necessarily the original order quote.
+Deposit and withdrawal sections separate principal, fees, collection and
+delivery. Fee refunds preserve their original collection history.
+
+Input and output identify their `chain` and your `bank_account_id` or
+`external_wallet_id` when applicable. Use `accounts:read` to retrieve linked
+account details. Removed, internal and other businesses' accounts have no resource link.
+
+Missing figures are omitted. A movement initiated by another business may affect
+your balances without exposing its financial details. List responses omit receipt
+enrichment; use `asset_changes` to reconcile settled balance effects.
+
+Retrieve `GET /v1/transactions/{id}` with `money:read` to see
+`onchain_transactions`. Each observed reference includes its `hash` and, when
+known, `chain` and `explorer_url`. An empty array means no references have been
+observed; null means the metadata is unavailable, including a receipt initiated
+by another business. List responses omit this detail.
+
+A hash is a settlement reference, not proof that the whole movement completed.
+Check the transaction's `status` and `asset_changes` for its lifecycle and effect
+on settled balances. Sandbox references use simulated partner data.
+
 ## Statement previews
 
 Read the current month's interim document with

package/dist/gen/schema.d.ts

@@ -894,6 +894,10 @@ export interface paths {
          *
          *     The status is `pending`, `processing`, `completed` or `failed`. `completed_ts` and `failed_ts` are mutually exclusive and absent while execution is pending or processing.
          *
+         *     `financial_details` contains Terminal's receipt amounts, fees and trade figures for a movement initiated by your business. Input and output identify their blockchain and link to your bank account or external wallet when applicable; retrieve linked account details with `accounts:read`. Internal and other businesses' accounts have no resource link. Missing figures are omitted. Amounts are decimal strings; `estimated: true` means a figure can change, while false does not prove settlement. Optional `quoted` figures follow Terminal's comparison precision; a net trade comparison holds the currently disclosed fee constant and is not necessarily the original order quote. Status, settled changes and financial details share one read snapshot. Refund totals describe the assessed movement; a fee-refund transaction links to it in `original_transaction_id`.
+         *
+         *     `onchain_transactions` includes observed hashes, their blockchain when known, and available explorer links for movements initiated by your business. An empty array means no hashes have been observed; null means references are unavailable for this read. Lists omit these details.
+         *
          *     Unknown and cross-business IDs return the same not-found response.
          */
         get: operations["transactions.get"];
@@ -2247,12 +2251,142 @@ export interface components {
             /** @description The asset symbol, in the ledger's own casing (USDC, WTGXX, SOL:USDC). */
             asset: string;
         };
+        TransactionDepositAmounts: {
+            available: boolean;
+            collected_platform_fee_usdc: string;
+            /** @enum {string} */
+            collection_status: "not_needed" | "pending" | "collected" | "failed" | "insufficient_proceeds";
+            estimated: boolean;
+            /** Format: date-time */
+            first_observed_ts: string | null;
+            gross_deposit_usd: string;
+            gross_proceeds_usdc: string;
+            net_usdc: string;
+            platform_fee_usdc: string;
+            pricing_basis: string | null;
+            /** Format: date-time */
+            pricing_ts: string | null;
+        };
+        TransactionDetail: {
+            /** @description Signed net changes to settled holdings, one entry per asset, ordered by asset. Empty when no part has settled. A failed movement includes any changes that settled before failure; pending or processing status alone does not determine whether this array is empty. */
+            asset_changes: components["schemas"]["TransactionAssetChange"][];
+            /**
+             * Format: date-time
+             * @description When the last leg settled. Present only when status is completed, and never alongside failed_ts.
+             */
+            completed_ts?: string;
+            /**
+             * Format: date-time
+             * @description When the movement was opened. Immutable, and the instant this list is ordered and paged on.
+             */
+            created_ts: string;
+            /**
+             * Format: date-time
+             * @description When the movement terminated as failed. Present only when status is failed, and never alongside completed_ts.
+             */
+            failed_ts?: string;
+            financial_details?: components["schemas"]["TransactionFinancialDetail"];
+            /** @description The transaction id. Stable for the life of the movement and safe to store. */
+            id: string;
+            /** @description Whether the resource represents live financial data. False for an isolated simulated ledger; independent of the reading credential. */
+            livemode: boolean;
+            /** @enum {string} */
+            object: "transaction";
+            /** @description Observed on-chain settlement references for a movement initiated by your business. Empty when none have been observed; null when unavailable. */
+            onchain_transactions: components["schemas"]["TransactionOnchainReference"][] | null;
+            /**
+             * @description The movement lifecycle: pending before execution starts; processing while at least one part is in flight; completed when all parts settle; failed when execution ends unsuccessfully. A failed movement can have settled changes, reported in asset_changes.
+             * @enum {string}
+             */
+            status: "pending" | "processing" | "completed" | "failed";
+            /**
+             * @description What the movement is. The whole vocabulary a transaction can carry is published; a business only ever sees the members its own activity produces. Pay-ins and payouts are never served on this API.
+             * @enum {string}
+             */
+            type: "ach_offramp" | "ach_onramp" | "adjustment" | "buy_fund_token" | "buy_fund_token_return" | "buy_fund_token_return_sweep" | "deposit_hold" | "deposit_return" | "deposit_reversal" | "fund_cash_subscription" | "fund_dividend_payout" | "fund_distribution_payout" | "fund_gas_tank" | "fund_xlm_reserve" | "gas_tank_refill" | "gas_wallet_funding" | "go_account_conversion" | "go_account_custodial_transfer" | "go_account_external_send" | "held_deposit_release" | "onchain_deposit" | "onchain_withdrawal" | "ramp_fee_refund" | "reclassification" | "sell_fund_token" | "sell_fund_token_return" | "trade_order" | "treasury_booking" | "treasury_wire_credit" | "wire_offramp" | "wire_onramp";
+        };
+        TransactionFeeReturns: {
+            original_transaction_id: string | null;
+            refund_transaction_ids: (string | null)[] | null;
+            refunded: boolean;
+            /** @description Total fee refunds recorded against this movement's assessment. A fee-refund transaction links to the original assessed transaction instead. */
+            refunded_usdc: string;
+            waived: boolean;
+        };
+        TransactionFigure: {
+            amount: string;
+            asset: string;
+            /** @description Whether this figure can still change. False also covers terminal failure and a fund-trade amount fixed at placement; it does not prove settlement. */
+            estimated: boolean;
+            quoted?: components["schemas"]["TransactionValue"];
+        };
+        TransactionFinancialDetail: {
+            automation_id: string | null;
+            deposit?: components["schemas"]["TransactionDepositAmounts"];
+            /**
+             * Format: date-time
+             * @description Pending fund settlement estimate. Null after the native receipt no longer reports an estimate.
+             */
+            estimated_settlement_ts: string | null;
+            fee?: components["schemas"]["TransactionValue"];
+            fee_returns?: components["schemas"]["TransactionFeeReturns"];
+            input?: components["schemas"]["TransactionSide"];
+            net_amount?: components["schemas"]["TransactionFigure"];
+            output?: components["schemas"]["TransactionSide"];
+            price_per_unit?: components["schemas"]["TransactionFigure"];
+            settlement_commission?: components["schemas"]["TransactionValue"];
+            /**
+             * @description Recorded fund settlement choice; null when none was recorded.
+             * @enum {string|null}
+             */
+            settlement_pathway: "standard" | "express" | null;
+            withdrawal?: components["schemas"]["TransactionWithdrawalAmounts"];
+        };
         TransactionList: {
             data: components["schemas"]["Transaction"][];
             has_more: boolean;
             /** @enum {string} */
             object: "list";
         };
+        TransactionOnchainReference: {
+            /** @description Blockchain identifier, such as ethereum or stellar. Omitted when the hash cannot be attributed to a blockchain. */
+            chain?: string;
+            /**
+             * Format: uri
+             * @description Block-explorer URL, when available. Otherwise use the hash as plain text.
+             */
+            explorer_url?: string;
+            /** @description Observed transaction hash. */
+            hash: string;
+        };
+        TransactionSide: {
+            amount: string;
+            asset: string;
+            /** @description Your bank-account resource, omitted after removal. Retrieve it with accounts:read for account details. */
+            bank_account_id?: string;
+            /** @description Blockchain used by this ledger leg, when it names one. Internal conversions and bank legs have no chain. */
+            chain?: string;
+            /** @description Whether this figure can still change. False also covers terminal failure and a fund-trade amount fixed at placement; it does not prove settlement. */
+            estimated: boolean;
+            /** @description Your external-wallet resource, omitted after removal. Retrieve it with accounts:read for wallet details. */
+            external_wallet_id?: string;
+            quoted?: components["schemas"]["TransactionValue"];
+        };
+        TransactionValue: {
+            amount: string;
+            asset: string;
+        };
+        TransactionWithdrawalAmounts: {
+            bank_fee_usd: string;
+            collected_platform_fee_usdc: string;
+            /** @enum {string} */
+            collection_status: "not_needed" | "pending" | "collected" | "failed";
+            delivered: boolean;
+            estimated: boolean;
+            paid_to_bank_usd: string;
+            platform_fee_usdc: string;
+            total_debit_usdc: string;
+        };
         USBankAccountCreateDetails: {
             account_number: string;
             /** @enum {string} */
@@ -4156,7 +4290,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["Transaction"];
+                    "application/json": components["schemas"]["TransactionDetail"];
                 };
             };
             400: components["responses"]["Error400"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stable_sea/sdk",
-  "version": "0.2.7",
+  "version": "0.2.9",
   "type": "module",
   "sideEffects": false,
   "files": [