@stable_sea/sdk 0.1.4 → 0.1.6
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 +80 -13
- package/dist/gen/schema.d.ts +1675 -183
- package/package.json +4 -4
package/dist/gen/schema.d.ts
CHANGED
|
@@ -73,19 +73,21 @@ export interface paths {
|
|
|
73
73
|
};
|
|
74
74
|
/**
|
|
75
75
|
* List balances
|
|
76
|
-
* @description Lists
|
|
76
|
+
* @description Lists the business's balances, with one row per chain, source, asset and segregated rail. To calculate an asset total, sum its rows. A present `segregated_rail` restricts a balance to that rail; an omitted value identifies a spendable balance.
|
|
77
77
|
*
|
|
78
|
-
*
|
|
78
|
+
* **Amounts**
|
|
79
79
|
*
|
|
80
|
-
*
|
|
80
|
+
* `balance_native` is settled. `pending_incoming_native` and `pending_outgoing_native` are separate, non-negative amounts; they are not netted against each other. Within each amount, credits and debits passing through the same account in a single movement are netted.
|
|
81
81
|
*
|
|
82
|
-
*
|
|
82
|
+
* USD fields are omitted when no rate is available at `created_ts`. An omitted value means unpriced, not zero.
|
|
83
83
|
*
|
|
84
|
-
*
|
|
84
|
+
* **Pagination**
|
|
85
85
|
*
|
|
86
|
-
*
|
|
86
|
+
* `limit` defaults to 10 and cannot exceed 100. Use a balance ID as either `starting_after` or `ending_before`, not both. Rows are ordered by chain, source, asset and rail. `has_more` refers to the requested paging direction. A cursor that no longer identifies a current balance, including an emptied bucket, returns an error.
|
|
87
87
|
*
|
|
88
|
-
*
|
|
88
|
+
* **Snapshot**
|
|
89
|
+
*
|
|
90
|
+
* Balances are read live. All amounts and USD valuations reflect the snapshot time in `created_ts`. A balance ID is stable for the same business, chain, source, asset and rail.
|
|
89
91
|
*/
|
|
90
92
|
get: operations["balances.list"];
|
|
91
93
|
put?: never;
|
|
@@ -105,13 +107,11 @@ export interface paths {
|
|
|
105
107
|
};
|
|
106
108
|
/**
|
|
107
109
|
* Retrieve a balance
|
|
108
|
-
* @description Retrieves one balance by
|
|
109
|
-
*
|
|
110
|
-
* A balance is ONE (chain, source, asset, segregated rail) bucket, not an asset total. Its id is derived from that key, so it is stable across reads and can be stored and re-read.
|
|
110
|
+
* @description Retrieves one balance by its stable ID. Each balance represents a chain, source, asset and segregated rail, rather than an asset total.
|
|
111
111
|
*
|
|
112
|
-
*
|
|
112
|
+
* `balance_native` is settled. Pending incoming and outgoing amounts are reported separately. Within each pending amount, credits and debits passing through the same account in a single movement are netted. USD fields are omitted when no rate is available at `created_ts`; omission means unpriced, not zero.
|
|
113
113
|
*
|
|
114
|
-
*
|
|
114
|
+
* Unknown, emptied, and cross-business balance IDs return the same not-found response.
|
|
115
115
|
*/
|
|
116
116
|
get: operations["balances.get"];
|
|
117
117
|
put?: never;
|
|
@@ -122,6 +122,172 @@ export interface paths {
|
|
|
122
122
|
patch?: never;
|
|
123
123
|
trace?: never;
|
|
124
124
|
};
|
|
125
|
+
"/v1/bank_account_operations/{id}": {
|
|
126
|
+
parameters: {
|
|
127
|
+
query?: never;
|
|
128
|
+
header?: never;
|
|
129
|
+
path?: never;
|
|
130
|
+
cookie?: never;
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* Retrieve a bank account operation
|
|
134
|
+
* @description Returns bank registration or removal processing status. A succeeded registration records the account; it does not promise verification, enable funding or clear screening. Requires money:read.
|
|
135
|
+
*/
|
|
136
|
+
get: operations["bank_account_operations.get"];
|
|
137
|
+
put?: never;
|
|
138
|
+
post?: never;
|
|
139
|
+
delete?: never;
|
|
140
|
+
options?: never;
|
|
141
|
+
head?: never;
|
|
142
|
+
patch?: never;
|
|
143
|
+
trace?: never;
|
|
144
|
+
};
|
|
145
|
+
"/v1/bank_accounts": {
|
|
146
|
+
parameters: {
|
|
147
|
+
query?: never;
|
|
148
|
+
header?: never;
|
|
149
|
+
path?: never;
|
|
150
|
+
cookie?: never;
|
|
151
|
+
};
|
|
152
|
+
/**
|
|
153
|
+
* List bank accounts
|
|
154
|
+
* @description Lists saved US and Mexican bank accounts, newest first by created_ts, then ID. Requires money:read. Account numbers and holder identity are masked unless the key also has money:bank_accounts_sensitive_read. Institution, routing and postal address fields follow the same visibility as Terminal.
|
|
155
|
+
*
|
|
156
|
+
* Use either starting_after or ending_before with a bank account ID. limit defaults to 10 and cannot exceed 100. An unknown or removed cursor returns an error. Newly added or changed accounts can briefly return 503 before updated details are available; retry the read.
|
|
157
|
+
*/
|
|
158
|
+
get: operations["bank_accounts.list"];
|
|
159
|
+
put?: never;
|
|
160
|
+
/**
|
|
161
|
+
* Register a bank account
|
|
162
|
+
* @description Registers a US or Mexican bank account using Terminal's existing validation and screening. Provide country and the matching us_bank_account or mx_bank_account details. Requires money:bank_accounts_write and an Idempotency-Key. Poll the returned operation, then retrieve its bank_account with money:read. Registration alone does not enable the account or make it eligible for funding or payouts.
|
|
163
|
+
*/
|
|
164
|
+
post: operations["bank_accounts.create"];
|
|
165
|
+
delete?: never;
|
|
166
|
+
options?: never;
|
|
167
|
+
head?: never;
|
|
168
|
+
patch?: never;
|
|
169
|
+
trace?: never;
|
|
170
|
+
};
|
|
171
|
+
"/v1/bank_accounts/{id}": {
|
|
172
|
+
parameters: {
|
|
173
|
+
query?: never;
|
|
174
|
+
header?: never;
|
|
175
|
+
path?: never;
|
|
176
|
+
cookie?: never;
|
|
177
|
+
};
|
|
178
|
+
/**
|
|
179
|
+
* Retrieve a bank account
|
|
180
|
+
* @description Retrieves one saved bank account. Requires money:read; full account numbers and holder identity additionally require money:bank_accounts_sensitive_read. Unknown, removed and cross-business IDs return the same not-found response. Newly added or changed accounts can briefly return 503 before updated details are available; retry the read.
|
|
181
|
+
*/
|
|
182
|
+
get: operations["bank_accounts.get"];
|
|
183
|
+
put?: never;
|
|
184
|
+
post?: never;
|
|
185
|
+
delete?: never;
|
|
186
|
+
options?: never;
|
|
187
|
+
head?: never;
|
|
188
|
+
patch?: never;
|
|
189
|
+
trace?: never;
|
|
190
|
+
};
|
|
191
|
+
"/v1/bank_accounts/{id}/remove": {
|
|
192
|
+
parameters: {
|
|
193
|
+
query?: never;
|
|
194
|
+
header?: never;
|
|
195
|
+
path?: never;
|
|
196
|
+
cookie?: never;
|
|
197
|
+
};
|
|
198
|
+
get?: never;
|
|
199
|
+
put?: never;
|
|
200
|
+
/**
|
|
201
|
+
* Remove a bank account
|
|
202
|
+
* @description Archives a saved bank account using Terminal's removal restrictions. Pending transactions prevent removal. Poll the returned operation for the outcome. Removal preserves transaction history and does not cancel or reverse a deposit. Requires money:bank_accounts_write and an Idempotency-Key.
|
|
203
|
+
*/
|
|
204
|
+
post: operations["bank_accounts.remove"];
|
|
205
|
+
delete?: never;
|
|
206
|
+
options?: never;
|
|
207
|
+
head?: never;
|
|
208
|
+
patch?: never;
|
|
209
|
+
trace?: never;
|
|
210
|
+
};
|
|
211
|
+
"/v1/deposit_quotes": {
|
|
212
|
+
parameters: {
|
|
213
|
+
query?: never;
|
|
214
|
+
header?: never;
|
|
215
|
+
path?: never;
|
|
216
|
+
cookie?: never;
|
|
217
|
+
};
|
|
218
|
+
get?: never;
|
|
219
|
+
put?: never;
|
|
220
|
+
/**
|
|
221
|
+
* Create a deposit quote
|
|
222
|
+
* @description Creates a persisted ACH or wire fee quote. Requires money:read and an Idempotency-Key. Poll its ID until status is ready or failed. ACH needs an owned US bank account; the ready quote includes the amount-bound bank authorization to acknowledge before a deposit. Quotes expire five minutes after creation, and retries do not extend expiry. Wire fees are indicative; final fees use the first recorded receipt. No money moves when creating a quote.
|
|
223
|
+
*/
|
|
224
|
+
post: operations["deposit_quotes.create"];
|
|
225
|
+
delete?: never;
|
|
226
|
+
options?: never;
|
|
227
|
+
head?: never;
|
|
228
|
+
patch?: never;
|
|
229
|
+
trace?: never;
|
|
230
|
+
};
|
|
231
|
+
"/v1/deposit_quotes/{id}": {
|
|
232
|
+
parameters: {
|
|
233
|
+
query?: never;
|
|
234
|
+
header?: never;
|
|
235
|
+
path?: never;
|
|
236
|
+
cookie?: never;
|
|
237
|
+
};
|
|
238
|
+
/**
|
|
239
|
+
* Retrieve a deposit quote
|
|
240
|
+
* @description Returns the persisted quote and its fixed expiry. Requires money:read. The authorization's holder name stays masked unless the key also has money:bank_accounts_sensitive_read. Unknown and cross-business quote IDs return the same not-found response.
|
|
241
|
+
*/
|
|
242
|
+
get: operations["deposit_quotes.get"];
|
|
243
|
+
put?: never;
|
|
244
|
+
post?: never;
|
|
245
|
+
delete?: never;
|
|
246
|
+
options?: never;
|
|
247
|
+
head?: never;
|
|
248
|
+
patch?: never;
|
|
249
|
+
trace?: never;
|
|
250
|
+
};
|
|
251
|
+
"/v1/deposits": {
|
|
252
|
+
parameters: {
|
|
253
|
+
query?: never;
|
|
254
|
+
header?: never;
|
|
255
|
+
path?: never;
|
|
256
|
+
cookie?: never;
|
|
257
|
+
};
|
|
258
|
+
get?: never;
|
|
259
|
+
put?: never;
|
|
260
|
+
/**
|
|
261
|
+
* Submit an ACH deposit
|
|
262
|
+
* @description Submits an ACH deposit using one ready, unexpired deposit quote and explicit bank-authorization acknowledgement. Requires money:deposits_write and an Idempotency-Key. A quote can fund one deposit. Poll the deposit and its transaction for the actual outcome; acceptance is not settlement. The worker checks current business access, funding eligibility, fee terms and limits before booking. Retry the same request with the same key after a lost response to recover its original deposit.
|
|
263
|
+
*/
|
|
264
|
+
post: operations["deposits.create"];
|
|
265
|
+
delete?: never;
|
|
266
|
+
options?: never;
|
|
267
|
+
head?: never;
|
|
268
|
+
patch?: never;
|
|
269
|
+
trace?: never;
|
|
270
|
+
};
|
|
271
|
+
"/v1/deposits/{id}": {
|
|
272
|
+
parameters: {
|
|
273
|
+
query?: never;
|
|
274
|
+
header?: never;
|
|
275
|
+
path?: never;
|
|
276
|
+
cookie?: never;
|
|
277
|
+
};
|
|
278
|
+
/**
|
|
279
|
+
* Retrieve a deposit
|
|
280
|
+
* @description Returns the actual native funding lifecycle and transaction once booking commits. Requires money:read. A failed or returned bank pull is a failed deposit, not a settled transfer. Unknown and cross-business IDs return the same not-found response.
|
|
281
|
+
*/
|
|
282
|
+
get: operations["deposits.get"];
|
|
283
|
+
put?: never;
|
|
284
|
+
post?: never;
|
|
285
|
+
delete?: never;
|
|
286
|
+
options?: never;
|
|
287
|
+
head?: never;
|
|
288
|
+
patch?: never;
|
|
289
|
+
trace?: never;
|
|
290
|
+
};
|
|
125
291
|
"/v1/event_types": {
|
|
126
292
|
parameters: {
|
|
127
293
|
query?: never;
|
|
@@ -151,17 +317,17 @@ export interface paths {
|
|
|
151
317
|
};
|
|
152
318
|
/**
|
|
153
319
|
* List events
|
|
154
|
-
* @description Lists
|
|
320
|
+
* @description Lists all eligible events for the credential's business and environment, newest first. One credential addresses one business; there is no additional account scope. Events about pay-ins, payouts and held deposits are excluded.
|
|
155
321
|
*
|
|
156
|
-
*
|
|
322
|
+
* **Availability**
|
|
157
323
|
*
|
|
158
|
-
*
|
|
324
|
+
* Events enter the list 60 seconds after `created_ts`. Retrieve by ID to read an event during that window. The delay keeps cursor pages stable: older events do not appear behind a cursor that has already passed them. Events remain available for at least 90 days after recording.
|
|
159
325
|
*
|
|
160
|
-
*
|
|
326
|
+
* **Pagination**
|
|
161
327
|
*
|
|
162
|
-
*
|
|
328
|
+
* `limit` defaults to 10 and cannot exceed 100. Larger values are rejected. Use an event ID as either `starting_after` for older events or `ending_before` for immediately newer events, not both. Both directions return newest-first pages.
|
|
163
329
|
*
|
|
164
|
-
*
|
|
330
|
+
* `has_more` refers to currently listable events in the requested direction. It may be false while newer events are still within the availability window. Unknown, excluded, cross-business and cross-environment cursors return the same invalid-cursor response. Restart from the newest page by omitting the cursor.
|
|
165
331
|
*/
|
|
166
332
|
get: operations["events.list"];
|
|
167
333
|
put?: never;
|
|
@@ -181,13 +347,9 @@ export interface paths {
|
|
|
181
347
|
};
|
|
182
348
|
/**
|
|
183
349
|
* Retrieve an event
|
|
184
|
-
* @description Retrieves
|
|
350
|
+
* @description Retrieves an eligible event for the credential's business and environment. Events are readable immediately after recording, including the 60 seconds before they appear in list results, and remain retrievable for at least 90 days.
|
|
185
351
|
*
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
* SCOPING. Any event this credential recorded may be retrieved, and nothing else, with one exclusion: an event about a pay-in, a payout or a held deposit is not served, because this API never serves those. An id that names no event, one belonging to another business, one recorded in the other environment, and one withheld for that reason are answered identically.
|
|
189
|
-
*
|
|
190
|
-
* RETENTION. An event remains retrievable for at least 90 days after it is recorded.
|
|
352
|
+
* One credential addresses one business; there is no additional account scope. Events about pay-ins, payouts and held deposits are excluded. Unknown, excluded, cross-business and cross-environment IDs return the same not-found response.
|
|
191
353
|
*/
|
|
192
354
|
get: operations["events.get"];
|
|
193
355
|
put?: never;
|
|
@@ -198,6 +360,26 @@ export interface paths {
|
|
|
198
360
|
patch?: never;
|
|
199
361
|
trace?: never;
|
|
200
362
|
};
|
|
363
|
+
"/v1/external_wallet_operations/{id}": {
|
|
364
|
+
parameters: {
|
|
365
|
+
query?: never;
|
|
366
|
+
header?: never;
|
|
367
|
+
path?: never;
|
|
368
|
+
cookie?: never;
|
|
369
|
+
};
|
|
370
|
+
/**
|
|
371
|
+
* Retrieve an external wallet operation
|
|
372
|
+
* @description Returns processing status and the resulting wallet id. A succeeded registration records the wallet; it does not promise screening clearance, custodian approval or withdrawal eligibility.
|
|
373
|
+
*/
|
|
374
|
+
get: operations["external_wallet_operations.get"];
|
|
375
|
+
put?: never;
|
|
376
|
+
post?: never;
|
|
377
|
+
delete?: never;
|
|
378
|
+
options?: never;
|
|
379
|
+
head?: never;
|
|
380
|
+
patch?: never;
|
|
381
|
+
trace?: never;
|
|
382
|
+
};
|
|
201
383
|
"/v1/external_wallets": {
|
|
202
384
|
parameters: {
|
|
203
385
|
query?: never;
|
|
@@ -207,17 +389,29 @@ export interface paths {
|
|
|
207
389
|
};
|
|
208
390
|
/**
|
|
209
391
|
* List external wallets
|
|
210
|
-
* @description Lists
|
|
392
|
+
* @description Lists withdrawal addresses connected to the business, with the latest available on-chain holdings of tokens Stable Sea tracks. These holdings describe the external address and are excluded from `/v1/balances`.
|
|
393
|
+
*
|
|
394
|
+
* **Holdings**
|
|
395
|
+
*
|
|
396
|
+
* Holdings are available for wallets that are enabled, cleared for withdrawals, and on Ethereum or Stellar. Reads run in the background every few minutes. Readings are returned for up to 15 minutes; `holdings_read_ts` identifies the reading time.
|
|
211
397
|
*
|
|
212
|
-
*
|
|
398
|
+
* - `ok`: the latest read succeeded.
|
|
399
|
+
* - `stale`: the latest read failed; the last successful reading is shown.
|
|
400
|
+
* - `unavailable`: no reading is available. This does not mean the wallet is empty.
|
|
401
|
+
* - `shared_address`: a Stellar address with a memo; address-level holdings cannot be attributed to this destination.
|
|
402
|
+
* - `not_monitored`: the wallet does not meet the monitoring conditions. It is still listed, without holdings.
|
|
213
403
|
*
|
|
214
|
-
*
|
|
404
|
+
* **Pagination**
|
|
215
405
|
*
|
|
216
|
-
*
|
|
406
|
+
* `limit` defaults to 10 and cannot exceed 100. Use an external wallet ID as either `starting_after` or `ending_before`, not both. Wallets are ordered newest first by `created_ts`, then ID. An unknown or removed cursor returns an error.
|
|
217
407
|
*/
|
|
218
408
|
get: operations["external_wallets.list"];
|
|
219
409
|
put?: never;
|
|
220
|
-
|
|
410
|
+
/**
|
|
411
|
+
* Register an external wallet
|
|
412
|
+
* @description Submits a business-owned wallet for registration using the same validation, screening and network rules as Terminal. Poll the returned operation until processing succeeds or fails, then retrieve its external_wallet. Registration does not enable withdrawals or clear a pending review. Requires money:external_wallets_write and an Idempotency-Key.
|
|
413
|
+
*/
|
|
414
|
+
post: operations["external_wallets.create"];
|
|
221
415
|
delete?: never;
|
|
222
416
|
options?: never;
|
|
223
417
|
head?: never;
|
|
@@ -233,14 +427,40 @@ export interface paths {
|
|
|
233
427
|
};
|
|
234
428
|
/**
|
|
235
429
|
* Retrieve an external wallet
|
|
236
|
-
* @description Retrieves one
|
|
237
|
-
*
|
|
238
|
-
* holdings is read from the chain and is not money Stable Sea holds. See the listing for what each holdings_status means.
|
|
430
|
+
* @description Retrieves one withdrawal address connected to the business, with its latest available on-chain holdings when monitored. Holdings describe the external address and are excluded from `/v1/balances`. See the list endpoint for monitoring conditions and `holdings_status` values.
|
|
239
431
|
*
|
|
240
|
-
*
|
|
432
|
+
* Unknown, removed, and cross-business wallet IDs return the same not-found response.
|
|
241
433
|
*/
|
|
242
434
|
get: operations["external_wallets.get"];
|
|
243
435
|
put?: never;
|
|
436
|
+
/**
|
|
437
|
+
* Rename an external wallet
|
|
438
|
+
* @description Submits a rename for a wallet your business connected. The new name is screened using Terminal's existing rules. Poll the returned operation for the outcome. The address, network and other wallet properties remain unchanged.
|
|
439
|
+
*/
|
|
440
|
+
post: operations["external_wallets.rename"];
|
|
441
|
+
delete?: never;
|
|
442
|
+
options?: never;
|
|
443
|
+
head?: never;
|
|
444
|
+
patch?: never;
|
|
445
|
+
trace?: never;
|
|
446
|
+
};
|
|
447
|
+
"/v1/funding": {
|
|
448
|
+
parameters: {
|
|
449
|
+
query?: never;
|
|
450
|
+
header?: never;
|
|
451
|
+
path?: never;
|
|
452
|
+
cookie?: never;
|
|
453
|
+
};
|
|
454
|
+
/**
|
|
455
|
+
* Read deposit methods and instructions
|
|
456
|
+
* @description Returns ACH deposit limits, wire instructions and on-chain deposit addresses for your business. Requires money:read. Limits and method switches are read when you make the request; eligibility is checked again when a deposit executes.
|
|
457
|
+
*
|
|
458
|
+
* Wire instructions are available after business verification and funding setup. On-chain addresses follow the same network and source-wallet screening rules as Terminal. A nonempty memo must accompany the transfer.
|
|
459
|
+
*
|
|
460
|
+
* Instruction updates may briefly return 503 while they become available. instructions_updated_ts records their last refresh; observed_ts records the current limit and control observation. Test keys use isolated sandbox data and simulated financial partners.
|
|
461
|
+
*/
|
|
462
|
+
get: operations["funding.snapshot"];
|
|
463
|
+
put?: never;
|
|
244
464
|
post?: never;
|
|
245
465
|
delete?: never;
|
|
246
466
|
options?: never;
|
|
@@ -303,11 +523,11 @@ export interface paths {
|
|
|
303
523
|
put?: never;
|
|
304
524
|
/**
|
|
305
525
|
* Place a fund order
|
|
306
|
-
* @description
|
|
526
|
+
* @description Creates a fund order for the authenticated business and returns it as `pending`. Execution is asynchronous and uses the same authorization checks and trading engine as Terminal. Retrieve the order to follow it through `executing` to `filled` or `failed`.
|
|
307
527
|
*
|
|
308
|
-
*
|
|
528
|
+
* The quoted price is checked against the NAV at execution. Price changes and insufficient express liquidity can cause execution to fail. The failed order includes a reason. While the quote remains valid, an express refusal can be submitted as a new standard order.
|
|
309
529
|
*
|
|
310
|
-
*
|
|
530
|
+
* Use a Live key with the production URL or a Test key with the sandbox URL. A credential environment this host does not serve returns `environment_not_served` before an order or idempotency record is created.
|
|
311
531
|
*/
|
|
312
532
|
post: operations["orders.create"];
|
|
313
533
|
delete?: never;
|
|
@@ -345,7 +565,15 @@ export interface paths {
|
|
|
345
565
|
};
|
|
346
566
|
/**
|
|
347
567
|
* Read effective money controls
|
|
348
|
-
* @description
|
|
568
|
+
* @description Returns the authenticated business's movement switches, effective limits, usage and outgoing approval tiers. This read-only snapshot does not authorize a transfer or enable withdrawal creation through the API. Controls are checked again when a request executes.
|
|
569
|
+
*
|
|
570
|
+
* **Limits**
|
|
571
|
+
*
|
|
572
|
+
* A null limit means no flow-wide USD cap; other asset and settlement checks still apply. Limit windows include calendar and rolling periods. Release delay and destination cooloff report `supported: false`.
|
|
573
|
+
*
|
|
574
|
+
* **Approvals**
|
|
575
|
+
*
|
|
576
|
+
* The highest matching approval threshold applies when USD valuation is available. If valuation is unavailable for an on-chain withdrawal or fund trade, the highest configured rule for that flow applies regardless of amount. A pending request must be resubmitted if its policy changes.
|
|
349
577
|
*/
|
|
350
578
|
get: operations["policies.snapshot"];
|
|
351
579
|
put?: never;
|
|
@@ -365,11 +593,9 @@ export interface paths {
|
|
|
365
593
|
};
|
|
366
594
|
/**
|
|
367
595
|
* Price a fund trade
|
|
368
|
-
* @description
|
|
369
|
-
*
|
|
370
|
-
* The express block states the TERMS of the express pathway — its commission, its per-order ceiling and what it would deliver — and is not a statement that express is available. Express settlement draws on a shared reserve, so an express order can be refused at execution even when a quote carried these terms. There is deliberately no availability flag: a reserve reading taken now would warrant nothing about the reserve when the order executes.
|
|
596
|
+
* @description Returns a price to include when placing a fund order. Quotes are calculated on request, have no ID and cannot be retrieved later.
|
|
371
597
|
*
|
|
372
|
-
*
|
|
598
|
+
* `express` describes the commission, order limit, estimated quantity and settlement estimate for express settlement. These terms do not guarantee available liquidity. An express order may fail at execution; while the quote remains valid, you can submit a new standard order using the same quoted price. Standard settlement changes the commission and delivered quantity, not the quoted price.
|
|
373
599
|
*/
|
|
374
600
|
get: operations["quotes.quote"];
|
|
375
601
|
put?: never;
|
|
@@ -400,6 +626,46 @@ export interface paths {
|
|
|
400
626
|
patch?: never;
|
|
401
627
|
trace?: never;
|
|
402
628
|
};
|
|
629
|
+
"/v1/source_wallet_declarations": {
|
|
630
|
+
parameters: {
|
|
631
|
+
query?: never;
|
|
632
|
+
header?: never;
|
|
633
|
+
path?: never;
|
|
634
|
+
cookie?: never;
|
|
635
|
+
};
|
|
636
|
+
get?: never;
|
|
637
|
+
put?: never;
|
|
638
|
+
/**
|
|
639
|
+
* Declare a source wallet
|
|
640
|
+
* @description Screens the wallet you intend to fund from using Terminal's existing screening service. Requires money:deposits_write and an Idempotency-Key. Poll until status is screened or failed, then check funding for available deposit instructions. Only the clearance outcome is returned. Retrying a completed declaration does not screen it again or renew its clearance.
|
|
641
|
+
*/
|
|
642
|
+
post: operations["source_wallet_declarations.create"];
|
|
643
|
+
delete?: never;
|
|
644
|
+
options?: never;
|
|
645
|
+
head?: never;
|
|
646
|
+
patch?: never;
|
|
647
|
+
trace?: never;
|
|
648
|
+
};
|
|
649
|
+
"/v1/source_wallet_declarations/{id}": {
|
|
650
|
+
parameters: {
|
|
651
|
+
query?: never;
|
|
652
|
+
header?: never;
|
|
653
|
+
path?: never;
|
|
654
|
+
cookie?: never;
|
|
655
|
+
};
|
|
656
|
+
/**
|
|
657
|
+
* Retrieve a source-wallet declaration
|
|
658
|
+
* @description Returns the recorded screening outcome. Requires money:read. A completed declaration is historical; check funding for current deposit eligibility. Unknown and cross-business IDs return the same not-found response.
|
|
659
|
+
*/
|
|
660
|
+
get: operations["source_wallet_declarations.get"];
|
|
661
|
+
put?: never;
|
|
662
|
+
post?: never;
|
|
663
|
+
delete?: never;
|
|
664
|
+
options?: never;
|
|
665
|
+
head?: never;
|
|
666
|
+
patch?: never;
|
|
667
|
+
trace?: never;
|
|
668
|
+
};
|
|
403
669
|
"/v1/statements": {
|
|
404
670
|
parameters: {
|
|
405
671
|
query?: never;
|
|
@@ -469,23 +735,30 @@ export interface paths {
|
|
|
469
735
|
};
|
|
470
736
|
/**
|
|
471
737
|
* List transactions
|
|
472
|
-
* @description Lists the business's money movements, newest first.
|
|
738
|
+
* @description Lists the business's money movements, newest first. Each transaction represents one movement.
|
|
473
739
|
*
|
|
474
|
-
*
|
|
740
|
+
* **Settled amounts**
|
|
475
741
|
*
|
|
476
|
-
*
|
|
742
|
+
* `asset_changes` reports the signed net effect on the business's settled holdings, after fees and taxes: negative amounts decrease holdings and positive amounts increase them. Transfers through accounts outside `/v1/balances`, such as bank accounts and external addresses, are excluded from these amounts. Failed, unsettled parts of a movement contribute no change.
|
|
477
743
|
*
|
|
478
|
-
*
|
|
744
|
+
* Reconcile using `asset_changes` from all transactions, including failed transactions, rather than filtering by status. A partially settled movement reports the changes that settled. Pay-ins and payouts are excluded from transaction, statement-transaction and event lists, but still affect balances and statement totals. Businesses with those movements need additional payment records to reconcile.
|
|
479
745
|
*
|
|
480
|
-
*
|
|
746
|
+
* **Status**
|
|
481
747
|
*
|
|
482
|
-
*
|
|
748
|
+
* - `pending`: execution has not started.
|
|
749
|
+
* - `processing`: at least one part is in flight.
|
|
750
|
+
* - `completed`: all parts settled; `completed_ts` records the final settlement.
|
|
751
|
+
* - `failed`: the movement ended unsuccessfully; `failed_ts` records the failure. Some parts may already have settled and are included in `asset_changes`.
|
|
483
752
|
*
|
|
484
|
-
*
|
|
753
|
+
* **Pagination**
|
|
485
754
|
*
|
|
486
|
-
*
|
|
755
|
+
* `limit` defaults to 10 and cannot exceed 100. Use a transaction ID as either `starting_after` for older transactions or `ending_before` for immediately newer transactions, not both. Both directions return newest-first pages. `has_more` refers to the requested direction. An unreadable cursor returns an error.
|
|
487
756
|
*
|
|
488
|
-
*
|
|
757
|
+
* The order is fixed by `created_ts` and ID. New activity does not shift an older-page sweep; changing direction can return a previously seen transaction. Deduplicate by ID.
|
|
758
|
+
*
|
|
759
|
+
* **Updates**
|
|
760
|
+
*
|
|
761
|
+
* Transactions are available as soon as they are booked. Reads return the current status and settled changes. ID, `created_ts` and type remain unchanged.
|
|
489
762
|
*/
|
|
490
763
|
get: operations["transactions.list"];
|
|
491
764
|
put?: never;
|
|
@@ -505,17 +778,15 @@ export interface paths {
|
|
|
505
778
|
};
|
|
506
779
|
/**
|
|
507
780
|
* Retrieve a transaction
|
|
508
|
-
* @description Retrieves one
|
|
781
|
+
* @description Retrieves one money movement by its stable transaction ID.
|
|
509
782
|
*
|
|
510
|
-
*
|
|
783
|
+
* `asset_changes` reports its signed net effect on the business's settled holdings, after fees and taxes. Negative amounts decrease holdings; positive amounts increase them. Parts that have not settled, or that touch accounts outside `/v1/balances`, contribute no change.
|
|
511
784
|
*
|
|
512
|
-
*
|
|
785
|
+
* A movement can fail after partial settlement. Reconcile using the settled changes from every transaction, including failed ones. Pay-ins and payouts are excluded from this API but still affect balances and statement totals, so businesses with those movements need additional payment records to reconcile.
|
|
513
786
|
*
|
|
514
|
-
*
|
|
787
|
+
* The status is `pending`, `processing`, `completed` or `failed`. `completed_ts` and `failed_ts` are mutually exclusive and absent while execution is pending or processing.
|
|
515
788
|
*
|
|
516
|
-
*
|
|
517
|
-
*
|
|
518
|
-
* SCOPING. Any transaction booked for this credential's business may be retrieved, and nothing else. An id that names no movement and one belonging to another business are answered identically.
|
|
789
|
+
* Unknown and cross-business IDs return the same not-found response.
|
|
519
790
|
*/
|
|
520
791
|
get: operations["transactions.get"];
|
|
521
792
|
put?: never;
|
|
@@ -541,7 +812,7 @@ export interface paths {
|
|
|
541
812
|
put?: never;
|
|
542
813
|
/**
|
|
543
814
|
* Create a webhook endpoint
|
|
544
|
-
* @description Registers one HTTPS webhook endpoint for the authenticated business. The signing secret is returned only by this response and its
|
|
815
|
+
* @description Registers one HTTPS webhook endpoint for the authenticated business. The signing secret is returned only by this response and a replay of the same request with its idempotency key.
|
|
545
816
|
*/
|
|
546
817
|
post: operations["webhook_endpoints.create"];
|
|
547
818
|
delete?: never;
|
|
@@ -583,7 +854,7 @@ export interface paths {
|
|
|
583
854
|
};
|
|
584
855
|
/**
|
|
585
856
|
* List webhook deliveries
|
|
586
|
-
* @description Lists
|
|
857
|
+
* @description Lists delivery status for an endpoint, newest first, without signing secrets. limit defaults to 10 and may not exceed 100. starting_after and ending_before are mutually exclusive. Deliveries of events about pay-ins and payouts (and held deposits, which have no /v1 transaction) are not served, and none is sent. A cursor that names a withheld delivery is refused like a cursor that names no delivery, so restart from the newest page by sending no cursor.
|
|
587
858
|
*/
|
|
588
859
|
get: operations["webhook_deliveries.list"];
|
|
589
860
|
put?: never;
|
|
@@ -645,7 +916,7 @@ export interface paths {
|
|
|
645
916
|
put?: never;
|
|
646
917
|
/**
|
|
647
918
|
* Disable a webhook endpoint
|
|
648
|
-
* @description Disables a webhook endpoint so future events are
|
|
919
|
+
* @description Disables a webhook endpoint so future events are no longer scheduled for delivery. Repeating the operation is safe.
|
|
649
920
|
*/
|
|
650
921
|
post: operations["webhook_endpoints.disable"];
|
|
651
922
|
delete?: never;
|
|
@@ -665,7 +936,7 @@ export interface paths {
|
|
|
665
936
|
put?: never;
|
|
666
937
|
/**
|
|
667
938
|
* Rotate a webhook endpoint signing secret
|
|
668
|
-
* @description Issues a replacement signing secret for this endpoint. The secret is returned only by this response and its
|
|
939
|
+
* @description Issues a replacement signing secret for this endpoint. The secret is returned only by this response and a replay of the same request with its idempotency key.
|
|
669
940
|
*/
|
|
670
941
|
post: operations["webhook_endpoints.rotate_secret"];
|
|
671
942
|
delete?: never;
|
|
@@ -695,7 +966,7 @@ export interface components {
|
|
|
695
966
|
capabilities: string[];
|
|
696
967
|
/**
|
|
697
968
|
* Format: date-time
|
|
698
|
-
* @description When
|
|
969
|
+
* @description When the business's first API credential was issued in this environment. Unchanged by key rotation; separate from the business's signup date.
|
|
699
970
|
*/
|
|
700
971
|
created_ts: string;
|
|
701
972
|
/** @description The account id. Constant for the life of a credential. */
|
|
@@ -716,7 +987,7 @@ export interface components {
|
|
|
716
987
|
asset: string;
|
|
717
988
|
/** @description The settled balance, in the asset's own units. */
|
|
718
989
|
balance_native: string;
|
|
719
|
-
/** @description
|
|
990
|
+
/** @description Settled balance in USD. Omitted when no rate is available at created_ts; omission means unpriced, not zero. */
|
|
720
991
|
balance_usd?: string;
|
|
721
992
|
/**
|
|
722
993
|
* @description The network this holding sits on. off_chain is the chain-agnostic omnibus balance; unknown means the chain could not be attributed, and the holding is reported anyway rather than dropped.
|
|
@@ -730,19 +1001,19 @@ export interface components {
|
|
|
730
1001
|
created_ts: string;
|
|
731
1002
|
/** @description The balance id. Derived from (business, chain, source, asset, segregated rail), so it is stable across reads and safe to diff against. */
|
|
732
1003
|
id: string;
|
|
733
|
-
/** @description False
|
|
1004
|
+
/** @description Whether the resource represents live financial data. False for an isolated simulated ledger; independent of the reading credential. */
|
|
734
1005
|
livemode: boolean;
|
|
735
1006
|
/** @enum {string} */
|
|
736
1007
|
object: "balance";
|
|
737
|
-
/** @description Value
|
|
1008
|
+
/** @description Value incoming to this balance and not yet settled, in the asset's own units. Never netted against pending_outgoing_native. A single movement's pass-through legs are netted inside this figure: an account credited and debited within one movement counts once, not twice in both directions. */
|
|
738
1009
|
pending_incoming_native: string;
|
|
739
|
-
/** @description pending_incoming_native valued in USD.
|
|
1010
|
+
/** @description pending_incoming_native valued in USD. Omitted when no rate is available at created_ts. */
|
|
740
1011
|
pending_incoming_usd?: string;
|
|
741
|
-
/** @description Value
|
|
1012
|
+
/** @description Value outgoing from this balance and not yet settled, in the asset's own units. Never netted against pending_incoming_native. A single movement's pass-through legs are netted inside this figure: an account credited and debited within one movement counts once, not twice in both directions. */
|
|
742
1013
|
pending_outgoing_native: string;
|
|
743
|
-
/** @description pending_outgoing_native valued in USD.
|
|
1014
|
+
/** @description pending_outgoing_native valued in USD. Omitted when no rate is available at created_ts. */
|
|
744
1015
|
pending_outgoing_usd?: string;
|
|
745
|
-
/** @description The rail this balance is
|
|
1016
|
+
/** @description The rail to which this balance is restricted. Omitted for spendable balances. A present value means the balance can be held and withdrawn only over that rail. */
|
|
746
1017
|
segregated_rail?: string;
|
|
747
1018
|
/**
|
|
748
1019
|
* @description The custodian holding this balance.
|
|
@@ -756,50 +1027,208 @@ export interface components {
|
|
|
756
1027
|
/** @enum {string} */
|
|
757
1028
|
object: "list";
|
|
758
1029
|
};
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
/** @description Credential ID issued by a duplicate credential-mint request. */
|
|
765
|
-
api_client_id?: string;
|
|
766
|
-
/** @description Stable machine-readable error code when supplied; use error.type for uncoded errors. */
|
|
767
|
-
code?: string;
|
|
768
|
-
/** @description Per-field validation breakdown. */
|
|
769
|
-
errors?: {
|
|
770
|
-
/** @description Field-level error code. */
|
|
771
|
-
code?: string;
|
|
772
|
-
/** @description Human-readable detail for this field. */
|
|
773
|
-
detail?: string;
|
|
774
|
-
/** @description RFC 6901 JSON Pointer to the offending field. */
|
|
775
|
-
pointer?: string;
|
|
776
|
-
}[];
|
|
777
|
-
/** @description Human-readable message. Not a contract; branch on code/type. */
|
|
778
|
-
message?: string;
|
|
779
|
-
/** @description RFC 6901 JSON Pointer to the first offending field (validation errors). */
|
|
780
|
-
param?: string;
|
|
781
|
-
/** @description Correlates with the Request-Id response header. */
|
|
782
|
-
request_id?: string;
|
|
783
|
-
/**
|
|
784
|
-
* @description Error class. One of a closed enum.
|
|
785
|
-
* @enum {string}
|
|
786
|
-
*/
|
|
787
|
-
type: "invalid_request_error" | "authentication_error" | "permission_error" | "idempotency_error" | "rate_limit_error" | "api_error";
|
|
788
|
-
};
|
|
789
|
-
};
|
|
790
|
-
Event: {
|
|
791
|
-
account?: string;
|
|
792
|
-
api_version: components["schemas"]["APIVersion"];
|
|
1030
|
+
BankAccount: {
|
|
1031
|
+
/** @enum {string} */
|
|
1032
|
+
beneficiary_type: "self" | "third_party";
|
|
1033
|
+
/** @enum {string} */
|
|
1034
|
+
country: "US" | "MX";
|
|
793
1035
|
/** Format: date-time */
|
|
794
1036
|
created_ts: string;
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
1037
|
+
/** @enum {string} */
|
|
1038
|
+
currency: "USD" | "MXN";
|
|
1039
|
+
/** @description True when account numbers and holder identity are masked. Full details require money:bank_accounts_sensitive_read in addition to money:read. */
|
|
1040
|
+
details_masked: boolean;
|
|
798
1041
|
id: string;
|
|
1042
|
+
/** @description False for an isolated simulated bank account. */
|
|
799
1043
|
livemode: boolean;
|
|
1044
|
+
mx_bank_account?: components["schemas"]["MXBankAccountDetails"];
|
|
800
1045
|
/** @enum {string} */
|
|
801
|
-
object: "
|
|
802
|
-
|
|
1046
|
+
object: "bank_account";
|
|
1047
|
+
/**
|
|
1048
|
+
* @description Current bank account status. Does not guarantee that every funding or payout method is available.
|
|
1049
|
+
* @enum {string}
|
|
1050
|
+
*/
|
|
1051
|
+
status: "enabled" | "disabled";
|
|
1052
|
+
us_bank_account?: components["schemas"]["USBankAccountDetails"];
|
|
1053
|
+
};
|
|
1054
|
+
BankAccountAddress: {
|
|
1055
|
+
city: string;
|
|
1056
|
+
line1: string;
|
|
1057
|
+
line2?: string | null;
|
|
1058
|
+
postal_code: string;
|
|
1059
|
+
state: string;
|
|
1060
|
+
};
|
|
1061
|
+
BankAccountCreateAddress: {
|
|
1062
|
+
city: string;
|
|
1063
|
+
line1: string;
|
|
1064
|
+
line2?: string | null;
|
|
1065
|
+
postal_code: string;
|
|
1066
|
+
state: string;
|
|
1067
|
+
};
|
|
1068
|
+
BankAccountCreateInput: {
|
|
1069
|
+
/**
|
|
1070
|
+
* @description Declare self only when this business owns the account. Omission is treated as third_party.
|
|
1071
|
+
* @enum {string|null}
|
|
1072
|
+
*/
|
|
1073
|
+
beneficiary_type?: "self" | "third_party" | null;
|
|
1074
|
+
/** @enum {string} */
|
|
1075
|
+
country: "US" | "MX";
|
|
1076
|
+
mx_bank_account?: components["schemas"]["MXBankAccountCreateDetails"];
|
|
1077
|
+
us_bank_account?: components["schemas"]["USBankAccountCreateDetails"];
|
|
1078
|
+
};
|
|
1079
|
+
BankAccountList: {
|
|
1080
|
+
data: components["schemas"]["BankAccount"][];
|
|
1081
|
+
has_more: boolean;
|
|
1082
|
+
/** @enum {string} */
|
|
1083
|
+
object: "list";
|
|
1084
|
+
};
|
|
1085
|
+
BankAccountOperation: {
|
|
1086
|
+
/** @description The registered or removed bank account, once processing succeeds. Registration does not enable funding or payouts. */
|
|
1087
|
+
bank_account?: string;
|
|
1088
|
+
/** Format: date-time */
|
|
1089
|
+
created_ts: string;
|
|
1090
|
+
failure_code?: string;
|
|
1091
|
+
id: string;
|
|
1092
|
+
livemode: boolean;
|
|
1093
|
+
/** @enum {string} */
|
|
1094
|
+
object: "bank_account_operation";
|
|
1095
|
+
/** @enum {string} */
|
|
1096
|
+
operation: "create" | "remove";
|
|
1097
|
+
/** @enum {string} */
|
|
1098
|
+
state: "pending" | "succeeded" | "failed";
|
|
1099
|
+
};
|
|
1100
|
+
Decimal: string;
|
|
1101
|
+
Deposit: {
|
|
1102
|
+
/** Format: date-time */
|
|
1103
|
+
created_ts: string;
|
|
1104
|
+
failure_code?: string;
|
|
1105
|
+
id: string;
|
|
1106
|
+
livemode: boolean;
|
|
1107
|
+
/** @enum {string} */
|
|
1108
|
+
object: "deposit";
|
|
1109
|
+
/**
|
|
1110
|
+
* @description Native funding lifecycle. A bank return is a failed deposit; submission is not settlement.
|
|
1111
|
+
* @enum {string}
|
|
1112
|
+
*/
|
|
1113
|
+
status: "pending" | "processing" | "completed" | "failed";
|
|
1114
|
+
transaction?: string;
|
|
1115
|
+
};
|
|
1116
|
+
DepositInput: {
|
|
1117
|
+
/** @description Acknowledge the ACH authorization returned with this quote before submission. */
|
|
1118
|
+
authorization_accepted: boolean;
|
|
1119
|
+
quote_id: string;
|
|
1120
|
+
};
|
|
1121
|
+
DepositQuote: {
|
|
1122
|
+
/** Format: date-time */
|
|
1123
|
+
created_ts: string;
|
|
1124
|
+
details: {
|
|
1125
|
+
amount_usd: string;
|
|
1126
|
+
authorization: {
|
|
1127
|
+
account_holder_name: string;
|
|
1128
|
+
account_number_masked: string;
|
|
1129
|
+
account_type: string;
|
|
1130
|
+
/** @description Bank acknowledgment text; redacted as **** without money:bank_accounts_sensitive_read. */
|
|
1131
|
+
acknowledgment: string;
|
|
1132
|
+
/** @description Amount-bound authorization details; redacted as **** without money:bank_accounts_sensitive_read. */
|
|
1133
|
+
authorization_details: string;
|
|
1134
|
+
bank_name: string;
|
|
1135
|
+
/** @description Whether holder identity and authorization text are redacted. */
|
|
1136
|
+
holder_masked: boolean;
|
|
1137
|
+
/** @description Bank authorization text; redacted as **** without money:bank_accounts_sensitive_read. */
|
|
1138
|
+
review_authorization: string;
|
|
1139
|
+
routing_number: string;
|
|
1140
|
+
} | null;
|
|
1141
|
+
bank_account: string | null;
|
|
1142
|
+
pricing: {
|
|
1143
|
+
bank_fee_usd: string;
|
|
1144
|
+
/** Format: int64 */
|
|
1145
|
+
bps: number;
|
|
1146
|
+
/** @description Whether current policy sweeps conversion surplus above 1:1 USD/USDC before fees. This does not guarantee a below-par top-up. */
|
|
1147
|
+
caps_at_par: boolean;
|
|
1148
|
+
/** @description USD amount converted before platform fees. */
|
|
1149
|
+
conversion_input: string;
|
|
1150
|
+
/** @description Indicative gross USDC proceeds before platform fees. */
|
|
1151
|
+
estimated_conversion_output?: string | null;
|
|
1152
|
+
/** @description Indicative USDC per USD before fees; not a guaranteed rate. */
|
|
1153
|
+
estimated_conversion_rate?: string | null;
|
|
1154
|
+
/** @description Indicative USDC proceeds after fees, not guaranteed settlement. */
|
|
1155
|
+
estimated_proceeds?: string | null;
|
|
1156
|
+
platform_fee_usdc: string;
|
|
1157
|
+
/** @enum {string} */
|
|
1158
|
+
settlement_asset: "USDC";
|
|
1159
|
+
/** @description Whether current policy targets 1:1 USD/USDC before fees. Below-par top-ups require a shortfall no greater than the larger of 25 basis points of principal or 1 USD, sufficient platform funds and accepted adjustment; otherwise settlement uses the market fill. */
|
|
1160
|
+
settles_at_par: boolean;
|
|
1161
|
+
/** @enum {string} */
|
|
1162
|
+
source_symbol: "USD";
|
|
1163
|
+
total_source_debit: string;
|
|
1164
|
+
};
|
|
1165
|
+
/** @enum {string} */
|
|
1166
|
+
rail: "ach" | "wire";
|
|
1167
|
+
/** @description ACH fees are fixed until expiry, subject to current fee terms and eligibility. Wire fees are indicative; final fees use the first recorded receipt. */
|
|
1168
|
+
terms_fixed: boolean;
|
|
1169
|
+
} | null;
|
|
1170
|
+
/**
|
|
1171
|
+
* Format: date-time
|
|
1172
|
+
* @description Fixed expiry for this quote; retries do not extend it.
|
|
1173
|
+
*/
|
|
1174
|
+
expires_ts: string;
|
|
1175
|
+
failure_code?: string;
|
|
1176
|
+
id: string;
|
|
1177
|
+
livemode: boolean;
|
|
1178
|
+
/** @enum {string} */
|
|
1179
|
+
object: "deposit_quote";
|
|
1180
|
+
/** @enum {string} */
|
|
1181
|
+
status: "pending" | "ready" | "failed";
|
|
1182
|
+
};
|
|
1183
|
+
DepositQuoteInput: {
|
|
1184
|
+
amount_usd: string;
|
|
1185
|
+
bank_account?: string;
|
|
1186
|
+
/** @enum {string} */
|
|
1187
|
+
rail: "ach" | "wire";
|
|
1188
|
+
};
|
|
1189
|
+
Error: {
|
|
1190
|
+
error: {
|
|
1191
|
+
/** @description Legal values/transitions on an illegal-transition conflict. */
|
|
1192
|
+
allowed?: string[];
|
|
1193
|
+
/** @description Credential ID issued by a duplicate credential-mint request. */
|
|
1194
|
+
api_client_id?: string;
|
|
1195
|
+
/** @description Stable machine-readable error code when supplied; use error.type for uncoded errors. */
|
|
1196
|
+
code?: string;
|
|
1197
|
+
/** @description Per-field validation breakdown. */
|
|
1198
|
+
errors?: {
|
|
1199
|
+
/** @description Field-level error code. */
|
|
1200
|
+
code?: string;
|
|
1201
|
+
/** @description Human-readable detail for this field. */
|
|
1202
|
+
detail?: string;
|
|
1203
|
+
/** @description RFC 6901 JSON Pointer to the offending field. */
|
|
1204
|
+
pointer?: string;
|
|
1205
|
+
}[];
|
|
1206
|
+
/** @description Human-readable explanation. Use code or type for programmatic handling. */
|
|
1207
|
+
message?: string;
|
|
1208
|
+
/** @description RFC 6901 JSON Pointer to the first offending field (validation errors). */
|
|
1209
|
+
param?: string;
|
|
1210
|
+
/** @description Correlates with the Request-Id response header. */
|
|
1211
|
+
request_id?: string;
|
|
1212
|
+
/**
|
|
1213
|
+
* @description Error class. One of a closed enum.
|
|
1214
|
+
* @enum {string}
|
|
1215
|
+
*/
|
|
1216
|
+
type: "invalid_request_error" | "authentication_error" | "permission_error" | "idempotency_error" | "rate_limit_error" | "api_error";
|
|
1217
|
+
};
|
|
1218
|
+
};
|
|
1219
|
+
Event: {
|
|
1220
|
+
account?: string;
|
|
1221
|
+
api_version: components["schemas"]["APIVersion"];
|
|
1222
|
+
/** Format: date-time */
|
|
1223
|
+
created_ts: string;
|
|
1224
|
+
data: {
|
|
1225
|
+
object: components["schemas"]["ResourceReference"];
|
|
1226
|
+
};
|
|
1227
|
+
id: string;
|
|
1228
|
+
livemode: boolean;
|
|
1229
|
+
/** @enum {string} */
|
|
1230
|
+
object: "event";
|
|
1231
|
+
type: string;
|
|
803
1232
|
};
|
|
804
1233
|
EventList: {
|
|
805
1234
|
data: components["schemas"]["Event"][];
|
|
@@ -820,7 +1249,7 @@ export interface components {
|
|
|
820
1249
|
object: "list";
|
|
821
1250
|
};
|
|
822
1251
|
/** @enum {string} */
|
|
823
|
-
EventTypeName: "notification.created" | "order.updated" | "transaction.created" | "transaction.updated";
|
|
1252
|
+
EventTypeName: "bank_account.created" | "bank_account.removed" | "bank_account_operation.updated" | "deposit.updated" | "deposit_quote.updated" | "external_wallet.created" | "external_wallet.updated" | "external_wallet_operation.updated" | "notification.created" | "order.updated" | "source_wallet_declaration.updated" | "transaction.created" | "transaction.updated";
|
|
824
1253
|
ExternalWallet: {
|
|
825
1254
|
/** @description The wallet's on-chain address, exactly as the business connected it. */
|
|
826
1255
|
address: string;
|
|
@@ -842,16 +1271,18 @@ export interface components {
|
|
|
842
1271
|
*/
|
|
843
1272
|
holdings_read_ts?: string;
|
|
844
1273
|
/**
|
|
845
|
-
* @description
|
|
1274
|
+
* @description Availability of holdings. ok: latest read succeeded. stale: latest read failed and the last successful reading is shown. unavailable: no successful reading within 15 minutes; empty holdings do not imply an empty wallet. shared_address: Stellar memo destination whose holdings cannot be attributed at address level. not_monitored: disabled, not cleared for withdrawals, or on an unsupported network. Available readings are at most 15 minutes old; holdings_read_ts identifies their time.
|
|
846
1275
|
* @enum {string}
|
|
847
1276
|
*/
|
|
848
1277
|
holdings_status: "ok" | "stale" | "unavailable" | "shared_address" | "not_monitored";
|
|
849
1278
|
/** @description The external wallet id. Stable for the life of the wallet and safe to store. */
|
|
850
1279
|
id: string;
|
|
851
|
-
/** @description
|
|
1280
|
+
/** @description Whether holdings represent live on-chain data. False for isolated simulated holdings; independent of the reading credential. */
|
|
852
1281
|
livemode: boolean;
|
|
853
|
-
/** @description
|
|
1282
|
+
/** @description Optional Stellar memo identifying this withdrawal destination. Address-level holdings are not reported when a memo is present. */
|
|
854
1283
|
memo?: string;
|
|
1284
|
+
/** @description The name your business assigned to this wallet. */
|
|
1285
|
+
name?: string;
|
|
855
1286
|
/** @enum {string} */
|
|
856
1287
|
object: "external_wallet";
|
|
857
1288
|
/** @description The network the wallet is on, as a withdrawal rail (onchain_ethereum, onchain_stellar). */
|
|
@@ -862,6 +1293,18 @@ export interface components {
|
|
|
862
1293
|
*/
|
|
863
1294
|
status: "enabled" | "disabled";
|
|
864
1295
|
};
|
|
1296
|
+
ExternalWalletCreateInput: {
|
|
1297
|
+
address: string;
|
|
1298
|
+
memo?: string;
|
|
1299
|
+
memo_not_required?: boolean;
|
|
1300
|
+
name: string;
|
|
1301
|
+
/** @description Confirm that this business owns and controls the wallet. */
|
|
1302
|
+
owner_attestation: boolean;
|
|
1303
|
+
/** @enum {string} */
|
|
1304
|
+
payment_rail: "onchain_ethereum" | "onchain_stellar" | "onchain_solana";
|
|
1305
|
+
/** @enum {string} */
|
|
1306
|
+
symbol?: "USDC" | "XLM";
|
|
1307
|
+
};
|
|
865
1308
|
ExternalWalletHolding: {
|
|
866
1309
|
/** @description The quantity held, in the token's own units. Exact, never rounded, and always above zero. */
|
|
867
1310
|
amount: string;
|
|
@@ -883,12 +1326,121 @@ export interface components {
|
|
|
883
1326
|
/** @enum {string} */
|
|
884
1327
|
object: "list";
|
|
885
1328
|
};
|
|
1329
|
+
ExternalWalletOperation: {
|
|
1330
|
+
/** Format: date-time */
|
|
1331
|
+
created_ts: string;
|
|
1332
|
+
/** @description The resulting wallet, once recorded. Registration does not enable withdrawals or clear review. */
|
|
1333
|
+
external_wallet?: string;
|
|
1334
|
+
failure_code?: string;
|
|
1335
|
+
id: string;
|
|
1336
|
+
livemode: boolean;
|
|
1337
|
+
/** @enum {string} */
|
|
1338
|
+
object: "external_wallet_operation";
|
|
1339
|
+
/** @enum {string} */
|
|
1340
|
+
operation: "create" | "rename";
|
|
1341
|
+
/** @enum {string} */
|
|
1342
|
+
state: "pending" | "succeeded" | "failed";
|
|
1343
|
+
};
|
|
1344
|
+
ExternalWalletRenameInput: {
|
|
1345
|
+
name: string;
|
|
1346
|
+
};
|
|
1347
|
+
FundingMethod: {
|
|
1348
|
+
ach?: {
|
|
1349
|
+
/** @enum {string} */
|
|
1350
|
+
binding_window: "daily" | "weekly";
|
|
1351
|
+
daily: {
|
|
1352
|
+
limit_usd: string;
|
|
1353
|
+
remaining_usd: string;
|
|
1354
|
+
/** Format: date-time */
|
|
1355
|
+
resets_ts: string;
|
|
1356
|
+
used_usd: string;
|
|
1357
|
+
};
|
|
1358
|
+
enabled: boolean;
|
|
1359
|
+
remaining_usd: string;
|
|
1360
|
+
weekly: {
|
|
1361
|
+
limit_usd: string;
|
|
1362
|
+
remaining_usd: string;
|
|
1363
|
+
/** Format: date-time */
|
|
1364
|
+
resets_ts: string;
|
|
1365
|
+
used_usd: string;
|
|
1366
|
+
};
|
|
1367
|
+
};
|
|
1368
|
+
/** @enum {string} */
|
|
1369
|
+
object: "funding_method";
|
|
1370
|
+
onchain?: {
|
|
1371
|
+
enabled: boolean;
|
|
1372
|
+
instructions: {
|
|
1373
|
+
address: string;
|
|
1374
|
+
/** @description Include a nonempty memo with the transfer. An empty memo means this address does not require one. */
|
|
1375
|
+
memo: string;
|
|
1376
|
+
payment_rail: string;
|
|
1377
|
+
symbol: string;
|
|
1378
|
+
}[];
|
|
1379
|
+
source_wallet_cleared: boolean;
|
|
1380
|
+
source_wallet_required: boolean;
|
|
1381
|
+
};
|
|
1382
|
+
/** @enum {string} */
|
|
1383
|
+
type: "ach" | "wire" | "onchain";
|
|
1384
|
+
wire?: {
|
|
1385
|
+
enabled: boolean;
|
|
1386
|
+
instructions: {
|
|
1387
|
+
account_number: string;
|
|
1388
|
+
account_type: string;
|
|
1389
|
+
bank_address: {
|
|
1390
|
+
city: string;
|
|
1391
|
+
country: string;
|
|
1392
|
+
line1: string;
|
|
1393
|
+
line2: string;
|
|
1394
|
+
postal_code: string;
|
|
1395
|
+
state: string;
|
|
1396
|
+
};
|
|
1397
|
+
bank_name: string;
|
|
1398
|
+
beneficiary_address: {
|
|
1399
|
+
city: string;
|
|
1400
|
+
country: string;
|
|
1401
|
+
line1: string;
|
|
1402
|
+
line2: string;
|
|
1403
|
+
postal_code: string;
|
|
1404
|
+
state: string;
|
|
1405
|
+
};
|
|
1406
|
+
beneficiary_name: string;
|
|
1407
|
+
reference: string;
|
|
1408
|
+
routing_number: string;
|
|
1409
|
+
} | null;
|
|
1410
|
+
};
|
|
1411
|
+
};
|
|
1412
|
+
FundingSnapshot: {
|
|
1413
|
+
data: components["schemas"]["FundingMethod"][];
|
|
1414
|
+
/** Format: date-time */
|
|
1415
|
+
instructions_updated_ts: string;
|
|
1416
|
+
livemode: boolean;
|
|
1417
|
+
/** @enum {string} */
|
|
1418
|
+
object: "funding_snapshot";
|
|
1419
|
+
/** Format: date-time */
|
|
1420
|
+
observed_ts: string;
|
|
1421
|
+
};
|
|
886
1422
|
List: {
|
|
887
1423
|
data: components["schemas"]["Resource"][];
|
|
888
1424
|
has_more: boolean;
|
|
889
1425
|
/** @enum {string} */
|
|
890
1426
|
object: "list";
|
|
891
1427
|
};
|
|
1428
|
+
MXBankAccountCreateDetails: {
|
|
1429
|
+
account_holder_first_name: string;
|
|
1430
|
+
account_holder_last_name: string;
|
|
1431
|
+
clabe: string;
|
|
1432
|
+
/** @description Optional RFC or CURP, validated by the existing recipient rules. */
|
|
1433
|
+
holder_identifier?: string;
|
|
1434
|
+
legal_entity_name: string;
|
|
1435
|
+
};
|
|
1436
|
+
MXBankAccountDetails: {
|
|
1437
|
+
account_holder_first_name: string;
|
|
1438
|
+
account_holder_last_name: string;
|
|
1439
|
+
clabe: string;
|
|
1440
|
+
/** @description Account holder RFC or CURP. Omitted when unavailable; masked unless full details are permitted. */
|
|
1441
|
+
holder_identifier?: string;
|
|
1442
|
+
legal_entity_name: string;
|
|
1443
|
+
};
|
|
892
1444
|
/** @description Customer metadata. Sensitive data is forbidden. */
|
|
893
1445
|
Metadata: {
|
|
894
1446
|
[key: string]: string;
|
|
@@ -987,10 +1539,10 @@ export interface components {
|
|
|
987
1539
|
approvals_required: number;
|
|
988
1540
|
/** @enum {string} */
|
|
989
1541
|
flow: "ach_withdrawal" | "wire_withdrawal" | "onchain_withdrawal" | "fund_buy" | "fund_sell";
|
|
990
|
-
/** @description
|
|
1542
|
+
/** @description When true, this tier applies at min_usd and above. When false, the amount must exceed min_usd. */
|
|
991
1543
|
min_inclusive: boolean;
|
|
992
1544
|
min_usd: string;
|
|
993
|
-
/** @description
|
|
1545
|
+
/** @description Whether an additional named approver is required. approvals_required excludes the requester and the named approver. */
|
|
994
1546
|
named_approval_required: boolean;
|
|
995
1547
|
};
|
|
996
1548
|
PolicyDelay: {
|
|
@@ -1085,16 +1637,16 @@ export interface components {
|
|
|
1085
1637
|
QuoteExpress: {
|
|
1086
1638
|
/**
|
|
1087
1639
|
* Format: int64
|
|
1088
|
-
* @description
|
|
1640
|
+
* @description Express commission rate for this quote, in basis points.
|
|
1089
1641
|
*/
|
|
1090
1642
|
fee_bps: number;
|
|
1091
|
-
/** @description
|
|
1643
|
+
/** @description Express commission for this trade, in USD. */
|
|
1092
1644
|
fee_usd: string;
|
|
1093
1645
|
/** @description The per-order ceiling on the express pathway. A policy constant, identical for every business. */
|
|
1094
1646
|
max_order_usd: string;
|
|
1095
1647
|
/** @description What an express buy delivers: estimated_quantity less the commission. A standard buy delivers the gross figure instead. */
|
|
1096
1648
|
net_estimated_quantity: string;
|
|
1097
|
-
/** @description
|
|
1649
|
+
/** @description Estimated express settlement time in seconds. This estimate does not reflect current reserve liquidity. */
|
|
1098
1650
|
settlement_estimate_seconds: number;
|
|
1099
1651
|
};
|
|
1100
1652
|
Resource: {
|
|
@@ -1128,6 +1680,24 @@ export interface components {
|
|
|
1128
1680
|
/** @enum {string} */
|
|
1129
1681
|
object: "list";
|
|
1130
1682
|
};
|
|
1683
|
+
SourceWalletDeclaration: {
|
|
1684
|
+
/** @description Recorded screening outcome, once processed. Recheck funding for current eligibility; retries do not renew clearance. */
|
|
1685
|
+
cleared: boolean | null;
|
|
1686
|
+
/** Format: date-time */
|
|
1687
|
+
created_ts: string;
|
|
1688
|
+
failure_code?: string;
|
|
1689
|
+
id: string;
|
|
1690
|
+
livemode: boolean;
|
|
1691
|
+
/** @enum {string} */
|
|
1692
|
+
object: "source_wallet_declaration";
|
|
1693
|
+
/** @enum {string} */
|
|
1694
|
+
status: "pending" | "screened" | "failed";
|
|
1695
|
+
};
|
|
1696
|
+
SourceWalletDeclarationInput: {
|
|
1697
|
+
address: string;
|
|
1698
|
+
/** @enum {string} */
|
|
1699
|
+
chain: "ethereum" | "polygon" | "arbitrum" | "base" | "solana" | "stellar";
|
|
1700
|
+
};
|
|
1131
1701
|
Statement: {
|
|
1132
1702
|
/** Format: date-time */
|
|
1133
1703
|
created_ts: string;
|
|
@@ -1243,7 +1813,7 @@ export interface components {
|
|
|
1243
1813
|
paid_to_bank: string;
|
|
1244
1814
|
};
|
|
1245
1815
|
Transaction: {
|
|
1246
|
-
/** @description
|
|
1816
|
+
/** @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. */
|
|
1247
1817
|
asset_changes: components["schemas"]["TransactionAssetChange"][];
|
|
1248
1818
|
/**
|
|
1249
1819
|
* Format: date-time
|
|
@@ -1262,12 +1832,12 @@ export interface components {
|
|
|
1262
1832
|
failed_ts?: string;
|
|
1263
1833
|
/** @description The transaction id. Stable for the life of the movement and safe to store. */
|
|
1264
1834
|
id: string;
|
|
1265
|
-
/** @description False
|
|
1835
|
+
/** @description Whether the resource represents live financial data. False for an isolated simulated ledger; independent of the reading credential. */
|
|
1266
1836
|
livemode: boolean;
|
|
1267
1837
|
/** @enum {string} */
|
|
1268
1838
|
object: "transaction";
|
|
1269
1839
|
/**
|
|
1270
|
-
* @description The movement
|
|
1840
|
+
* @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.
|
|
1271
1841
|
* @enum {string}
|
|
1272
1842
|
*/
|
|
1273
1843
|
status: "pending" | "processing" | "completed" | "failed";
|
|
@@ -1278,7 +1848,7 @@ export interface components {
|
|
|
1278
1848
|
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";
|
|
1279
1849
|
};
|
|
1280
1850
|
TransactionAssetChange: {
|
|
1281
|
-
/** @description The signed net change to the business's settled holdings of this asset, in the asset's own units.
|
|
1851
|
+
/** @description The signed net change to the business's settled holdings of this asset, in the asset's own units. Negative amounts decrease holdings; positive amounts increase them. Net of the ledger's fees and taxes, on the same basis /v1/balances reports. For a business with no pay-ins or payouts, summing an asset's amounts across every transaction — not only the completed ones — gives the movement in its settled balance. Pay-ins and payouts are not served on this API but still move /v1/balances, so a business with payments cannot reconcile its balance from transactions alone. */
|
|
1282
1852
|
amount: string;
|
|
1283
1853
|
/** @description The asset symbol, in the ledger's own casing (USDC, WTGXX, SOL:USDC). */
|
|
1284
1854
|
asset: string;
|
|
@@ -1289,6 +1859,24 @@ export interface components {
|
|
|
1289
1859
|
/** @enum {string} */
|
|
1290
1860
|
object: "list";
|
|
1291
1861
|
};
|
|
1862
|
+
USBankAccountCreateDetails: {
|
|
1863
|
+
account_number: string;
|
|
1864
|
+
/** @enum {string} */
|
|
1865
|
+
account_type: "checking" | "saving";
|
|
1866
|
+
bank_name: string;
|
|
1867
|
+
owner_address: components["schemas"]["BankAccountCreateAddress"];
|
|
1868
|
+
owner_name: string;
|
|
1869
|
+
routing_number: string;
|
|
1870
|
+
};
|
|
1871
|
+
USBankAccountDetails: {
|
|
1872
|
+
account_number: string;
|
|
1873
|
+
/** @enum {string} */
|
|
1874
|
+
account_type: "checking" | "saving";
|
|
1875
|
+
bank_name: string;
|
|
1876
|
+
owner_address: components["schemas"]["BankAccountAddress"];
|
|
1877
|
+
owner_name: string;
|
|
1878
|
+
routing_number: string;
|
|
1879
|
+
};
|
|
1292
1880
|
WebhookDelivery: {
|
|
1293
1881
|
attempt_count: number;
|
|
1294
1882
|
/** Format: date-time */
|
|
@@ -1384,13 +1972,82 @@ export interface components {
|
|
|
1384
1972
|
url?: string | null;
|
|
1385
1973
|
};
|
|
1386
1974
|
};
|
|
1387
|
-
responses:
|
|
1975
|
+
responses: {
|
|
1976
|
+
/** @description Invalid input, version, account directive, or idempotency header. Correct the request before retrying. */
|
|
1977
|
+
Error400: {
|
|
1978
|
+
headers: {
|
|
1979
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
1980
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
1981
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1982
|
+
[name: string]: unknown;
|
|
1983
|
+
};
|
|
1984
|
+
content: {
|
|
1985
|
+
"application/json": components["schemas"]["Error"];
|
|
1986
|
+
};
|
|
1987
|
+
};
|
|
1988
|
+
/** @description Missing, invalid, revoked, or wrong-environment bearer credential. */
|
|
1989
|
+
Error401: {
|
|
1990
|
+
headers: {
|
|
1991
|
+
[name: string]: unknown;
|
|
1992
|
+
};
|
|
1993
|
+
content: {
|
|
1994
|
+
"application/json": components["schemas"]["Error"];
|
|
1995
|
+
};
|
|
1996
|
+
};
|
|
1997
|
+
/** @description The credential lacks the required permission or the operation is unavailable to this business. */
|
|
1998
|
+
Error403: {
|
|
1999
|
+
headers: {
|
|
2000
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2001
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2002
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2003
|
+
[name: string]: unknown;
|
|
2004
|
+
};
|
|
2005
|
+
content: {
|
|
2006
|
+
"application/json": components["schemas"]["Error"];
|
|
2007
|
+
};
|
|
2008
|
+
};
|
|
2009
|
+
/** @description A request with this idempotency key is still running, or the operation conflicts with current state. For request_in_progress, honor Retry-After and retry with the same key and body. */
|
|
2010
|
+
Error409: {
|
|
2011
|
+
headers: {
|
|
2012
|
+
"Retry-After": components["headers"]["Retry-After"];
|
|
2013
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2014
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2015
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2016
|
+
[name: string]: unknown;
|
|
2017
|
+
};
|
|
2018
|
+
content: {
|
|
2019
|
+
"application/json": components["schemas"]["Error"];
|
|
2020
|
+
};
|
|
2021
|
+
};
|
|
2022
|
+
/** @description Rate limit exceeded. Honor Retry-After. Credential budget headers are absent on IP refusals; edge refusals may have a different body. */
|
|
2023
|
+
Error429: {
|
|
2024
|
+
headers: {
|
|
2025
|
+
"Retry-After": components["headers"]["Retry-After"];
|
|
2026
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2027
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2028
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2029
|
+
[name: string]: unknown;
|
|
2030
|
+
};
|
|
2031
|
+
content: {
|
|
2032
|
+
"application/json": components["schemas"]["Error"];
|
|
2033
|
+
};
|
|
2034
|
+
};
|
|
2035
|
+
};
|
|
1388
2036
|
parameters: {
|
|
1389
2037
|
"Idempotency-Key": string;
|
|
1390
2038
|
"Stable-Sea-Version": components["schemas"]["APIVersion"];
|
|
1391
2039
|
};
|
|
1392
2040
|
requestBodies: never;
|
|
1393
|
-
headers:
|
|
2041
|
+
headers: {
|
|
2042
|
+
/** @description Wait at least this many seconds before retrying. */
|
|
2043
|
+
"Retry-After": number;
|
|
2044
|
+
/** @description Credential requests allowed per window on this server instance; not a fleet-wide quota. */
|
|
2045
|
+
"X-RateLimit-Limit": number;
|
|
2046
|
+
/** @description Credential requests left after this request on this server instance; a pacing hint, not reserved capacity. */
|
|
2047
|
+
"X-RateLimit-Remaining": number;
|
|
2048
|
+
/** @description Credential window end as Unix seconds, rounded up. */
|
|
2049
|
+
"X-RateLimit-Reset": number;
|
|
2050
|
+
};
|
|
1394
2051
|
pathItems: never;
|
|
1395
2052
|
}
|
|
1396
2053
|
export type $defs = Record<string, never>;
|
|
@@ -1414,12 +2071,19 @@ export interface operations {
|
|
|
1414
2071
|
/** @description OK */
|
|
1415
2072
|
200: {
|
|
1416
2073
|
headers: {
|
|
2074
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2075
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2076
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1417
2077
|
[name: string]: unknown;
|
|
1418
2078
|
};
|
|
1419
2079
|
content: {
|
|
1420
2080
|
"application/json": components["schemas"]["AccountList"];
|
|
1421
2081
|
};
|
|
1422
2082
|
};
|
|
2083
|
+
400: components["responses"]["Error400"];
|
|
2084
|
+
401: components["responses"]["Error401"];
|
|
2085
|
+
403: components["responses"]["Error403"];
|
|
2086
|
+
429: components["responses"]["Error429"];
|
|
1423
2087
|
/** @description Error response. */
|
|
1424
2088
|
default: {
|
|
1425
2089
|
headers: {
|
|
@@ -1446,12 +2110,19 @@ export interface operations {
|
|
|
1446
2110
|
/** @description OK */
|
|
1447
2111
|
200: {
|
|
1448
2112
|
headers: {
|
|
2113
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2114
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2115
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1449
2116
|
[name: string]: unknown;
|
|
1450
2117
|
};
|
|
1451
2118
|
content: {
|
|
1452
2119
|
"application/json": components["schemas"]["Account"];
|
|
1453
2120
|
};
|
|
1454
2121
|
};
|
|
2122
|
+
400: components["responses"]["Error400"];
|
|
2123
|
+
401: components["responses"]["Error401"];
|
|
2124
|
+
403: components["responses"]["Error403"];
|
|
2125
|
+
429: components["responses"]["Error429"];
|
|
1455
2126
|
/** @description Error response. */
|
|
1456
2127
|
default: {
|
|
1457
2128
|
headers: {
|
|
@@ -1475,12 +2146,19 @@ export interface operations {
|
|
|
1475
2146
|
/** @description OK */
|
|
1476
2147
|
200: {
|
|
1477
2148
|
headers: {
|
|
2149
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2150
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2151
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1478
2152
|
[name: string]: unknown;
|
|
1479
2153
|
};
|
|
1480
2154
|
content: {
|
|
1481
2155
|
"application/json": components["schemas"]["APIClient"];
|
|
1482
2156
|
};
|
|
1483
2157
|
};
|
|
2158
|
+
400: components["responses"]["Error400"];
|
|
2159
|
+
401: components["responses"]["Error401"];
|
|
2160
|
+
403: components["responses"]["Error403"];
|
|
2161
|
+
429: components["responses"]["Error429"];
|
|
1484
2162
|
/** @description Error response. */
|
|
1485
2163
|
default: {
|
|
1486
2164
|
headers: {
|
|
@@ -1511,12 +2189,19 @@ export interface operations {
|
|
|
1511
2189
|
/** @description OK */
|
|
1512
2190
|
200: {
|
|
1513
2191
|
headers: {
|
|
2192
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2193
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2194
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1514
2195
|
[name: string]: unknown;
|
|
1515
2196
|
};
|
|
1516
2197
|
content: {
|
|
1517
2198
|
"application/json": components["schemas"]["BalanceList"];
|
|
1518
2199
|
};
|
|
1519
2200
|
};
|
|
2201
|
+
400: components["responses"]["Error400"];
|
|
2202
|
+
401: components["responses"]["Error401"];
|
|
2203
|
+
403: components["responses"]["Error403"];
|
|
2204
|
+
429: components["responses"]["Error429"];
|
|
1520
2205
|
/** @description Error response. */
|
|
1521
2206
|
default: {
|
|
1522
2207
|
headers: {
|
|
@@ -1543,12 +2228,19 @@ export interface operations {
|
|
|
1543
2228
|
/** @description OK */
|
|
1544
2229
|
200: {
|
|
1545
2230
|
headers: {
|
|
2231
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2232
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2233
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1546
2234
|
[name: string]: unknown;
|
|
1547
2235
|
};
|
|
1548
2236
|
content: {
|
|
1549
2237
|
"application/json": components["schemas"]["Balance"];
|
|
1550
2238
|
};
|
|
1551
2239
|
};
|
|
2240
|
+
400: components["responses"]["Error400"];
|
|
2241
|
+
401: components["responses"]["Error401"];
|
|
2242
|
+
403: components["responses"]["Error403"];
|
|
2243
|
+
429: components["responses"]["Error429"];
|
|
1552
2244
|
/** @description Error response. */
|
|
1553
2245
|
default: {
|
|
1554
2246
|
headers: {
|
|
@@ -1560,11 +2252,13 @@ export interface operations {
|
|
|
1560
2252
|
};
|
|
1561
2253
|
};
|
|
1562
2254
|
};
|
|
1563
|
-
"
|
|
2255
|
+
"bank_account_operations.get": {
|
|
1564
2256
|
parameters: {
|
|
1565
2257
|
query?: never;
|
|
1566
2258
|
header?: never;
|
|
1567
|
-
path
|
|
2259
|
+
path: {
|
|
2260
|
+
id: string;
|
|
2261
|
+
};
|
|
1568
2262
|
cookie?: never;
|
|
1569
2263
|
};
|
|
1570
2264
|
requestBody?: never;
|
|
@@ -1572,12 +2266,19 @@ export interface operations {
|
|
|
1572
2266
|
/** @description OK */
|
|
1573
2267
|
200: {
|
|
1574
2268
|
headers: {
|
|
2269
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2270
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2271
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1575
2272
|
[name: string]: unknown;
|
|
1576
2273
|
};
|
|
1577
2274
|
content: {
|
|
1578
|
-
"application/json": components["schemas"]["
|
|
2275
|
+
"application/json": components["schemas"]["BankAccountOperation"];
|
|
1579
2276
|
};
|
|
1580
2277
|
};
|
|
2278
|
+
400: components["responses"]["Error400"];
|
|
2279
|
+
401: components["responses"]["Error401"];
|
|
2280
|
+
403: components["responses"]["Error403"];
|
|
2281
|
+
429: components["responses"]["Error429"];
|
|
1581
2282
|
/** @description Error response. */
|
|
1582
2283
|
default: {
|
|
1583
2284
|
headers: {
|
|
@@ -1589,14 +2290,11 @@ export interface operations {
|
|
|
1589
2290
|
};
|
|
1590
2291
|
};
|
|
1591
2292
|
};
|
|
1592
|
-
"
|
|
2293
|
+
"bank_accounts.list": {
|
|
1593
2294
|
parameters: {
|
|
1594
2295
|
query?: {
|
|
1595
|
-
/** @description How many events to return. Defaults to 10. A value above 100 is rejected, not reduced. */
|
|
1596
2296
|
limit?: number;
|
|
1597
|
-
/** @description Return the events immediately older than this event id. Cannot be combined with ending_before. */
|
|
1598
2297
|
starting_after?: string;
|
|
1599
|
-
/** @description Return the events immediately newer than this event id. Cannot be combined with starting_after. */
|
|
1600
2298
|
ending_before?: string;
|
|
1601
2299
|
};
|
|
1602
2300
|
header?: never;
|
|
@@ -1608,12 +2306,19 @@ export interface operations {
|
|
|
1608
2306
|
/** @description OK */
|
|
1609
2307
|
200: {
|
|
1610
2308
|
headers: {
|
|
2309
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2310
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2311
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1611
2312
|
[name: string]: unknown;
|
|
1612
2313
|
};
|
|
1613
2314
|
content: {
|
|
1614
|
-
"application/json": components["schemas"]["
|
|
2315
|
+
"application/json": components["schemas"]["BankAccountList"];
|
|
1615
2316
|
};
|
|
1616
2317
|
};
|
|
2318
|
+
400: components["responses"]["Error400"];
|
|
2319
|
+
401: components["responses"]["Error401"];
|
|
2320
|
+
403: components["responses"]["Error403"];
|
|
2321
|
+
429: components["responses"]["Error429"];
|
|
1617
2322
|
/** @description Error response. */
|
|
1618
2323
|
default: {
|
|
1619
2324
|
headers: {
|
|
@@ -1625,27 +2330,38 @@ export interface operations {
|
|
|
1625
2330
|
};
|
|
1626
2331
|
};
|
|
1627
2332
|
};
|
|
1628
|
-
"
|
|
2333
|
+
"bank_accounts.create": {
|
|
1629
2334
|
parameters: {
|
|
1630
2335
|
query?: never;
|
|
1631
|
-
header
|
|
1632
|
-
|
|
1633
|
-
/** @description The event id. */
|
|
1634
|
-
id: string;
|
|
2336
|
+
header: {
|
|
2337
|
+
"Idempotency-Key": components["parameters"]["Idempotency-Key"];
|
|
1635
2338
|
};
|
|
2339
|
+
path?: never;
|
|
1636
2340
|
cookie?: never;
|
|
1637
2341
|
};
|
|
1638
|
-
requestBody?:
|
|
2342
|
+
requestBody?: {
|
|
2343
|
+
content: {
|
|
2344
|
+
"application/json": components["schemas"]["BankAccountCreateInput"];
|
|
2345
|
+
};
|
|
2346
|
+
};
|
|
1639
2347
|
responses: {
|
|
1640
2348
|
/** @description OK */
|
|
1641
2349
|
200: {
|
|
1642
2350
|
headers: {
|
|
2351
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2352
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2353
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1643
2354
|
[name: string]: unknown;
|
|
1644
2355
|
};
|
|
1645
2356
|
content: {
|
|
1646
|
-
"application/json": components["schemas"]["
|
|
2357
|
+
"application/json": components["schemas"]["BankAccountOperation"];
|
|
1647
2358
|
};
|
|
1648
2359
|
};
|
|
2360
|
+
400: components["responses"]["Error400"];
|
|
2361
|
+
401: components["responses"]["Error401"];
|
|
2362
|
+
403: components["responses"]["Error403"];
|
|
2363
|
+
409: components["responses"]["Error409"];
|
|
2364
|
+
429: components["responses"]["Error429"];
|
|
1649
2365
|
/** @description Error response. */
|
|
1650
2366
|
default: {
|
|
1651
2367
|
headers: {
|
|
@@ -1657,18 +2373,13 @@ export interface operations {
|
|
|
1657
2373
|
};
|
|
1658
2374
|
};
|
|
1659
2375
|
};
|
|
1660
|
-
"
|
|
2376
|
+
"bank_accounts.get": {
|
|
1661
2377
|
parameters: {
|
|
1662
|
-
query?:
|
|
1663
|
-
/** @description How many external wallets to return. Defaults to 10. A value above 100 is rejected, not reduced. */
|
|
1664
|
-
limit?: number;
|
|
1665
|
-
/** @description Return the external wallets immediately after this external wallet id in the list order. Cannot be combined with ending_before. */
|
|
1666
|
-
starting_after?: string;
|
|
1667
|
-
/** @description Return the external wallets immediately before this external wallet id in the list order. Cannot be combined with starting_after. */
|
|
1668
|
-
ending_before?: string;
|
|
1669
|
-
};
|
|
2378
|
+
query?: never;
|
|
1670
2379
|
header?: never;
|
|
1671
|
-
path
|
|
2380
|
+
path: {
|
|
2381
|
+
id: string;
|
|
2382
|
+
};
|
|
1672
2383
|
cookie?: never;
|
|
1673
2384
|
};
|
|
1674
2385
|
requestBody?: never;
|
|
@@ -1676,12 +2387,19 @@ export interface operations {
|
|
|
1676
2387
|
/** @description OK */
|
|
1677
2388
|
200: {
|
|
1678
2389
|
headers: {
|
|
2390
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2391
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2392
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1679
2393
|
[name: string]: unknown;
|
|
1680
2394
|
};
|
|
1681
2395
|
content: {
|
|
1682
|
-
"application/json": components["schemas"]["
|
|
2396
|
+
"application/json": components["schemas"]["BankAccount"];
|
|
1683
2397
|
};
|
|
1684
2398
|
};
|
|
2399
|
+
400: components["responses"]["Error400"];
|
|
2400
|
+
401: components["responses"]["Error401"];
|
|
2401
|
+
403: components["responses"]["Error403"];
|
|
2402
|
+
429: components["responses"]["Error429"];
|
|
1685
2403
|
/** @description Error response. */
|
|
1686
2404
|
default: {
|
|
1687
2405
|
headers: {
|
|
@@ -1693,12 +2411,13 @@ export interface operations {
|
|
|
1693
2411
|
};
|
|
1694
2412
|
};
|
|
1695
2413
|
};
|
|
1696
|
-
"
|
|
2414
|
+
"bank_accounts.remove": {
|
|
1697
2415
|
parameters: {
|
|
1698
2416
|
query?: never;
|
|
1699
|
-
header
|
|
2417
|
+
header: {
|
|
2418
|
+
"Idempotency-Key": components["parameters"]["Idempotency-Key"];
|
|
2419
|
+
};
|
|
1700
2420
|
path: {
|
|
1701
|
-
/** @description The external wallet id. */
|
|
1702
2421
|
id: string;
|
|
1703
2422
|
};
|
|
1704
2423
|
cookie?: never;
|
|
@@ -1708,12 +2427,20 @@ export interface operations {
|
|
|
1708
2427
|
/** @description OK */
|
|
1709
2428
|
200: {
|
|
1710
2429
|
headers: {
|
|
2430
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2431
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2432
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1711
2433
|
[name: string]: unknown;
|
|
1712
2434
|
};
|
|
1713
2435
|
content: {
|
|
1714
|
-
"application/json": components["schemas"]["
|
|
2436
|
+
"application/json": components["schemas"]["BankAccountOperation"];
|
|
1715
2437
|
};
|
|
1716
2438
|
};
|
|
2439
|
+
400: components["responses"]["Error400"];
|
|
2440
|
+
401: components["responses"]["Error401"];
|
|
2441
|
+
403: components["responses"]["Error403"];
|
|
2442
|
+
409: components["responses"]["Error409"];
|
|
2443
|
+
429: components["responses"]["Error429"];
|
|
1717
2444
|
/** @description Error response. */
|
|
1718
2445
|
default: {
|
|
1719
2446
|
headers: {
|
|
@@ -1725,31 +2452,38 @@ export interface operations {
|
|
|
1725
2452
|
};
|
|
1726
2453
|
};
|
|
1727
2454
|
};
|
|
1728
|
-
"
|
|
2455
|
+
"deposit_quotes.create": {
|
|
1729
2456
|
parameters: {
|
|
1730
|
-
query?:
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
/** @description Return the notifications immediately older than this notification id. Cannot be combined with ending_before. */
|
|
1734
|
-
starting_after?: string;
|
|
1735
|
-
/** @description Return the notifications immediately newer than this notification id. Cannot be combined with starting_after. */
|
|
1736
|
-
ending_before?: string;
|
|
2457
|
+
query?: never;
|
|
2458
|
+
header: {
|
|
2459
|
+
"Idempotency-Key": components["parameters"]["Idempotency-Key"];
|
|
1737
2460
|
};
|
|
1738
|
-
header?: never;
|
|
1739
2461
|
path?: never;
|
|
1740
2462
|
cookie?: never;
|
|
1741
2463
|
};
|
|
1742
|
-
requestBody?:
|
|
2464
|
+
requestBody?: {
|
|
2465
|
+
content: {
|
|
2466
|
+
"application/json": components["schemas"]["DepositQuoteInput"];
|
|
2467
|
+
};
|
|
2468
|
+
};
|
|
1743
2469
|
responses: {
|
|
1744
2470
|
/** @description OK */
|
|
1745
2471
|
200: {
|
|
1746
2472
|
headers: {
|
|
2473
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2474
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2475
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1747
2476
|
[name: string]: unknown;
|
|
1748
2477
|
};
|
|
1749
2478
|
content: {
|
|
1750
|
-
"application/json": components["schemas"]["
|
|
2479
|
+
"application/json": components["schemas"]["DepositQuote"];
|
|
1751
2480
|
};
|
|
1752
2481
|
};
|
|
2482
|
+
400: components["responses"]["Error400"];
|
|
2483
|
+
401: components["responses"]["Error401"];
|
|
2484
|
+
403: components["responses"]["Error403"];
|
|
2485
|
+
409: components["responses"]["Error409"];
|
|
2486
|
+
429: components["responses"]["Error429"];
|
|
1753
2487
|
/** @description Error response. */
|
|
1754
2488
|
default: {
|
|
1755
2489
|
headers: {
|
|
@@ -1761,12 +2495,11 @@ export interface operations {
|
|
|
1761
2495
|
};
|
|
1762
2496
|
};
|
|
1763
2497
|
};
|
|
1764
|
-
"
|
|
2498
|
+
"deposit_quotes.get": {
|
|
1765
2499
|
parameters: {
|
|
1766
2500
|
query?: never;
|
|
1767
2501
|
header?: never;
|
|
1768
2502
|
path: {
|
|
1769
|
-
/** @description The notification id. */
|
|
1770
2503
|
id: string;
|
|
1771
2504
|
};
|
|
1772
2505
|
cookie?: never;
|
|
@@ -1776,12 +2509,19 @@ export interface operations {
|
|
|
1776
2509
|
/** @description OK */
|
|
1777
2510
|
200: {
|
|
1778
2511
|
headers: {
|
|
2512
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2513
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2514
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1779
2515
|
[name: string]: unknown;
|
|
1780
2516
|
};
|
|
1781
2517
|
content: {
|
|
1782
|
-
"application/json": components["schemas"]["
|
|
2518
|
+
"application/json": components["schemas"]["DepositQuote"];
|
|
1783
2519
|
};
|
|
1784
2520
|
};
|
|
2521
|
+
400: components["responses"]["Error400"];
|
|
2522
|
+
401: components["responses"]["Error401"];
|
|
2523
|
+
403: components["responses"]["Error403"];
|
|
2524
|
+
429: components["responses"]["Error429"];
|
|
1785
2525
|
/** @description Error response. */
|
|
1786
2526
|
default: {
|
|
1787
2527
|
headers: {
|
|
@@ -1793,31 +2533,38 @@ export interface operations {
|
|
|
1793
2533
|
};
|
|
1794
2534
|
};
|
|
1795
2535
|
};
|
|
1796
|
-
"
|
|
2536
|
+
"deposits.create": {
|
|
1797
2537
|
parameters: {
|
|
1798
|
-
query?:
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
/** @description Return the orders immediately older than this order id. Cannot be combined with ending_before. */
|
|
1802
|
-
starting_after?: string;
|
|
1803
|
-
/** @description Return the orders immediately newer than this order id, still newest-first. Cannot be combined with starting_after. */
|
|
1804
|
-
ending_before?: string;
|
|
2538
|
+
query?: never;
|
|
2539
|
+
header: {
|
|
2540
|
+
"Idempotency-Key": components["parameters"]["Idempotency-Key"];
|
|
1805
2541
|
};
|
|
1806
|
-
header?: never;
|
|
1807
2542
|
path?: never;
|
|
1808
2543
|
cookie?: never;
|
|
1809
2544
|
};
|
|
1810
|
-
requestBody?:
|
|
2545
|
+
requestBody?: {
|
|
2546
|
+
content: {
|
|
2547
|
+
"application/json": components["schemas"]["DepositInput"];
|
|
2548
|
+
};
|
|
2549
|
+
};
|
|
1811
2550
|
responses: {
|
|
1812
2551
|
/** @description OK */
|
|
1813
2552
|
200: {
|
|
1814
2553
|
headers: {
|
|
2554
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2555
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2556
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1815
2557
|
[name: string]: unknown;
|
|
1816
2558
|
};
|
|
1817
2559
|
content: {
|
|
1818
|
-
"application/json": components["schemas"]["
|
|
2560
|
+
"application/json": components["schemas"]["Deposit"];
|
|
1819
2561
|
};
|
|
1820
2562
|
};
|
|
2563
|
+
400: components["responses"]["Error400"];
|
|
2564
|
+
401: components["responses"]["Error401"];
|
|
2565
|
+
403: components["responses"]["Error403"];
|
|
2566
|
+
409: components["responses"]["Error409"];
|
|
2567
|
+
429: components["responses"]["Error429"];
|
|
1821
2568
|
/** @description Error response. */
|
|
1822
2569
|
default: {
|
|
1823
2570
|
headers: {
|
|
@@ -1829,16 +2576,541 @@ export interface operations {
|
|
|
1829
2576
|
};
|
|
1830
2577
|
};
|
|
1831
2578
|
};
|
|
1832
|
-
"
|
|
2579
|
+
"deposits.get": {
|
|
1833
2580
|
parameters: {
|
|
1834
2581
|
query?: never;
|
|
1835
|
-
header
|
|
1836
|
-
|
|
2582
|
+
header?: never;
|
|
2583
|
+
path: {
|
|
2584
|
+
id: string;
|
|
1837
2585
|
};
|
|
1838
|
-
path?: never;
|
|
1839
2586
|
cookie?: never;
|
|
1840
2587
|
};
|
|
1841
|
-
requestBody?:
|
|
2588
|
+
requestBody?: never;
|
|
2589
|
+
responses: {
|
|
2590
|
+
/** @description OK */
|
|
2591
|
+
200: {
|
|
2592
|
+
headers: {
|
|
2593
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2594
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2595
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2596
|
+
[name: string]: unknown;
|
|
2597
|
+
};
|
|
2598
|
+
content: {
|
|
2599
|
+
"application/json": components["schemas"]["Deposit"];
|
|
2600
|
+
};
|
|
2601
|
+
};
|
|
2602
|
+
400: components["responses"]["Error400"];
|
|
2603
|
+
401: components["responses"]["Error401"];
|
|
2604
|
+
403: components["responses"]["Error403"];
|
|
2605
|
+
429: components["responses"]["Error429"];
|
|
2606
|
+
/** @description Error response. */
|
|
2607
|
+
default: {
|
|
2608
|
+
headers: {
|
|
2609
|
+
[name: string]: unknown;
|
|
2610
|
+
};
|
|
2611
|
+
content: {
|
|
2612
|
+
"application/json": components["schemas"]["Error"];
|
|
2613
|
+
};
|
|
2614
|
+
};
|
|
2615
|
+
};
|
|
2616
|
+
};
|
|
2617
|
+
"event_types.catalog": {
|
|
2618
|
+
parameters: {
|
|
2619
|
+
query?: never;
|
|
2620
|
+
header?: never;
|
|
2621
|
+
path?: never;
|
|
2622
|
+
cookie?: never;
|
|
2623
|
+
};
|
|
2624
|
+
requestBody?: never;
|
|
2625
|
+
responses: {
|
|
2626
|
+
/** @description OK */
|
|
2627
|
+
200: {
|
|
2628
|
+
headers: {
|
|
2629
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2630
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2631
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2632
|
+
[name: string]: unknown;
|
|
2633
|
+
};
|
|
2634
|
+
content: {
|
|
2635
|
+
"application/json": components["schemas"]["EventTypeCatalog"];
|
|
2636
|
+
};
|
|
2637
|
+
};
|
|
2638
|
+
400: components["responses"]["Error400"];
|
|
2639
|
+
401: components["responses"]["Error401"];
|
|
2640
|
+
403: components["responses"]["Error403"];
|
|
2641
|
+
429: components["responses"]["Error429"];
|
|
2642
|
+
/** @description Error response. */
|
|
2643
|
+
default: {
|
|
2644
|
+
headers: {
|
|
2645
|
+
[name: string]: unknown;
|
|
2646
|
+
};
|
|
2647
|
+
content: {
|
|
2648
|
+
"application/json": components["schemas"]["Error"];
|
|
2649
|
+
};
|
|
2650
|
+
};
|
|
2651
|
+
};
|
|
2652
|
+
};
|
|
2653
|
+
"events.list": {
|
|
2654
|
+
parameters: {
|
|
2655
|
+
query?: {
|
|
2656
|
+
/** @description How many events to return. Defaults to 10. A value above 100 is rejected, not reduced. */
|
|
2657
|
+
limit?: number;
|
|
2658
|
+
/** @description Return the events immediately older than this event id. Cannot be combined with ending_before. */
|
|
2659
|
+
starting_after?: string;
|
|
2660
|
+
/** @description Return the events immediately newer than this event id. Cannot be combined with starting_after. */
|
|
2661
|
+
ending_before?: string;
|
|
2662
|
+
};
|
|
2663
|
+
header?: never;
|
|
2664
|
+
path?: never;
|
|
2665
|
+
cookie?: never;
|
|
2666
|
+
};
|
|
2667
|
+
requestBody?: never;
|
|
2668
|
+
responses: {
|
|
2669
|
+
/** @description OK */
|
|
2670
|
+
200: {
|
|
2671
|
+
headers: {
|
|
2672
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2673
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2674
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2675
|
+
[name: string]: unknown;
|
|
2676
|
+
};
|
|
2677
|
+
content: {
|
|
2678
|
+
"application/json": components["schemas"]["EventList"];
|
|
2679
|
+
};
|
|
2680
|
+
};
|
|
2681
|
+
400: components["responses"]["Error400"];
|
|
2682
|
+
401: components["responses"]["Error401"];
|
|
2683
|
+
403: components["responses"]["Error403"];
|
|
2684
|
+
429: components["responses"]["Error429"];
|
|
2685
|
+
/** @description Error response. */
|
|
2686
|
+
default: {
|
|
2687
|
+
headers: {
|
|
2688
|
+
[name: string]: unknown;
|
|
2689
|
+
};
|
|
2690
|
+
content: {
|
|
2691
|
+
"application/json": components["schemas"]["Error"];
|
|
2692
|
+
};
|
|
2693
|
+
};
|
|
2694
|
+
};
|
|
2695
|
+
};
|
|
2696
|
+
"events.get": {
|
|
2697
|
+
parameters: {
|
|
2698
|
+
query?: never;
|
|
2699
|
+
header?: never;
|
|
2700
|
+
path: {
|
|
2701
|
+
/** @description The event id. */
|
|
2702
|
+
id: string;
|
|
2703
|
+
};
|
|
2704
|
+
cookie?: never;
|
|
2705
|
+
};
|
|
2706
|
+
requestBody?: never;
|
|
2707
|
+
responses: {
|
|
2708
|
+
/** @description OK */
|
|
2709
|
+
200: {
|
|
2710
|
+
headers: {
|
|
2711
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2712
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2713
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2714
|
+
[name: string]: unknown;
|
|
2715
|
+
};
|
|
2716
|
+
content: {
|
|
2717
|
+
"application/json": components["schemas"]["Event"];
|
|
2718
|
+
};
|
|
2719
|
+
};
|
|
2720
|
+
400: components["responses"]["Error400"];
|
|
2721
|
+
401: components["responses"]["Error401"];
|
|
2722
|
+
403: components["responses"]["Error403"];
|
|
2723
|
+
429: components["responses"]["Error429"];
|
|
2724
|
+
/** @description Error response. */
|
|
2725
|
+
default: {
|
|
2726
|
+
headers: {
|
|
2727
|
+
[name: string]: unknown;
|
|
2728
|
+
};
|
|
2729
|
+
content: {
|
|
2730
|
+
"application/json": components["schemas"]["Error"];
|
|
2731
|
+
};
|
|
2732
|
+
};
|
|
2733
|
+
};
|
|
2734
|
+
};
|
|
2735
|
+
"external_wallet_operations.get": {
|
|
2736
|
+
parameters: {
|
|
2737
|
+
query?: never;
|
|
2738
|
+
header?: never;
|
|
2739
|
+
path: {
|
|
2740
|
+
id: string;
|
|
2741
|
+
};
|
|
2742
|
+
cookie?: never;
|
|
2743
|
+
};
|
|
2744
|
+
requestBody?: never;
|
|
2745
|
+
responses: {
|
|
2746
|
+
/** @description OK */
|
|
2747
|
+
200: {
|
|
2748
|
+
headers: {
|
|
2749
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2750
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2751
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2752
|
+
[name: string]: unknown;
|
|
2753
|
+
};
|
|
2754
|
+
content: {
|
|
2755
|
+
"application/json": components["schemas"]["ExternalWalletOperation"];
|
|
2756
|
+
};
|
|
2757
|
+
};
|
|
2758
|
+
400: components["responses"]["Error400"];
|
|
2759
|
+
401: components["responses"]["Error401"];
|
|
2760
|
+
403: components["responses"]["Error403"];
|
|
2761
|
+
429: components["responses"]["Error429"];
|
|
2762
|
+
/** @description Error response. */
|
|
2763
|
+
default: {
|
|
2764
|
+
headers: {
|
|
2765
|
+
[name: string]: unknown;
|
|
2766
|
+
};
|
|
2767
|
+
content: {
|
|
2768
|
+
"application/json": components["schemas"]["Error"];
|
|
2769
|
+
};
|
|
2770
|
+
};
|
|
2771
|
+
};
|
|
2772
|
+
};
|
|
2773
|
+
"external_wallets.list": {
|
|
2774
|
+
parameters: {
|
|
2775
|
+
query?: {
|
|
2776
|
+
/** @description How many external wallets to return. Defaults to 10. A value above 100 is rejected, not reduced. */
|
|
2777
|
+
limit?: number;
|
|
2778
|
+
/** @description Return the external wallets immediately after this external wallet id in the list order. Cannot be combined with ending_before. */
|
|
2779
|
+
starting_after?: string;
|
|
2780
|
+
/** @description Return the external wallets immediately before this external wallet id in the list order. Cannot be combined with starting_after. */
|
|
2781
|
+
ending_before?: string;
|
|
2782
|
+
};
|
|
2783
|
+
header?: never;
|
|
2784
|
+
path?: never;
|
|
2785
|
+
cookie?: never;
|
|
2786
|
+
};
|
|
2787
|
+
requestBody?: never;
|
|
2788
|
+
responses: {
|
|
2789
|
+
/** @description OK */
|
|
2790
|
+
200: {
|
|
2791
|
+
headers: {
|
|
2792
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2793
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2794
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2795
|
+
[name: string]: unknown;
|
|
2796
|
+
};
|
|
2797
|
+
content: {
|
|
2798
|
+
"application/json": components["schemas"]["ExternalWalletList"];
|
|
2799
|
+
};
|
|
2800
|
+
};
|
|
2801
|
+
400: components["responses"]["Error400"];
|
|
2802
|
+
401: components["responses"]["Error401"];
|
|
2803
|
+
403: components["responses"]["Error403"];
|
|
2804
|
+
429: components["responses"]["Error429"];
|
|
2805
|
+
/** @description Error response. */
|
|
2806
|
+
default: {
|
|
2807
|
+
headers: {
|
|
2808
|
+
[name: string]: unknown;
|
|
2809
|
+
};
|
|
2810
|
+
content: {
|
|
2811
|
+
"application/json": components["schemas"]["Error"];
|
|
2812
|
+
};
|
|
2813
|
+
};
|
|
2814
|
+
};
|
|
2815
|
+
};
|
|
2816
|
+
"external_wallets.create": {
|
|
2817
|
+
parameters: {
|
|
2818
|
+
query?: never;
|
|
2819
|
+
header: {
|
|
2820
|
+
"Idempotency-Key": components["parameters"]["Idempotency-Key"];
|
|
2821
|
+
};
|
|
2822
|
+
path?: never;
|
|
2823
|
+
cookie?: never;
|
|
2824
|
+
};
|
|
2825
|
+
requestBody?: {
|
|
2826
|
+
content: {
|
|
2827
|
+
"application/json": components["schemas"]["ExternalWalletCreateInput"];
|
|
2828
|
+
};
|
|
2829
|
+
};
|
|
2830
|
+
responses: {
|
|
2831
|
+
/** @description OK */
|
|
2832
|
+
200: {
|
|
2833
|
+
headers: {
|
|
2834
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2835
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2836
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2837
|
+
[name: string]: unknown;
|
|
2838
|
+
};
|
|
2839
|
+
content: {
|
|
2840
|
+
"application/json": components["schemas"]["ExternalWalletOperation"];
|
|
2841
|
+
};
|
|
2842
|
+
};
|
|
2843
|
+
400: components["responses"]["Error400"];
|
|
2844
|
+
401: components["responses"]["Error401"];
|
|
2845
|
+
403: components["responses"]["Error403"];
|
|
2846
|
+
409: components["responses"]["Error409"];
|
|
2847
|
+
429: components["responses"]["Error429"];
|
|
2848
|
+
/** @description Error response. */
|
|
2849
|
+
default: {
|
|
2850
|
+
headers: {
|
|
2851
|
+
[name: string]: unknown;
|
|
2852
|
+
};
|
|
2853
|
+
content: {
|
|
2854
|
+
"application/json": components["schemas"]["Error"];
|
|
2855
|
+
};
|
|
2856
|
+
};
|
|
2857
|
+
};
|
|
2858
|
+
};
|
|
2859
|
+
"external_wallets.get": {
|
|
2860
|
+
parameters: {
|
|
2861
|
+
query?: never;
|
|
2862
|
+
header?: never;
|
|
2863
|
+
path: {
|
|
2864
|
+
/** @description The external wallet id. */
|
|
2865
|
+
id: string;
|
|
2866
|
+
};
|
|
2867
|
+
cookie?: never;
|
|
2868
|
+
};
|
|
2869
|
+
requestBody?: never;
|
|
2870
|
+
responses: {
|
|
2871
|
+
/** @description OK */
|
|
2872
|
+
200: {
|
|
2873
|
+
headers: {
|
|
2874
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2875
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2876
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2877
|
+
[name: string]: unknown;
|
|
2878
|
+
};
|
|
2879
|
+
content: {
|
|
2880
|
+
"application/json": components["schemas"]["ExternalWallet"];
|
|
2881
|
+
};
|
|
2882
|
+
};
|
|
2883
|
+
400: components["responses"]["Error400"];
|
|
2884
|
+
401: components["responses"]["Error401"];
|
|
2885
|
+
403: components["responses"]["Error403"];
|
|
2886
|
+
429: components["responses"]["Error429"];
|
|
2887
|
+
/** @description Error response. */
|
|
2888
|
+
default: {
|
|
2889
|
+
headers: {
|
|
2890
|
+
[name: string]: unknown;
|
|
2891
|
+
};
|
|
2892
|
+
content: {
|
|
2893
|
+
"application/json": components["schemas"]["Error"];
|
|
2894
|
+
};
|
|
2895
|
+
};
|
|
2896
|
+
};
|
|
2897
|
+
};
|
|
2898
|
+
"external_wallets.rename": {
|
|
2899
|
+
parameters: {
|
|
2900
|
+
query?: never;
|
|
2901
|
+
header: {
|
|
2902
|
+
"Idempotency-Key": components["parameters"]["Idempotency-Key"];
|
|
2903
|
+
};
|
|
2904
|
+
path: {
|
|
2905
|
+
id: string;
|
|
2906
|
+
};
|
|
2907
|
+
cookie?: never;
|
|
2908
|
+
};
|
|
2909
|
+
requestBody?: {
|
|
2910
|
+
content: {
|
|
2911
|
+
"application/json": components["schemas"]["ExternalWalletRenameInput"];
|
|
2912
|
+
};
|
|
2913
|
+
};
|
|
2914
|
+
responses: {
|
|
2915
|
+
/** @description OK */
|
|
2916
|
+
200: {
|
|
2917
|
+
headers: {
|
|
2918
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2919
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2920
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2921
|
+
[name: string]: unknown;
|
|
2922
|
+
};
|
|
2923
|
+
content: {
|
|
2924
|
+
"application/json": components["schemas"]["ExternalWalletOperation"];
|
|
2925
|
+
};
|
|
2926
|
+
};
|
|
2927
|
+
400: components["responses"]["Error400"];
|
|
2928
|
+
401: components["responses"]["Error401"];
|
|
2929
|
+
403: components["responses"]["Error403"];
|
|
2930
|
+
409: components["responses"]["Error409"];
|
|
2931
|
+
429: components["responses"]["Error429"];
|
|
2932
|
+
/** @description Error response. */
|
|
2933
|
+
default: {
|
|
2934
|
+
headers: {
|
|
2935
|
+
[name: string]: unknown;
|
|
2936
|
+
};
|
|
2937
|
+
content: {
|
|
2938
|
+
"application/json": components["schemas"]["Error"];
|
|
2939
|
+
};
|
|
2940
|
+
};
|
|
2941
|
+
};
|
|
2942
|
+
};
|
|
2943
|
+
"funding.snapshot": {
|
|
2944
|
+
parameters: {
|
|
2945
|
+
query?: never;
|
|
2946
|
+
header?: never;
|
|
2947
|
+
path?: never;
|
|
2948
|
+
cookie?: never;
|
|
2949
|
+
};
|
|
2950
|
+
requestBody?: never;
|
|
2951
|
+
responses: {
|
|
2952
|
+
/** @description OK */
|
|
2953
|
+
200: {
|
|
2954
|
+
headers: {
|
|
2955
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2956
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
2957
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2958
|
+
[name: string]: unknown;
|
|
2959
|
+
};
|
|
2960
|
+
content: {
|
|
2961
|
+
"application/json": components["schemas"]["FundingSnapshot"];
|
|
2962
|
+
};
|
|
2963
|
+
};
|
|
2964
|
+
400: components["responses"]["Error400"];
|
|
2965
|
+
401: components["responses"]["Error401"];
|
|
2966
|
+
403: components["responses"]["Error403"];
|
|
2967
|
+
429: components["responses"]["Error429"];
|
|
2968
|
+
/** @description Error response. */
|
|
2969
|
+
default: {
|
|
2970
|
+
headers: {
|
|
2971
|
+
[name: string]: unknown;
|
|
2972
|
+
};
|
|
2973
|
+
content: {
|
|
2974
|
+
"application/json": components["schemas"]["Error"];
|
|
2975
|
+
};
|
|
2976
|
+
};
|
|
2977
|
+
};
|
|
2978
|
+
};
|
|
2979
|
+
"notifications.list": {
|
|
2980
|
+
parameters: {
|
|
2981
|
+
query?: {
|
|
2982
|
+
/** @description How many notifications to return. Defaults to 10. */
|
|
2983
|
+
limit?: number;
|
|
2984
|
+
/** @description Return the notifications immediately older than this notification id. Cannot be combined with ending_before. */
|
|
2985
|
+
starting_after?: string;
|
|
2986
|
+
/** @description Return the notifications immediately newer than this notification id. Cannot be combined with starting_after. */
|
|
2987
|
+
ending_before?: string;
|
|
2988
|
+
};
|
|
2989
|
+
header?: never;
|
|
2990
|
+
path?: never;
|
|
2991
|
+
cookie?: never;
|
|
2992
|
+
};
|
|
2993
|
+
requestBody?: never;
|
|
2994
|
+
responses: {
|
|
2995
|
+
/** @description OK */
|
|
2996
|
+
200: {
|
|
2997
|
+
headers: {
|
|
2998
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
2999
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3000
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
3001
|
+
[name: string]: unknown;
|
|
3002
|
+
};
|
|
3003
|
+
content: {
|
|
3004
|
+
"application/json": components["schemas"]["NotificationList"];
|
|
3005
|
+
};
|
|
3006
|
+
};
|
|
3007
|
+
400: components["responses"]["Error400"];
|
|
3008
|
+
401: components["responses"]["Error401"];
|
|
3009
|
+
403: components["responses"]["Error403"];
|
|
3010
|
+
429: components["responses"]["Error429"];
|
|
3011
|
+
/** @description Error response. */
|
|
3012
|
+
default: {
|
|
3013
|
+
headers: {
|
|
3014
|
+
[name: string]: unknown;
|
|
3015
|
+
};
|
|
3016
|
+
content: {
|
|
3017
|
+
"application/json": components["schemas"]["Error"];
|
|
3018
|
+
};
|
|
3019
|
+
};
|
|
3020
|
+
};
|
|
3021
|
+
};
|
|
3022
|
+
"notifications.retrieve": {
|
|
3023
|
+
parameters: {
|
|
3024
|
+
query?: never;
|
|
3025
|
+
header?: never;
|
|
3026
|
+
path: {
|
|
3027
|
+
/** @description The notification id. */
|
|
3028
|
+
id: string;
|
|
3029
|
+
};
|
|
3030
|
+
cookie?: never;
|
|
3031
|
+
};
|
|
3032
|
+
requestBody?: never;
|
|
3033
|
+
responses: {
|
|
3034
|
+
/** @description OK */
|
|
3035
|
+
200: {
|
|
3036
|
+
headers: {
|
|
3037
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3038
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3039
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
3040
|
+
[name: string]: unknown;
|
|
3041
|
+
};
|
|
3042
|
+
content: {
|
|
3043
|
+
"application/json": components["schemas"]["Notification"];
|
|
3044
|
+
};
|
|
3045
|
+
};
|
|
3046
|
+
400: components["responses"]["Error400"];
|
|
3047
|
+
401: components["responses"]["Error401"];
|
|
3048
|
+
403: components["responses"]["Error403"];
|
|
3049
|
+
429: components["responses"]["Error429"];
|
|
3050
|
+
/** @description Error response. */
|
|
3051
|
+
default: {
|
|
3052
|
+
headers: {
|
|
3053
|
+
[name: string]: unknown;
|
|
3054
|
+
};
|
|
3055
|
+
content: {
|
|
3056
|
+
"application/json": components["schemas"]["Error"];
|
|
3057
|
+
};
|
|
3058
|
+
};
|
|
3059
|
+
};
|
|
3060
|
+
};
|
|
3061
|
+
"orders.list": {
|
|
3062
|
+
parameters: {
|
|
3063
|
+
query?: {
|
|
3064
|
+
/** @description How many orders to return. Defaults to 10. A value above 100 is rejected, not reduced. */
|
|
3065
|
+
limit?: number;
|
|
3066
|
+
/** @description Return the orders immediately older than this order id. Cannot be combined with ending_before. */
|
|
3067
|
+
starting_after?: string;
|
|
3068
|
+
/** @description Return the orders immediately newer than this order id, still newest-first. Cannot be combined with starting_after. */
|
|
3069
|
+
ending_before?: string;
|
|
3070
|
+
};
|
|
3071
|
+
header?: never;
|
|
3072
|
+
path?: never;
|
|
3073
|
+
cookie?: never;
|
|
3074
|
+
};
|
|
3075
|
+
requestBody?: never;
|
|
3076
|
+
responses: {
|
|
3077
|
+
/** @description OK */
|
|
3078
|
+
200: {
|
|
3079
|
+
headers: {
|
|
3080
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3081
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3082
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
3083
|
+
[name: string]: unknown;
|
|
3084
|
+
};
|
|
3085
|
+
content: {
|
|
3086
|
+
"application/json": components["schemas"]["OrderList"];
|
|
3087
|
+
};
|
|
3088
|
+
};
|
|
3089
|
+
400: components["responses"]["Error400"];
|
|
3090
|
+
401: components["responses"]["Error401"];
|
|
3091
|
+
403: components["responses"]["Error403"];
|
|
3092
|
+
429: components["responses"]["Error429"];
|
|
3093
|
+
/** @description Error response. */
|
|
3094
|
+
default: {
|
|
3095
|
+
headers: {
|
|
3096
|
+
[name: string]: unknown;
|
|
3097
|
+
};
|
|
3098
|
+
content: {
|
|
3099
|
+
"application/json": components["schemas"]["Error"];
|
|
3100
|
+
};
|
|
3101
|
+
};
|
|
3102
|
+
};
|
|
3103
|
+
};
|
|
3104
|
+
"orders.create": {
|
|
3105
|
+
parameters: {
|
|
3106
|
+
query?: never;
|
|
3107
|
+
header: {
|
|
3108
|
+
"Idempotency-Key": components["parameters"]["Idempotency-Key"];
|
|
3109
|
+
};
|
|
3110
|
+
path?: never;
|
|
3111
|
+
cookie?: never;
|
|
3112
|
+
};
|
|
3113
|
+
requestBody?: {
|
|
1842
3114
|
content: {
|
|
1843
3115
|
"application/json": components["schemas"]["OrderCreateInput"];
|
|
1844
3116
|
};
|
|
@@ -1847,12 +3119,20 @@ export interface operations {
|
|
|
1847
3119
|
/** @description OK */
|
|
1848
3120
|
200: {
|
|
1849
3121
|
headers: {
|
|
3122
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3123
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3124
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1850
3125
|
[name: string]: unknown;
|
|
1851
3126
|
};
|
|
1852
3127
|
content: {
|
|
1853
3128
|
"application/json": components["schemas"]["Order"];
|
|
1854
3129
|
};
|
|
1855
3130
|
};
|
|
3131
|
+
400: components["responses"]["Error400"];
|
|
3132
|
+
401: components["responses"]["Error401"];
|
|
3133
|
+
403: components["responses"]["Error403"];
|
|
3134
|
+
409: components["responses"]["Error409"];
|
|
3135
|
+
429: components["responses"]["Error429"];
|
|
1856
3136
|
/** @description Error response. */
|
|
1857
3137
|
default: {
|
|
1858
3138
|
headers: {
|
|
@@ -1879,12 +3159,19 @@ export interface operations {
|
|
|
1879
3159
|
/** @description OK */
|
|
1880
3160
|
200: {
|
|
1881
3161
|
headers: {
|
|
3162
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3163
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3164
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1882
3165
|
[name: string]: unknown;
|
|
1883
3166
|
};
|
|
1884
3167
|
content: {
|
|
1885
3168
|
"application/json": components["schemas"]["Order"];
|
|
1886
3169
|
};
|
|
1887
3170
|
};
|
|
3171
|
+
400: components["responses"]["Error400"];
|
|
3172
|
+
401: components["responses"]["Error401"];
|
|
3173
|
+
403: components["responses"]["Error403"];
|
|
3174
|
+
429: components["responses"]["Error429"];
|
|
1888
3175
|
/** @description Error response. */
|
|
1889
3176
|
default: {
|
|
1890
3177
|
headers: {
|
|
@@ -1908,12 +3195,19 @@ export interface operations {
|
|
|
1908
3195
|
/** @description OK */
|
|
1909
3196
|
200: {
|
|
1910
3197
|
headers: {
|
|
3198
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3199
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3200
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1911
3201
|
[name: string]: unknown;
|
|
1912
3202
|
};
|
|
1913
3203
|
content: {
|
|
1914
3204
|
"application/json": components["schemas"]["PolicySnapshot"];
|
|
1915
3205
|
};
|
|
1916
3206
|
};
|
|
3207
|
+
400: components["responses"]["Error400"];
|
|
3208
|
+
401: components["responses"]["Error401"];
|
|
3209
|
+
403: components["responses"]["Error403"];
|
|
3210
|
+
429: components["responses"]["Error429"];
|
|
1917
3211
|
/** @description Error response. */
|
|
1918
3212
|
default: {
|
|
1919
3213
|
headers: {
|
|
@@ -1944,12 +3238,19 @@ export interface operations {
|
|
|
1944
3238
|
/** @description OK */
|
|
1945
3239
|
200: {
|
|
1946
3240
|
headers: {
|
|
3241
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3242
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3243
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1947
3244
|
[name: string]: unknown;
|
|
1948
3245
|
};
|
|
1949
3246
|
content: {
|
|
1950
3247
|
"application/json": components["schemas"]["Quote"];
|
|
1951
3248
|
};
|
|
1952
3249
|
};
|
|
3250
|
+
400: components["responses"]["Error400"];
|
|
3251
|
+
401: components["responses"]["Error401"];
|
|
3252
|
+
403: components["responses"]["Error403"];
|
|
3253
|
+
429: components["responses"]["Error429"];
|
|
1953
3254
|
/** @description Error response. */
|
|
1954
3255
|
default: {
|
|
1955
3256
|
headers: {
|
|
@@ -1973,12 +3274,100 @@ export interface operations {
|
|
|
1973
3274
|
/** @description OK */
|
|
1974
3275
|
200: {
|
|
1975
3276
|
headers: {
|
|
3277
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3278
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3279
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
1976
3280
|
[name: string]: unknown;
|
|
1977
3281
|
};
|
|
1978
3282
|
content: {
|
|
1979
3283
|
"application/json": components["schemas"]["SecurityCatalog"];
|
|
1980
3284
|
};
|
|
1981
3285
|
};
|
|
3286
|
+
400: components["responses"]["Error400"];
|
|
3287
|
+
401: components["responses"]["Error401"];
|
|
3288
|
+
403: components["responses"]["Error403"];
|
|
3289
|
+
429: components["responses"]["Error429"];
|
|
3290
|
+
/** @description Error response. */
|
|
3291
|
+
default: {
|
|
3292
|
+
headers: {
|
|
3293
|
+
[name: string]: unknown;
|
|
3294
|
+
};
|
|
3295
|
+
content: {
|
|
3296
|
+
"application/json": components["schemas"]["Error"];
|
|
3297
|
+
};
|
|
3298
|
+
};
|
|
3299
|
+
};
|
|
3300
|
+
};
|
|
3301
|
+
"source_wallet_declarations.create": {
|
|
3302
|
+
parameters: {
|
|
3303
|
+
query?: never;
|
|
3304
|
+
header: {
|
|
3305
|
+
"Idempotency-Key": components["parameters"]["Idempotency-Key"];
|
|
3306
|
+
};
|
|
3307
|
+
path?: never;
|
|
3308
|
+
cookie?: never;
|
|
3309
|
+
};
|
|
3310
|
+
requestBody?: {
|
|
3311
|
+
content: {
|
|
3312
|
+
"application/json": components["schemas"]["SourceWalletDeclarationInput"];
|
|
3313
|
+
};
|
|
3314
|
+
};
|
|
3315
|
+
responses: {
|
|
3316
|
+
/** @description OK */
|
|
3317
|
+
200: {
|
|
3318
|
+
headers: {
|
|
3319
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3320
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3321
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
3322
|
+
[name: string]: unknown;
|
|
3323
|
+
};
|
|
3324
|
+
content: {
|
|
3325
|
+
"application/json": components["schemas"]["SourceWalletDeclaration"];
|
|
3326
|
+
};
|
|
3327
|
+
};
|
|
3328
|
+
400: components["responses"]["Error400"];
|
|
3329
|
+
401: components["responses"]["Error401"];
|
|
3330
|
+
403: components["responses"]["Error403"];
|
|
3331
|
+
409: components["responses"]["Error409"];
|
|
3332
|
+
429: components["responses"]["Error429"];
|
|
3333
|
+
/** @description Error response. */
|
|
3334
|
+
default: {
|
|
3335
|
+
headers: {
|
|
3336
|
+
[name: string]: unknown;
|
|
3337
|
+
};
|
|
3338
|
+
content: {
|
|
3339
|
+
"application/json": components["schemas"]["Error"];
|
|
3340
|
+
};
|
|
3341
|
+
};
|
|
3342
|
+
};
|
|
3343
|
+
};
|
|
3344
|
+
"source_wallet_declarations.get": {
|
|
3345
|
+
parameters: {
|
|
3346
|
+
query?: never;
|
|
3347
|
+
header?: never;
|
|
3348
|
+
path: {
|
|
3349
|
+
id: string;
|
|
3350
|
+
};
|
|
3351
|
+
cookie?: never;
|
|
3352
|
+
};
|
|
3353
|
+
requestBody?: never;
|
|
3354
|
+
responses: {
|
|
3355
|
+
/** @description OK */
|
|
3356
|
+
200: {
|
|
3357
|
+
headers: {
|
|
3358
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3359
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3360
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
3361
|
+
[name: string]: unknown;
|
|
3362
|
+
};
|
|
3363
|
+
content: {
|
|
3364
|
+
"application/json": components["schemas"]["SourceWalletDeclaration"];
|
|
3365
|
+
};
|
|
3366
|
+
};
|
|
3367
|
+
400: components["responses"]["Error400"];
|
|
3368
|
+
401: components["responses"]["Error401"];
|
|
3369
|
+
403: components["responses"]["Error403"];
|
|
3370
|
+
429: components["responses"]["Error429"];
|
|
1982
3371
|
/** @description Error response. */
|
|
1983
3372
|
default: {
|
|
1984
3373
|
headers: {
|
|
@@ -2009,12 +3398,19 @@ export interface operations {
|
|
|
2009
3398
|
/** @description OK */
|
|
2010
3399
|
200: {
|
|
2011
3400
|
headers: {
|
|
3401
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3402
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3403
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2012
3404
|
[name: string]: unknown;
|
|
2013
3405
|
};
|
|
2014
3406
|
content: {
|
|
2015
3407
|
"application/json": components["schemas"]["StatementList"];
|
|
2016
3408
|
};
|
|
2017
3409
|
};
|
|
3410
|
+
400: components["responses"]["Error400"];
|
|
3411
|
+
401: components["responses"]["Error401"];
|
|
3412
|
+
403: components["responses"]["Error403"];
|
|
3413
|
+
429: components["responses"]["Error429"];
|
|
2018
3414
|
/** @description Error response. */
|
|
2019
3415
|
default: {
|
|
2020
3416
|
headers: {
|
|
@@ -2041,12 +3437,19 @@ export interface operations {
|
|
|
2041
3437
|
/** @description OK */
|
|
2042
3438
|
200: {
|
|
2043
3439
|
headers: {
|
|
3440
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3441
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3442
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2044
3443
|
[name: string]: unknown;
|
|
2045
3444
|
};
|
|
2046
3445
|
content: {
|
|
2047
3446
|
"application/json": components["schemas"]["Statement"];
|
|
2048
3447
|
};
|
|
2049
3448
|
};
|
|
3449
|
+
400: components["responses"]["Error400"];
|
|
3450
|
+
401: components["responses"]["Error401"];
|
|
3451
|
+
403: components["responses"]["Error403"];
|
|
3452
|
+
429: components["responses"]["Error429"];
|
|
2050
3453
|
/** @description Error response. */
|
|
2051
3454
|
default: {
|
|
2052
3455
|
headers: {
|
|
@@ -2073,12 +3476,19 @@ export interface operations {
|
|
|
2073
3476
|
/** @description OK */
|
|
2074
3477
|
200: {
|
|
2075
3478
|
headers: {
|
|
3479
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3480
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3481
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2076
3482
|
[name: string]: unknown;
|
|
2077
3483
|
};
|
|
2078
3484
|
content: {
|
|
2079
3485
|
"application/json": components["schemas"]["StatementContent"];
|
|
2080
3486
|
};
|
|
2081
3487
|
};
|
|
3488
|
+
400: components["responses"]["Error400"];
|
|
3489
|
+
401: components["responses"]["Error401"];
|
|
3490
|
+
403: components["responses"]["Error403"];
|
|
3491
|
+
429: components["responses"]["Error429"];
|
|
2082
3492
|
/** @description Error response. */
|
|
2083
3493
|
default: {
|
|
2084
3494
|
headers: {
|
|
@@ -2109,12 +3519,19 @@ export interface operations {
|
|
|
2109
3519
|
/** @description OK */
|
|
2110
3520
|
200: {
|
|
2111
3521
|
headers: {
|
|
3522
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3523
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3524
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2112
3525
|
[name: string]: unknown;
|
|
2113
3526
|
};
|
|
2114
3527
|
content: {
|
|
2115
3528
|
"application/json": components["schemas"]["TransactionList"];
|
|
2116
3529
|
};
|
|
2117
3530
|
};
|
|
3531
|
+
400: components["responses"]["Error400"];
|
|
3532
|
+
401: components["responses"]["Error401"];
|
|
3533
|
+
403: components["responses"]["Error403"];
|
|
3534
|
+
429: components["responses"]["Error429"];
|
|
2118
3535
|
/** @description Error response. */
|
|
2119
3536
|
default: {
|
|
2120
3537
|
headers: {
|
|
@@ -2141,12 +3558,19 @@ export interface operations {
|
|
|
2141
3558
|
/** @description OK */
|
|
2142
3559
|
200: {
|
|
2143
3560
|
headers: {
|
|
3561
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3562
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3563
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2144
3564
|
[name: string]: unknown;
|
|
2145
3565
|
};
|
|
2146
3566
|
content: {
|
|
2147
3567
|
"application/json": components["schemas"]["Transaction"];
|
|
2148
3568
|
};
|
|
2149
3569
|
};
|
|
3570
|
+
400: components["responses"]["Error400"];
|
|
3571
|
+
401: components["responses"]["Error401"];
|
|
3572
|
+
403: components["responses"]["Error403"];
|
|
3573
|
+
429: components["responses"]["Error429"];
|
|
2150
3574
|
/** @description Error response. */
|
|
2151
3575
|
default: {
|
|
2152
3576
|
headers: {
|
|
@@ -2177,12 +3601,19 @@ export interface operations {
|
|
|
2177
3601
|
/** @description OK */
|
|
2178
3602
|
200: {
|
|
2179
3603
|
headers: {
|
|
3604
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3605
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3606
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2180
3607
|
[name: string]: unknown;
|
|
2181
3608
|
};
|
|
2182
3609
|
content: {
|
|
2183
3610
|
"application/json": components["schemas"]["WebhookEndpointList"];
|
|
2184
3611
|
};
|
|
2185
3612
|
};
|
|
3613
|
+
400: components["responses"]["Error400"];
|
|
3614
|
+
401: components["responses"]["Error401"];
|
|
3615
|
+
403: components["responses"]["Error403"];
|
|
3616
|
+
429: components["responses"]["Error429"];
|
|
2186
3617
|
/** @description Error response. */
|
|
2187
3618
|
default: {
|
|
2188
3619
|
headers: {
|
|
@@ -2212,12 +3643,20 @@ export interface operations {
|
|
|
2212
3643
|
/** @description OK */
|
|
2213
3644
|
200: {
|
|
2214
3645
|
headers: {
|
|
3646
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3647
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3648
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2215
3649
|
[name: string]: unknown;
|
|
2216
3650
|
};
|
|
2217
3651
|
content: {
|
|
2218
3652
|
"application/json": components["schemas"]["WebhookEndpointCreateResponse"];
|
|
2219
3653
|
};
|
|
2220
3654
|
};
|
|
3655
|
+
400: components["responses"]["Error400"];
|
|
3656
|
+
401: components["responses"]["Error401"];
|
|
3657
|
+
403: components["responses"]["Error403"];
|
|
3658
|
+
409: components["responses"]["Error409"];
|
|
3659
|
+
429: components["responses"]["Error429"];
|
|
2221
3660
|
/** @description Error response. */
|
|
2222
3661
|
default: {
|
|
2223
3662
|
headers: {
|
|
@@ -2244,12 +3683,19 @@ export interface operations {
|
|
|
2244
3683
|
/** @description OK */
|
|
2245
3684
|
200: {
|
|
2246
3685
|
headers: {
|
|
3686
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3687
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3688
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2247
3689
|
[name: string]: unknown;
|
|
2248
3690
|
};
|
|
2249
3691
|
content: {
|
|
2250
3692
|
"application/json": components["schemas"]["WebhookEndpoint"];
|
|
2251
3693
|
};
|
|
2252
3694
|
};
|
|
3695
|
+
400: components["responses"]["Error400"];
|
|
3696
|
+
401: components["responses"]["Error401"];
|
|
3697
|
+
403: components["responses"]["Error403"];
|
|
3698
|
+
429: components["responses"]["Error429"];
|
|
2253
3699
|
/** @description Error response. */
|
|
2254
3700
|
default: {
|
|
2255
3701
|
headers: {
|
|
@@ -2282,12 +3728,20 @@ export interface operations {
|
|
|
2282
3728
|
/** @description OK */
|
|
2283
3729
|
200: {
|
|
2284
3730
|
headers: {
|
|
3731
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3732
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3733
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2285
3734
|
[name: string]: unknown;
|
|
2286
3735
|
};
|
|
2287
3736
|
content: {
|
|
2288
3737
|
"application/json": components["schemas"]["WebhookEndpoint"];
|
|
2289
3738
|
};
|
|
2290
3739
|
};
|
|
3740
|
+
400: components["responses"]["Error400"];
|
|
3741
|
+
401: components["responses"]["Error401"];
|
|
3742
|
+
403: components["responses"]["Error403"];
|
|
3743
|
+
409: components["responses"]["Error409"];
|
|
3744
|
+
429: components["responses"]["Error429"];
|
|
2291
3745
|
/** @description Error response. */
|
|
2292
3746
|
default: {
|
|
2293
3747
|
headers: {
|
|
@@ -2321,12 +3775,19 @@ export interface operations {
|
|
|
2321
3775
|
/** @description OK */
|
|
2322
3776
|
200: {
|
|
2323
3777
|
headers: {
|
|
3778
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3779
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3780
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2324
3781
|
[name: string]: unknown;
|
|
2325
3782
|
};
|
|
2326
3783
|
content: {
|
|
2327
3784
|
"application/json": components["schemas"]["WebhookDeliveryList"];
|
|
2328
3785
|
};
|
|
2329
3786
|
};
|
|
3787
|
+
400: components["responses"]["Error400"];
|
|
3788
|
+
401: components["responses"]["Error401"];
|
|
3789
|
+
403: components["responses"]["Error403"];
|
|
3790
|
+
429: components["responses"]["Error429"];
|
|
2330
3791
|
/** @description Error response. */
|
|
2331
3792
|
default: {
|
|
2332
3793
|
headers: {
|
|
@@ -2355,12 +3816,19 @@ export interface operations {
|
|
|
2355
3816
|
/** @description OK */
|
|
2356
3817
|
200: {
|
|
2357
3818
|
headers: {
|
|
3819
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3820
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3821
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2358
3822
|
[name: string]: unknown;
|
|
2359
3823
|
};
|
|
2360
3824
|
content: {
|
|
2361
3825
|
"application/json": components["schemas"]["WebhookDelivery"];
|
|
2362
3826
|
};
|
|
2363
3827
|
};
|
|
3828
|
+
400: components["responses"]["Error400"];
|
|
3829
|
+
401: components["responses"]["Error401"];
|
|
3830
|
+
403: components["responses"]["Error403"];
|
|
3831
|
+
429: components["responses"]["Error429"];
|
|
2364
3832
|
/** @description Error response. */
|
|
2365
3833
|
default: {
|
|
2366
3834
|
headers: {
|
|
@@ -2391,12 +3859,20 @@ export interface operations {
|
|
|
2391
3859
|
/** @description OK */
|
|
2392
3860
|
200: {
|
|
2393
3861
|
headers: {
|
|
3862
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3863
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3864
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2394
3865
|
[name: string]: unknown;
|
|
2395
3866
|
};
|
|
2396
3867
|
content: {
|
|
2397
3868
|
"application/json": components["schemas"]["WebhookDelivery"];
|
|
2398
3869
|
};
|
|
2399
3870
|
};
|
|
3871
|
+
400: components["responses"]["Error400"];
|
|
3872
|
+
401: components["responses"]["Error401"];
|
|
3873
|
+
403: components["responses"]["Error403"];
|
|
3874
|
+
409: components["responses"]["Error409"];
|
|
3875
|
+
429: components["responses"]["Error429"];
|
|
2400
3876
|
/** @description Error response. */
|
|
2401
3877
|
default: {
|
|
2402
3878
|
headers: {
|
|
@@ -2425,12 +3901,20 @@ export interface operations {
|
|
|
2425
3901
|
/** @description OK */
|
|
2426
3902
|
200: {
|
|
2427
3903
|
headers: {
|
|
3904
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3905
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3906
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2428
3907
|
[name: string]: unknown;
|
|
2429
3908
|
};
|
|
2430
3909
|
content: {
|
|
2431
3910
|
"application/json": components["schemas"]["WebhookEndpoint"];
|
|
2432
3911
|
};
|
|
2433
3912
|
};
|
|
3913
|
+
400: components["responses"]["Error400"];
|
|
3914
|
+
401: components["responses"]["Error401"];
|
|
3915
|
+
403: components["responses"]["Error403"];
|
|
3916
|
+
409: components["responses"]["Error409"];
|
|
3917
|
+
429: components["responses"]["Error429"];
|
|
2434
3918
|
/** @description Error response. */
|
|
2435
3919
|
default: {
|
|
2436
3920
|
headers: {
|
|
@@ -2459,12 +3943,20 @@ export interface operations {
|
|
|
2459
3943
|
/** @description OK */
|
|
2460
3944
|
200: {
|
|
2461
3945
|
headers: {
|
|
3946
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
3947
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
3948
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
2462
3949
|
[name: string]: unknown;
|
|
2463
3950
|
};
|
|
2464
3951
|
content: {
|
|
2465
3952
|
"application/json": components["schemas"]["WebhookEndpointCreateResponse"];
|
|
2466
3953
|
};
|
|
2467
3954
|
};
|
|
3955
|
+
400: components["responses"]["Error400"];
|
|
3956
|
+
401: components["responses"]["Error401"];
|
|
3957
|
+
403: components["responses"]["Error403"];
|
|
3958
|
+
409: components["responses"]["Error409"];
|
|
3959
|
+
429: components["responses"]["Error429"];
|
|
2468
3960
|
/** @description Error response. */
|
|
2469
3961
|
default: {
|
|
2470
3962
|
headers: {
|