@stable_sea/sdk 0.2.7 → 0.2.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/dist/gen/schema.d.ts +51 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -207,6 +207,18 @@ registry metadata remains available. These figures are informational. Use a
|
|
|
207
207
|
quote to obtain the price for a trade. See the
|
|
208
208
|
[securities reference](https://docs.stablesea.com/api/reference/#GET/v1/securities).
|
|
209
209
|
|
|
210
|
+
## Transaction settlement references
|
|
211
|
+
|
|
212
|
+
Retrieve `GET /v1/transactions/{id}` with `money:read` to see
|
|
213
|
+
`onchain_transactions`. Each observed reference includes its `hash` and, when
|
|
214
|
+
known, `chain` and `explorer_url`. An empty array means no references have been
|
|
215
|
+
observed; null means the metadata is unavailable, including a receipt initiated
|
|
216
|
+
by another business. List responses omit this detail.
|
|
217
|
+
|
|
218
|
+
A hash is a settlement reference, not proof that the whole movement completed.
|
|
219
|
+
Check the transaction's `status` and `asset_changes` for its lifecycle and effect
|
|
220
|
+
on settled balances. Sandbox references use simulated partner data.
|
|
221
|
+
|
|
210
222
|
## Statement previews
|
|
211
223
|
|
|
212
224
|
Read the current month's interim document with
|
package/dist/gen/schema.d.ts
CHANGED
|
@@ -894,6 +894,8 @@ export interface paths {
|
|
|
894
894
|
*
|
|
895
895
|
* The status is `pending`, `processing`, `completed` or `failed`. `completed_ts` and `failed_ts` are mutually exclusive and absent while execution is pending or processing.
|
|
896
896
|
*
|
|
897
|
+
* `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.
|
|
898
|
+
*
|
|
897
899
|
* Unknown and cross-business IDs return the same not-found response.
|
|
898
900
|
*/
|
|
899
901
|
get: operations["transactions.get"];
|
|
@@ -2247,12 +2249,60 @@ export interface components {
|
|
|
2247
2249
|
/** @description The asset symbol, in the ledger's own casing (USDC, WTGXX, SOL:USDC). */
|
|
2248
2250
|
asset: string;
|
|
2249
2251
|
};
|
|
2252
|
+
TransactionDetail: {
|
|
2253
|
+
/** @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. */
|
|
2254
|
+
asset_changes: components["schemas"]["TransactionAssetChange"][];
|
|
2255
|
+
/**
|
|
2256
|
+
* Format: date-time
|
|
2257
|
+
* @description When the last leg settled. Present only when status is completed, and never alongside failed_ts.
|
|
2258
|
+
*/
|
|
2259
|
+
completed_ts?: string;
|
|
2260
|
+
/**
|
|
2261
|
+
* Format: date-time
|
|
2262
|
+
* @description When the movement was opened. Immutable, and the instant this list is ordered and paged on.
|
|
2263
|
+
*/
|
|
2264
|
+
created_ts: string;
|
|
2265
|
+
/**
|
|
2266
|
+
* Format: date-time
|
|
2267
|
+
* @description When the movement terminated as failed. Present only when status is failed, and never alongside completed_ts.
|
|
2268
|
+
*/
|
|
2269
|
+
failed_ts?: string;
|
|
2270
|
+
/** @description The transaction id. Stable for the life of the movement and safe to store. */
|
|
2271
|
+
id: string;
|
|
2272
|
+
/** @description Whether the resource represents live financial data. False for an isolated simulated ledger; independent of the reading credential. */
|
|
2273
|
+
livemode: boolean;
|
|
2274
|
+
/** @enum {string} */
|
|
2275
|
+
object: "transaction";
|
|
2276
|
+
/** @description Observed on-chain settlement references for a movement initiated by your business. Empty when none have been observed; null when unavailable. */
|
|
2277
|
+
onchain_transactions: components["schemas"]["TransactionOnchainReference"][] | null;
|
|
2278
|
+
/**
|
|
2279
|
+
* @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.
|
|
2280
|
+
* @enum {string}
|
|
2281
|
+
*/
|
|
2282
|
+
status: "pending" | "processing" | "completed" | "failed";
|
|
2283
|
+
/**
|
|
2284
|
+
* @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.
|
|
2285
|
+
* @enum {string}
|
|
2286
|
+
*/
|
|
2287
|
+
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";
|
|
2288
|
+
};
|
|
2250
2289
|
TransactionList: {
|
|
2251
2290
|
data: components["schemas"]["Transaction"][];
|
|
2252
2291
|
has_more: boolean;
|
|
2253
2292
|
/** @enum {string} */
|
|
2254
2293
|
object: "list";
|
|
2255
2294
|
};
|
|
2295
|
+
TransactionOnchainReference: {
|
|
2296
|
+
/** @description Blockchain identifier, such as ethereum or stellar. Omitted when the hash cannot be attributed to a blockchain. */
|
|
2297
|
+
chain?: string;
|
|
2298
|
+
/**
|
|
2299
|
+
* Format: uri
|
|
2300
|
+
* @description Block-explorer URL, when available. Otherwise use the hash as plain text.
|
|
2301
|
+
*/
|
|
2302
|
+
explorer_url?: string;
|
|
2303
|
+
/** @description Observed transaction hash. */
|
|
2304
|
+
hash: string;
|
|
2305
|
+
};
|
|
2256
2306
|
USBankAccountCreateDetails: {
|
|
2257
2307
|
account_number: string;
|
|
2258
2308
|
/** @enum {string} */
|
|
@@ -4156,7 +4206,7 @@ export interface operations {
|
|
|
4156
4206
|
[name: string]: unknown;
|
|
4157
4207
|
};
|
|
4158
4208
|
content: {
|
|
4159
|
-
"application/json": components["schemas"]["
|
|
4209
|
+
"application/json": components["schemas"]["TransactionDetail"];
|
|
4160
4210
|
};
|
|
4161
4211
|
};
|
|
4162
4212
|
400: components["responses"]["Error400"];
|