@spritz-finance/api-client 0.26.0 → 0.28.0

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 CHANGED
@@ -361,15 +361,22 @@ Spritz agreements are the user's consent to Spritz's own Terms of Service, Priva
361
361
  Your backend creates a presentation, and the user's own client submits the acceptance:
362
362
 
363
363
  ```typescript
364
- // Backend
365
- const presentation = await client.agreements.present()
364
+ // Backend. Pass placement: 'kyc' when the screen sits inside the step that starts identity verification.
365
+ const presentation = await client.agreements.present({ placement: 'standalone' })
366
366
  if ('nothingToPresent' in presentation) return
367
367
 
368
368
  // Send these to the user's client:
369
- const { presentationId, copySha256, submissionToken, statementKey, copy, items } = presentation
369
+ const { presentationId, screenSha256, submissionToken, screen, items } = presentation
370
370
  ```
371
371
 
372
- On the client, render `copy[statementKey]` verbatim directly above a button labelled `copy.buttonLabel`, with each `copy.links` entry as a visible link. Do not translate or rephrase it. Link URLs are relative to the Spritz API origin (`https://platform.spritz.finance`, or `https://sandbox.spritz.finance` in sandbox). When the user taps the button, the client sends the acceptance itself:
372
+ `screen` is the one consent screen to show, already chosen for the user's state (`first_time`, `updated`, `privacy_only` or `esign_only`). Render it exactly as given; do not translate, rephrase or reorder it:
373
+
374
+ - `screen.title` as the heading, when not `null`.
375
+ - `screen.statement` as one paragraph, when not `null`: the segments in order, each segment with a `link` as a link to `link.url` (absolute).
376
+ - `screen.checkbox`, when not `null`: an **unchecked** checkbox labelled by `checkbox.label` (segments, as above). Enable the button only once it is checked.
377
+ - A button labelled `screen.buttonLabel`.
378
+
379
+ When the user selects the button, the client sends the acceptance itself:
373
380
 
374
381
  ```typescript
375
382
  // User's client, not your backend
@@ -382,7 +389,8 @@ const response = await fetch(`${SPRITZ_API_ORIGIN}/v1/agreements/acceptances`, {
382
389
  body: JSON.stringify({
383
390
  presentationId,
384
391
  accept: items.map((item) => item.type), // every presented type
385
- copySha256,
392
+ screenSha256, // echoed unchanged
393
+ ...(screen.checkbox ? { esignCheckboxChecked: true } : {}),
386
394
  }),
387
395
  })
388
396
  if (!response.ok) {
@@ -392,21 +400,24 @@ if (!response.ok) {
392
400
  const receipt = await response.json() // same shape as getReceipt()
393
401
  ```
394
402
 
395
- `copy.consentPattern` is `'clickwrap'` by default, as above. If it is `'esign_checkbox'`, also show an unchecked checkbox labelled `copy.esignCheckboxLabel` and send `esignCheckboxChecked` with the user's choice. When it is unchecked, leave `esign_consent` out of `accept`; E-Sign then stays outstanding and needs a new presentation later.
403
+ After a `200`, refetch `user.getMe()` for the new state rather than reading `receipt.agreements`. On a network error, resend the identical body: a repeated acceptance returns the original receipt.
396
404
 
397
405
  The `submissionToken` lasts 15 minutes and works only for its presentation. Spritz refuses an acceptance sent from your backend or from the network that created the presentation (`403 client_submission_required`), which is why this SDK does not send it. Repeating the same acceptance returns the original receipt. If the client loses the response, recover it from your backend with `client.agreements.getReceipt(presentationId)`.
398
406
 
399
- | HTTP | `code` | What to do |
400
- | ---- | ------------------------------------- | ---------------------------------------------------- |
401
- | 400 | `invalid_agreement_selection` | Accept every presented type. |
402
- | 403 | `client_submission_required` | Submit from the user's client, not your backend. |
403
- | 409 | `presentation_consumed` | Recover the receipt with `getReceipt`. |
404
- | 409 | `presentation_expired` | Create a new presentation. |
405
- | 409 | `agreement_version_outdated` | New documents are active: present again. |
406
- | 409 | `agreement_state_changed` | Refresh `getMe()` and present again. |
407
- | 409 | `copy_mismatch` | Render the returned copy and present again. |
408
- | 429 | `agreement_presentation_rate_limited` | Back off; at most ten presentations per user/minute. |
409
- | 503 | `agreements_unavailable` | Retry later. |
407
+ | HTTP | `code` | What to do |
408
+ | ---- | ------------------------------------- | ------------------------------------------------------------------- |
409
+ | 400 | `invalid_agreement_selection` | Build `accept` from the presentation's `items`. |
410
+ | 400 | `esign_consent_required` | Keep the screen; send `esignCheckboxChecked: true` once checked. |
411
+ | 400 | `unexpected_esign_checkbox` | Send `esignCheckboxChecked` only when `screen.checkbox` is present. |
412
+ | 403 | `client_submission_required` | Submit from the user's client, not your backend. |
413
+ | 403 | `presentation_token_mismatch` | Use this presentation's `submissionToken`. |
414
+ | 409 | `presentation_consumed` | Recover the receipt with `getReceipt`. |
415
+ | 409 | `presentation_expired` | Create a new presentation. |
416
+ | 409 | `agreement_version_outdated` | New documents are active: present again. |
417
+ | 409 | `agreement_state_changed` | Refresh `getMe()` and present again. |
418
+ | 409 | `copy_mismatch` | Echo `screenSha256` unchanged; present again. |
419
+ | 429 | `agreement_presentation_rate_limited` | Back off; at most ten presentations per user/minute. |
420
+ | 503 | `agreements_unavailable` | Retry later. |
410
421
 
411
422
  Every acceptance `409` includes the current `agreements` state.
412
423
 
@@ -1350,7 +1361,7 @@ ACH onramp lets users convert USD from their bank account into USDC delivered to
1350
1361
  3. **Server:** complete linking with `client.bankAccount.completeLinking(...)`
1351
1362
  4. **Server:** find an active funding source and fetch limits with `client.fundingSource.getDepositLimits(id)`
1352
1363
  5. **Server:** prepare a quote with `client.deposit.prepare(...)`
1353
- 6. **Client:** show the quote and ACH authorization `message` to the user. If your UI lays out the amounts from `summary` itself, show `authorizationStatement` word for word instead. That's only allowed when `messageVersion` is `fomo_v2`; for any other version, show `message` in full
1364
+ 6. **Client:** show the quote and ACH authorization `message` to the user. If your UI lays out the amounts from `summary` itself, show `authorizationStatement` word for word instead. That's only allowed when `messageVersion` is `fomo_v2` or `fomo_v4`; for any other version, show `message` in full
1354
1365
  7. **Server:** create the deposit with `client.deposit.create(input, { idempotencyKey })`; Spritz runs risk checks before initiating the ACH pull. Persist one unique key per deposit intent and reuse it verbatim on retries so a timed-out request replays the original response instead of authorizing a second debit
1355
1366
  8. **Server:** track the deposit with `client.deposit.get(depositId)`, or reconcile a backlog by paging `client.deposit.list({ limit, cursor })`
1356
1367
  9. **Server (optional):** while `deposit.cancellable` is true, let the user call it off with `client.deposit.cancel(depositId)` (see [Cancelling a Deposit](docs/ach-onramp-guide.md#cancelling-a-deposit))
@@ -1387,6 +1398,8 @@ To move submission onto the customer's device, pass `clientNetwork: { ipAddresse
1387
1398
 
1388
1399
  If risk checks block the create step, the API returns 409 before any ACH debit is pulled. Prepare a new quote before retrying; blocked create attempts consume the original `preparationId`.
1389
1400
 
1401
+ When a `priority: 'high'` preparation can get no instant portion at create, the deposit goes ahead at standard timing by default. Send `instantFallback: 'confirm'` to ask the user first: `create` then throws a `ConflictError` with `problem.code === 'instant_unavailable'` and leaves the preparation usable. Once the user accepts standard timing, call `create` again with the same `preparationId`, `instantFallback: 'standard'` and a new idempotency key. See [Confirming a fallback from instant](docs/ach-onramp-guide.md#confirming-a-fallback-from-instant).
1402
+
1390
1403
  For a complete walkthrough with code examples, request/response schemas, and deposit lifecycle documentation, see the **[ACH Onramp Integration Guide](docs/ach-onramp-guide.md)**.
1391
1404
 
1392
1405
  A standalone sandbox demo is available at `scripts/sandbox/ach-onramp.html`. Run `yarn build && node scripts/sandbox/evidence-server.mjs`, then open `http://localhost:3001/ach-onramp.html` to test the SDK-backed flow and save redacted QC evidence.
@@ -4566,7 +4566,7 @@ interface operations {
4566
4566
  /**
4567
4567
  * Format: date-time
4568
4568
  * @description Creation timestamp
4569
- * @example 2026-11-12T14:22:22.182Z
4569
+ * @example 2026-11-16T12:30:13.044Z
4570
4570
  */
4571
4571
  createdAt?: string;
4572
4572
  }[];
@@ -4804,7 +4804,7 @@ interface operations {
4804
4804
  "application/json": {
4805
4805
  /**
4806
4806
  * @description Destination account ID
4807
- * @example 6af5cb9e79eb018a8628fb10
4807
+ * @example 6afaf7552f86d55e4d709d24
4808
4808
  */
4809
4809
  accountId: string;
4810
4810
  /**
@@ -4832,7 +4832,7 @@ interface operations {
4832
4832
  "application/x-www-form-urlencoded": {
4833
4833
  /**
4834
4834
  * @description Destination account ID
4835
- * @example 6af5cb9e79eb018a8628fb10
4835
+ * @example 6afaf7552f86d55e4d709d24
4836
4836
  */
4837
4837
  accountId: string;
4838
4838
  /**
@@ -4860,7 +4860,7 @@ interface operations {
4860
4860
  "multipart/form-data": {
4861
4861
  /**
4862
4862
  * @description Destination account ID
4863
- * @example 6af5cb9e79eb018a8628fb10
4863
+ * @example 6afaf7552f86d55e4d709d24
4864
4864
  */
4865
4865
  accountId: string;
4866
4866
  /**
@@ -4907,7 +4907,7 @@ interface operations {
4907
4907
  /**
4908
4908
  * Format: date-time
4909
4909
  * @description When the quote was created
4910
- * @example 2026-11-12T14:22:22.164Z
4910
+ * @example 2026-11-16T12:30:13.024Z
4911
4911
  */
4912
4912
  createdAt: string;
4913
4913
  /** @description Exact USD value collected by Spritz and the token route used to fund it. The exact token quantity is returned by the transaction endpoint. */
@@ -4946,7 +4946,7 @@ interface operations {
4946
4946
  rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
4947
4947
  /**
4948
4948
  * @description Destination account ID
4949
- * @example 6af5cb9e79eb018a8628fb11
4949
+ * @example 6afaf7552f86d55e4d709d25
4950
4950
  */
4951
4951
  accountId: string;
4952
4952
  /** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
@@ -5276,7 +5276,7 @@ interface operations {
5276
5276
  /**
5277
5277
  * Format: date-time
5278
5278
  * @description When the quote was created
5279
- * @example 2026-11-12T14:22:22.164Z
5279
+ * @example 2026-11-16T12:30:13.024Z
5280
5280
  */
5281
5281
  createdAt: string;
5282
5282
  /** @description Exact USD value collected by Spritz and the token route used to fund it. The exact token quantity is returned by the transaction endpoint. */
@@ -5315,7 +5315,7 @@ interface operations {
5315
5315
  rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
5316
5316
  /**
5317
5317
  * @description Destination account ID
5318
- * @example 6af5cb9e79eb018a8628fb11
5318
+ * @example 6afaf7552f86d55e4d709d25
5319
5319
  */
5320
5320
  accountId: string;
5321
5321
  /** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
@@ -6270,7 +6270,7 @@ interface operations {
6270
6270
  /**
6271
6271
  * Format: date-time
6272
6272
  * @description When the quote was created
6273
- * @example 2026-11-12T14:22:22.164Z
6273
+ * @example 2026-11-16T12:30:13.024Z
6274
6274
  */
6275
6275
  createdAt: string;
6276
6276
  /** @description Exact USD value collected by Spritz and the token route used to fund it. The exact token quantity is returned by the transaction endpoint. */
@@ -6309,7 +6309,7 @@ interface operations {
6309
6309
  rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
6310
6310
  /**
6311
6311
  * @description Destination account ID
6312
- * @example 6af5cb9e79eb018a8628fb11
6312
+ * @example 6afaf7552f86d55e4d709d25
6313
6313
  */
6314
6314
  accountId: string;
6315
6315
  /** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
@@ -6685,7 +6685,7 @@ interface operations {
6685
6685
  currency: string;
6686
6686
  /**
6687
6687
  * @description Destination account ID
6688
- * @example 6af5cb9e79eb018a8628fb12
6688
+ * @example 6afaf7552f86d55e4d709d26
6689
6689
  */
6690
6690
  accountId: string;
6691
6691
  /**
@@ -7049,7 +7049,7 @@ interface operations {
7049
7049
  currency: string;
7050
7050
  /**
7051
7051
  * @description Destination account ID
7052
- * @example 6af5cb9e79eb018a8628fb12
7052
+ * @example 6afaf7552f86d55e4d709d26
7053
7053
  */
7054
7054
  accountId: string;
7055
7055
  /**
@@ -7363,7 +7363,7 @@ interface operations {
7363
7363
  method: "account";
7364
7364
  /**
7365
7365
  * @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
7366
- * @example 6af5cb9e79eb018a8628fb13
7366
+ * @example 6afaf7552f86d55e4d709d27
7367
7367
  */
7368
7368
  accountId?: string;
7369
7369
  };
@@ -7381,7 +7381,7 @@ interface operations {
7381
7381
  method: "account";
7382
7382
  /**
7383
7383
  * @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
7384
- * @example 6af5cb9e79eb018a8628fb13
7384
+ * @example 6afaf7552f86d55e4d709d27
7385
7385
  */
7386
7386
  accountId?: string;
7387
7387
  };
@@ -7399,7 +7399,7 @@ interface operations {
7399
7399
  method: "account";
7400
7400
  /**
7401
7401
  * @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
7402
- * @example 6af5cb9e79eb018a8628fb13
7402
+ * @example 6afaf7552f86d55e4d709d27
7403
7403
  */
7404
7404
  accountId?: string;
7405
7405
  };
@@ -7465,7 +7465,7 @@ interface operations {
7465
7465
  currency: string;
7466
7466
  /**
7467
7467
  * @description Destination account ID
7468
- * @example 6af5cb9e79eb018a8628fb12
7468
+ * @example 6afaf7552f86d55e4d709d26
7469
7469
  */
7470
7470
  accountId: string;
7471
7471
  /**
@@ -13485,6 +13485,11 @@ interface operations {
13485
13485
  payoutTxHash: string | null;
13486
13486
  /** @description Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse. */
13487
13487
  cancellable: boolean;
13488
+ /**
13489
+ * Format: date-time
13490
+ * @description Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.
13491
+ */
13492
+ cancellableUntil: string | null;
13488
13493
  /**
13489
13494
  * Format: date-time
13490
13495
  * @description When the user's cancellation was confirmed
@@ -13957,6 +13962,11 @@ interface operations {
13957
13962
  payoutTxHash: string | null;
13958
13963
  /** @description Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse. */
13959
13964
  cancellable: boolean;
13965
+ /**
13966
+ * Format: date-time
13967
+ * @description Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.
13968
+ */
13969
+ cancellableUntil: string | null;
13960
13970
  /**
13961
13971
  * Format: date-time
13962
13972
  * @description When the user's cancellation was confirmed
@@ -14353,6 +14363,11 @@ interface operations {
14353
14363
  payoutTxHash: string | null;
14354
14364
  /** @description Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse. */
14355
14365
  cancellable: boolean;
14366
+ /**
14367
+ * Format: date-time
14368
+ * @description Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.
14369
+ */
14370
+ cancellableUntil: string | null;
14356
14371
  /**
14357
14372
  * Format: date-time
14358
14373
  * @description When the user's cancellation was confirmed
@@ -14447,6 +14462,11 @@ interface operations {
14447
14462
  payoutTxHash: string | null;
14448
14463
  /** @description Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse. */
14449
14464
  cancellable: boolean;
14465
+ /**
14466
+ * Format: date-time
14467
+ * @description Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.
14468
+ */
14469
+ cancellableUntil: string | null;
14450
14470
  /**
14451
14471
  * Format: date-time
14452
14472
  * @description When the user's cancellation was confirmed
@@ -14992,10 +15012,10 @@ interface operations {
14992
15012
  * @example v1
14993
15013
  * @enum {string}
14994
15014
  */
14995
- messageVersion: "v1" | "fomo_v1" | "fomo_v2";
15015
+ messageVersion: "v1" | "fomo_v1" | "fomo_v2" | "v2" | "fomo_v3" | "fomo_v4";
14996
15016
  /** @description Display-ready ACH authorization message */
14997
15017
  message: string;
14998
- /** @description The authorization paragraph alone, a verbatim part of `message`. When `messageVersion` is `fomo_v2` the paragraph is self-contained: clients that lay out amounts and fees in their own UI must still display it word for word on the confirmation screen. For every other version, display `message` in full. */
15018
+ /** @description The authorization paragraph alone, a verbatim part of `message`. When `messageVersion` is `fomo_v2` or `fomo_v4` the paragraph is self-contained: clients that lay out amounts and fees in their own UI must still display it word for word on the confirmation screen. For every other version, display `message` in full. */
14999
15019
  authorizationStatement: string;
15000
15020
  /**
15001
15021
  * @description Short-lived, preparation-bound bearer capability returned for integrator preparations. Send it only to the authorizing client, which uses it to submit this preparation directly to Spritz.
@@ -15583,6 +15603,12 @@ interface operations {
15583
15603
  * @example 1.1.1.1
15584
15604
  */
15585
15605
  clientIp?: string;
15606
+ /**
15607
+ * @description What to do when the preparation quoted an instant portion and none of it can be granted at create. `standard` (also the behaviour when omitted) proceeds with settlement-only timing. `confirm` creates nothing and returns 409 `instant_unavailable`; after the user agrees to standard timing, submit the same preparationId again with `standard` and a new Idempotency-Key. A partly reduced instant portion always proceeds.
15608
+ * @default standard
15609
+ * @enum {string}
15610
+ */
15611
+ instantFallback?: "standard" | "confirm";
15586
15612
  };
15587
15613
  "application/x-www-form-urlencoded": {
15588
15614
  /**
@@ -15595,6 +15621,12 @@ interface operations {
15595
15621
  * @example 1.1.1.1
15596
15622
  */
15597
15623
  clientIp?: string;
15624
+ /**
15625
+ * @description What to do when the preparation quoted an instant portion and none of it can be granted at create. `standard` (also the behaviour when omitted) proceeds with settlement-only timing. `confirm` creates nothing and returns 409 `instant_unavailable`; after the user agrees to standard timing, submit the same preparationId again with `standard` and a new Idempotency-Key. A partly reduced instant portion always proceeds.
15626
+ * @default standard
15627
+ * @enum {string}
15628
+ */
15629
+ instantFallback?: "standard" | "confirm";
15598
15630
  };
15599
15631
  "multipart/form-data": {
15600
15632
  /**
@@ -15607,6 +15639,12 @@ interface operations {
15607
15639
  * @example 1.1.1.1
15608
15640
  */
15609
15641
  clientIp?: string;
15642
+ /**
15643
+ * @description What to do when the preparation quoted an instant portion and none of it can be granted at create. `standard` (also the behaviour when omitted) proceeds with settlement-only timing. `confirm` creates nothing and returns 409 `instant_unavailable`; after the user agrees to standard timing, submit the same preparationId again with `standard` and a new Idempotency-Key. A partly reduced instant portion always proceeds.
15644
+ * @default standard
15645
+ * @enum {string}
15646
+ */
15647
+ instantFallback?: "standard" | "confirm";
15610
15648
  };
15611
15649
  };
15612
15650
  };
@@ -15697,6 +15735,11 @@ interface operations {
15697
15735
  payoutTxHash: string | null;
15698
15736
  /** @description Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse. */
15699
15737
  cancellable: boolean;
15738
+ /**
15739
+ * Format: date-time
15740
+ * @description Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.
15741
+ */
15742
+ cancellableUntil: string | null;
15700
15743
  /**
15701
15744
  * Format: date-time
15702
15745
  * @description When the user's cancellation was confirmed
@@ -22826,7 +22869,7 @@ interface operations {
22826
22869
  data: {
22827
22870
  /**
22828
22871
  * @description Unique identifier for the debit card
22829
- * @example 6af5cb9e79eb018a8628fb17
22872
+ * @example 6afaf7552f86d55e4d709d2b
22830
22873
  */
22831
22874
  id: string;
22832
22875
  /** @enum {string} */
@@ -23347,7 +23390,7 @@ interface operations {
23347
23390
  "application/json": {
23348
23391
  /**
23349
23392
  * @description Unique identifier for the debit card
23350
- * @example 6af5cb9e79eb018a8628fb17
23393
+ * @example 6afaf7552f86d55e4d709d2b
23351
23394
  */
23352
23395
  id: string;
23353
23396
  /** @enum {string} */
@@ -23637,7 +23680,7 @@ interface operations {
23637
23680
  "application/json": {
23638
23681
  /**
23639
23682
  * @description Unique identifier for the debit card
23640
- * @example 6af5cb9e79eb018a8628fb17
23683
+ * @example 6afaf7552f86d55e4d709d2b
23641
23684
  */
23642
23685
  id: string;
23643
23686
  /** @enum {string} */
@@ -24304,7 +24347,7 @@ interface operations {
24304
24347
  "application/json": {
24305
24348
  /**
24306
24349
  * @description Unique identifier for the debit card
24307
- * @example 6af5cb9e79eb018a8628fb17
24350
+ * @example 6afaf7552f86d55e4d709d2b
24308
24351
  */
24309
24352
  id: string;
24310
24353
  /** @enum {string} */
@@ -24639,7 +24682,7 @@ interface operations {
24639
24682
  accessToken: string;
24640
24683
  /**
24641
24684
  * @description The internal ID of the authorized user
24642
- * @example 6af5cb9e79eb018a8628fb1b
24685
+ * @example 6afaf7552f86d55e4d709d2f
24643
24686
  */
24644
24687
  userId: string;
24645
24688
  /**
@@ -24655,7 +24698,7 @@ interface operations {
24655
24698
  /**
24656
24699
  * Format: date-time
24657
24700
  * @description ISO 8601 timestamp when token expires
24658
- * @example 2026-11-12T15:22:22.542Z
24701
+ * @example 2026-11-16T13:30:13.407Z
24659
24702
  */
24660
24703
  expiresAt: string;
24661
24704
  };
@@ -24927,7 +24970,7 @@ interface operations {
24927
24970
  /**
24928
24971
  * Format: date-time
24929
24972
  * @description ISO 8601 timestamp of when the integrator was created
24930
- * @example 2026-11-12T14:22:22.541Z
24973
+ * @example 2026-11-16T12:30:13.406Z
24931
24974
  */
24932
24975
  createdAt: string;
24933
24976
  };
@@ -25213,7 +25256,7 @@ interface operations {
25213
25256
  "application/json": {
25214
25257
  /**
25215
25258
  * @description ID of the account this request resolved to: the account it created or, where account reuse is enabled, the existing account this email resolves to for you (your own, or one you are currently authorized for through an existing authorization). With reuse enabled, a repeat for the same email returns the same ID.
25216
- * @example 6af5cb9e79eb018a8628fb1d
25259
+ * @example 6afaf7552f86d55e4d709d31
25217
25260
  */
25218
25261
  userId: string;
25219
25262
  /**
@@ -25705,7 +25748,7 @@ interface operations {
25705
25748
  depositId: string;
25706
25749
  /**
25707
25750
  * @description Spritz user ID associated with the returned deposit
25708
- * @example 6af5cb9e79eb018a8628fb1a
25751
+ * @example 6afaf7552f86d55e4d709d2e
25709
25752
  */
25710
25753
  userId: string;
25711
25754
  /**
@@ -25990,7 +26033,7 @@ interface operations {
25990
26033
  depositId: string;
25991
26034
  /**
25992
26035
  * @description Spritz user ID associated with the returned deposit
25993
- * @example 6af5cb9e79eb018a8628fb1a
26036
+ * @example 6afaf7552f86d55e4d709d2e
25994
26037
  */
25995
26038
  userId: string;
25996
26039
  /**
@@ -26256,7 +26299,7 @@ interface operations {
26256
26299
  "application/json": {
26257
26300
  /**
26258
26301
  * @description Unique identifier for the webhook
26259
- * @example 6af5cb9e79eb018a8628fb1c
26302
+ * @example 6afaf7552f86d55e4d709d30
26260
26303
  */
26261
26304
  id: string;
26262
26305
  /** @description List of event types this webhook is subscribed to */
@@ -26560,7 +26603,7 @@ interface operations {
26560
26603
  "application/json": {
26561
26604
  /**
26562
26605
  * @description Unique identifier for the webhook
26563
- * @example 6af5cb9e79eb018a8628fb1c
26606
+ * @example 6afaf7552f86d55e4d709d30
26564
26607
  */
26565
26608
  id: string;
26566
26609
  /** @description List of event types this webhook is subscribed to */
@@ -30417,7 +30460,7 @@ interface operations {
30417
30460
  "application/json": {
30418
30461
  /**
30419
30462
  * @description Unique identifier for the webhook
30420
- * @example 6af5cb9e79eb018a8628fb1c
30463
+ * @example 6afaf7552f86d55e4d709d30
30421
30464
  */
30422
30465
  id: string;
30423
30466
  /** @description List of event types this webhook is subscribed to */
@@ -31057,7 +31100,7 @@ interface operations {
31057
31100
  /**
31058
31101
  * Format: date-time
31059
31102
  * @description ISO 8601 timestamp when the old secret will expire. Only present if a grace period was specified.
31060
- * @example 2026-11-12T14:27:22.542Z
31103
+ * @example 2026-11-16T12:35:13.407Z
31061
31104
  */
31062
31105
  oldSecretExpiresAt?: string;
31063
31106
  };
@@ -31301,7 +31344,7 @@ interface operations {
31301
31344
  "application/json": {
31302
31345
  /**
31303
31346
  * @description Unique identifier for the user
31304
- * @example 6af5cb9e79eb018a8628fb18
31347
+ * @example 6afaf7552f86d55e4d709d2c
31305
31348
  */
31306
31349
  id: string;
31307
31350
  /**
@@ -31318,7 +31361,7 @@ interface operations {
31318
31361
  /**
31319
31362
  * Format: date-time
31320
31363
  * @description ISO 8601 timestamp of when the user was created
31321
- * @example 2026-11-12T14:22:22.466Z
31364
+ * @example 2026-11-16T12:30:13.330Z
31322
31365
  */
31323
31366
  signedUpAt: string;
31324
31367
  /**
@@ -31797,7 +31840,7 @@ interface operations {
31797
31840
  "application/json": {
31798
31841
  /**
31799
31842
  * @description Unique identifier for the user
31800
- * @example 6af5cb9e79eb018a8628fb18
31843
+ * @example 6afaf7552f86d55e4d709d2c
31801
31844
  */
31802
31845
  id: string;
31803
31846
  /**
@@ -31814,7 +31857,7 @@ interface operations {
31814
31857
  /**
31815
31858
  * Format: date-time
31816
31859
  * @description ISO 8601 timestamp of when the user was created
31817
- * @example 2026-11-12T14:22:22.466Z
31860
+ * @example 2026-11-16T12:30:13.330Z
31818
31861
  */
31819
31862
  signedUpAt: string;
31820
31863
  /**
@@ -32657,7 +32700,7 @@ interface operations {
32657
32700
  "application/json": {
32658
32701
  /**
32659
32702
  * @description Unique identifier for the user
32660
- * @example 6af5cb9e79eb018a8628fb18
32703
+ * @example 6afaf7552f86d55e4d709d2c
32661
32704
  */
32662
32705
  id: string;
32663
32706
  /**
@@ -32674,7 +32717,7 @@ interface operations {
32674
32717
  /**
32675
32718
  * Format: date-time
32676
32719
  * @description ISO 8601 timestamp of when the user was created
32677
- * @example 2026-11-12T14:22:22.466Z
32720
+ * @example 2026-11-16T12:30:13.330Z
32678
32721
  */
32679
32722
  signedUpAt: string;
32680
32723
  /**
@@ -34677,13 +34720,16 @@ interface operations {
34677
34720
  requestBody: {
34678
34721
  content: {
34679
34722
  "application/json": {
34680
- types?: ("terms_of_service" | "privacy_policy" | "esign_consent")[];
34723
+ /** @enum {string} */
34724
+ placement?: "standalone" | "kyc";
34681
34725
  };
34682
34726
  "application/x-www-form-urlencoded": {
34683
- types?: ("terms_of_service" | "privacy_policy" | "esign_consent")[];
34727
+ /** @enum {string} */
34728
+ placement?: "standalone" | "kyc";
34684
34729
  };
34685
34730
  "multipart/form-data": {
34686
- types?: ("terms_of_service" | "privacy_policy" | "esign_consent")[];
34731
+ /** @enum {string} */
34732
+ placement?: "standalone" | "kyc";
34687
34733
  };
34688
34734
  };
34689
34735
  };
@@ -34699,31 +34745,47 @@ interface operations {
34699
34745
  nothingToPresent: true;
34700
34746
  } | {
34701
34747
  presentationId: string;
34702
- /** @enum {string} */
34703
- statementKey: "continueStatement" | "updatedStatement" | "privacyOnlyStatement";
34704
34748
  /** Format: date-time */
34705
34749
  expiresAt: string;
34706
34750
  baseRevision: string;
34707
- copySha256: string;
34708
34751
  submissionToken?: string;
34709
- copy: {
34710
- copyVersion: string;
34752
+ copyVersion: string;
34753
+ /** @description Echo on acceptance. Never compute it yourself. */
34754
+ screenSha256: string;
34755
+ /** @enum {string} */
34756
+ language: "en";
34757
+ /** @description The consent screen to render exactly as given. */
34758
+ screen: {
34759
+ /**
34760
+ * @description For analytics only; never choose text by it.
34761
+ * @enum {string}
34762
+ */
34763
+ kind: "first_time" | "updated" | "privacy_only" | "esign_only";
34711
34764
  /** @enum {string} */
34712
- language: "en";
34713
- continueStatement: string;
34714
- updatedStatement: string;
34715
- privacyOnlyStatement: string;
34765
+ placement: "standalone" | "kyc";
34766
+ title: string | null;
34767
+ /** @description Render the segments in order as one paragraph. A segment with `link` opens `link.url` as given. */
34768
+ statement: {
34769
+ text: string;
34770
+ link?: {
34771
+ /** @enum {string} */
34772
+ type: "terms_of_service" | "privacy_policy" | "esign_consent";
34773
+ url: string;
34774
+ };
34775
+ }[] | null;
34776
+ /** @description Present exactly when E-SIGN consent is presented. Show it unchecked; enable the button only once it is checked. */
34777
+ checkbox: {
34778
+ /** @description Render the segments in order as one paragraph. A segment with `link` opens `link.url` as given. */
34779
+ label: {
34780
+ text: string;
34781
+ link?: {
34782
+ /** @enum {string} */
34783
+ type: "terms_of_service" | "privacy_policy" | "esign_consent";
34784
+ url: string;
34785
+ };
34786
+ }[];
34787
+ } | null;
34716
34788
  buttonLabel: string;
34717
- supportEmail: string;
34718
- /** @enum {string} */
34719
- consentPattern: "clickwrap" | "esign_checkbox";
34720
- esignCheckboxLabel?: string;
34721
- links: {
34722
- /** @enum {string} */
34723
- type: "terms_of_service" | "privacy_policy" | "esign_consent";
34724
- label: string;
34725
- url: string;
34726
- }[];
34727
34789
  };
34728
34790
  items: {
34729
34791
  /** @enum {string} */
@@ -35238,21 +35300,27 @@ interface operations {
35238
35300
  /** Format: uuid */
35239
35301
  presentationId: string;
35240
35302
  accept: ("terms_of_service" | "privacy_policy" | "esign_consent")[];
35241
- copySha256?: string;
35303
+ /** @description The presentation's `screenSha256`, echoed unchanged. */
35304
+ screenSha256: string;
35305
+ /** @description Send only when `screen.checkbox` is present, and only `true`: otherwise the acceptance is refused with `esign_consent_required` or `unexpected_esign_checkbox`. */
35242
35306
  esignCheckboxChecked?: boolean;
35243
35307
  };
35244
35308
  "application/x-www-form-urlencoded": {
35245
35309
  /** Format: uuid */
35246
35310
  presentationId: string;
35247
35311
  accept: ("terms_of_service" | "privacy_policy" | "esign_consent")[];
35248
- copySha256?: string;
35312
+ /** @description The presentation's `screenSha256`, echoed unchanged. */
35313
+ screenSha256: string;
35314
+ /** @description Send only when `screen.checkbox` is present, and only `true`: otherwise the acceptance is refused with `esign_consent_required` or `unexpected_esign_checkbox`. */
35249
35315
  esignCheckboxChecked?: boolean;
35250
35316
  };
35251
35317
  "multipart/form-data": {
35252
35318
  /** Format: uuid */
35253
35319
  presentationId: string;
35254
35320
  accept: ("terms_of_service" | "privacy_policy" | "esign_consent")[];
35255
- copySha256?: string;
35321
+ /** @description The presentation's `screenSha256`, echoed unchanged. */
35322
+ screenSha256: string;
35323
+ /** @description Send only when `screen.checkbox` is present, and only `true`: otherwise the acceptance is refused with `esign_consent_required` or `unexpected_esign_checkbox`. */
35256
35324
  esignCheckboxChecked?: boolean;
35257
35325
  };
35258
35326
  };
@@ -47340,10 +47408,10 @@ interface operations {
47340
47408
  * @example v1
47341
47409
  * @enum {string}
47342
47410
  */
47343
- messageVersion: "v1" | "fomo_v1" | "fomo_v2";
47411
+ messageVersion: "v1" | "fomo_v1" | "fomo_v2" | "v2" | "fomo_v3" | "fomo_v4";
47344
47412
  /** @description Display-ready ACH authorization message */
47345
47413
  message: string;
47346
- /** @description The authorization paragraph alone, a verbatim part of `message`. When `messageVersion` is `fomo_v2` the paragraph is self-contained: clients that lay out amounts and fees in their own UI must still display it word for word on the confirmation screen. For every other version, display `message` in full. */
47414
+ /** @description The authorization paragraph alone, a verbatim part of `message`. When `messageVersion` is `fomo_v2` or `fomo_v4` the paragraph is self-contained: clients that lay out amounts and fees in their own UI must still display it word for word on the confirmation screen. For every other version, display `message` in full. */
47347
47415
  authorizationStatement: string;
47348
47416
  /**
47349
47417
  * @description Short-lived, preparation-bound bearer capability returned for integrator preparations. Send it only to the authorizing client, which uses it to submit this preparation directly to Spritz.
@@ -47948,6 +48016,12 @@ interface operations {
47948
48016
  */
47949
48017
  profile: "refunded" | "release_failed" | "release_stalled" | "full_delivery" | "partial_then_full_delivery";
47950
48018
  };
48019
+ /**
48020
+ * @description What to do when the preparation quoted an instant portion and none of it can be granted at create. `standard` (also the behaviour when omitted) proceeds with settlement-only timing. `confirm` creates nothing and returns 409 `instant_unavailable`; after the user agrees to standard timing, submit the same preparationId again with `standard` and a new Idempotency-Key. A partly reduced instant portion always proceeds.
48021
+ * @default standard
48022
+ * @enum {string}
48023
+ */
48024
+ instantFallback?: "standard" | "confirm";
47951
48025
  };
47952
48026
  "application/x-www-form-urlencoded": {
47953
48027
  /**
@@ -47977,6 +48051,12 @@ interface operations {
47977
48051
  */
47978
48052
  profile: "refunded" | "release_failed" | "release_stalled" | "full_delivery" | "partial_then_full_delivery";
47979
48053
  };
48054
+ /**
48055
+ * @description What to do when the preparation quoted an instant portion and none of it can be granted at create. `standard` (also the behaviour when omitted) proceeds with settlement-only timing. `confirm` creates nothing and returns 409 `instant_unavailable`; after the user agrees to standard timing, submit the same preparationId again with `standard` and a new Idempotency-Key. A partly reduced instant portion always proceeds.
48056
+ * @default standard
48057
+ * @enum {string}
48058
+ */
48059
+ instantFallback?: "standard" | "confirm";
47980
48060
  };
47981
48061
  "multipart/form-data": {
47982
48062
  /**
@@ -48006,6 +48086,12 @@ interface operations {
48006
48086
  */
48007
48087
  profile: "refunded" | "release_failed" | "release_stalled" | "full_delivery" | "partial_then_full_delivery";
48008
48088
  };
48089
+ /**
48090
+ * @description What to do when the preparation quoted an instant portion and none of it can be granted at create. `standard` (also the behaviour when omitted) proceeds with settlement-only timing. `confirm` creates nothing and returns 409 `instant_unavailable`; after the user agrees to standard timing, submit the same preparationId again with `standard` and a new Idempotency-Key. A partly reduced instant portion always proceeds.
48091
+ * @default standard
48092
+ * @enum {string}
48093
+ */
48094
+ instantFallback?: "standard" | "confirm";
48009
48095
  };
48010
48096
  };
48011
48097
  };
@@ -48096,6 +48182,11 @@ interface operations {
48096
48182
  payoutTxHash: string | null;
48097
48183
  /** @description Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse. */
48098
48184
  cancellable: boolean;
48185
+ /**
48186
+ * Format: date-time
48187
+ * @description Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.
48188
+ */
48189
+ cancellableUntil: string | null;
48099
48190
  /**
48100
48191
  * Format: date-time
48101
48192
  * @description When the user's cancellation was confirmed
@@ -52749,6 +52840,10 @@ type AgreementsReceipt = PathResponse<'/v1/users/me/agreements/operations/{prese
52749
52840
  type AgreementsAcceptanceRequest = PathRequestBody<'/v1/agreements/acceptances', 'post'>;
52750
52841
  type AgreementsState = AgreementsReceipt['agreements'];
52751
52842
  type AgreementType = AgreementsPresentation['items'][number]['type'];
52843
+ type AgreementsScreen = AgreementsPresentation['screen'];
52844
+ type AgreementsScreenKind = AgreementsScreen['kind'];
52845
+ type AgreementsPlacement = AgreementsScreen['placement'];
52846
+ type AgreementsTextSegment = NonNullable<AgreementsScreen['statement']>[number];
52752
52847
  /**
52753
52848
  * Spritz agreements (Terms of Service, Privacy Policy, E-Sign Consent) are the
52754
52849
  * user's relationship-level consent with Spritz, separate from provider terms
@@ -52766,20 +52861,23 @@ declare class AgreementsService {
52766
52861
  * (`POST /v1/users/me/agreements/presentations`).
52767
52862
  *
52768
52863
  * Resolves with `{ nothingToPresent: true }` when the user has nothing to
52769
- * accept. Otherwise render `copy[statementKey]` verbatim directly above a
52770
- * button labelled `copy.buttonLabel`, linking each document from
52771
- * `copy.links`. Do not translate or rephrase it. Document URLs are relative
52772
- * to the Spritz API origin.
52864
+ * accept. Otherwise `screen` is the one consent screen to show: render its
52865
+ * `title`, `statement` segments, `checkbox` (unchecked; the button stays
52866
+ * disabled until it is checked) and `buttonLabel` exactly as given. Pass
52867
+ * `placement: 'kyc'` when the screen sits inside the step that starts
52868
+ * identity verification. Document URLs are absolute.
52773
52869
  *
52774
- * Forward `presentationId`, `copySha256`, the presented `items[].type` and
52775
- * the short-lived `submissionToken` (15 minutes, this presentation only) to
52776
- * the user's client. That client sends `POST /v1/agreements/acceptances`
52777
- * itself, with `Authorization: Bearer <submissionToken>` and body
52778
- * `{ presentationId, accept, copySha256 }`. Spritz refuses an acceptance sent
52870
+ * Forward `presentationId`, `screenSha256`, the presented `items[].type`
52871
+ * and the short-lived `submissionToken` (15 minutes, this presentation
52872
+ * only) to the user's client. That client sends
52873
+ * `POST /v1/agreements/acceptances` itself, with
52874
+ * `Authorization: Bearer <submissionToken>` and body
52875
+ * `{ presentationId, accept, screenSha256 }`, plus
52876
+ * `esignCheckboxChecked: true` exactly when `screen.checkbox` is present.
52877
+ * `accept` lists every presented type. Spritz refuses an acceptance sent
52779
52878
  * from your backend, including one sent from the network that created the
52780
52879
  * presentation (`403 client_submission_required`), so this SDK does not
52781
- * make that request. Under the default `clickwrap` pattern, `accept` must
52782
- * list every presented type.
52880
+ * make that request.
52783
52881
  *
52784
52882
  * Throws a `RateLimitError` with `problem.code ===
52785
52883
  * 'agreement_presentation_rate_limited'` after ten presentations for one user
@@ -54740,7 +54838,7 @@ declare class DepositService {
54740
54838
  preparationId: string;
54741
54839
  kind: "deposit_authorization";
54742
54840
  expiresAt: string;
54743
- messageVersion: "v1" | "fomo_v1" | "fomo_v2";
54841
+ messageVersion: "v1" | "fomo_v1" | "fomo_v2" | "v2" | "fomo_v3" | "fomo_v4";
54744
54842
  message: string;
54745
54843
  authorizationStatement: string;
54746
54844
  submissionToken?: string;
@@ -54789,6 +54887,13 @@ declare class DepositService {
54789
54887
  *
54790
54888
  * Integrator JWT is not accepted on this route because it cannot bind the
54791
54889
  * claimed `clientIp`; it remains valid on `prepare` and the read methods.
54890
+ *
54891
+ * With `instantFallback: 'confirm'`, a high-priority preparation that can
54892
+ * get no instant portion throws a `ConflictError` with
54893
+ * `problem.code === 'instant_unavailable'` instead of proceeding at
54894
+ * standard timing. Nothing is created and the preparation stays usable:
54895
+ * once the user accepts standard timing, call `create` again with the same
54896
+ * `preparationId`, `instantFallback: 'standard'` and a new idempotency key.
54792
54897
  */
54793
54898
  create(input: CreateDepositRequest, options: CreateDepositOptions): Promise<{
54794
54899
  id: string;
@@ -54838,6 +54943,7 @@ declare class DepositService {
54838
54943
  releaseFailureReason: string | null;
54839
54944
  payoutTxHash: string | null;
54840
54945
  cancellable: boolean;
54946
+ cancellableUntil: string | null;
54841
54947
  cancelledAt: string | null;
54842
54948
  }>;
54843
54949
  /**
@@ -54896,6 +55002,7 @@ declare class DepositService {
54896
55002
  releaseFailureReason: string | null;
54897
55003
  payoutTxHash: string | null;
54898
55004
  cancellable: boolean;
55005
+ cancellableUntil: string | null;
54899
55006
  cancelledAt: string | null;
54900
55007
  }[];
54901
55008
  hasMore: boolean;
@@ -54949,6 +55056,7 @@ declare class DepositService {
54949
55056
  releaseFailureReason: string | null;
54950
55057
  payoutTxHash: string | null;
54951
55058
  cancellable: boolean;
55059
+ cancellableUntil: string | null;
54952
55060
  cancelledAt: string | null;
54953
55061
  }>;
54954
55062
  /**
@@ -55015,6 +55123,7 @@ declare class DepositService {
55015
55123
  releaseFailureReason: string | null;
55016
55124
  payoutTxHash: string | null;
55017
55125
  cancellable: boolean;
55126
+ cancellableUntil: string | null;
55018
55127
  cancelledAt: string | null;
55019
55128
  }>;
55020
55129
  }
@@ -55173,6 +55282,7 @@ declare class SandboxService {
55173
55282
  releaseFailureReason: string | null;
55174
55283
  payoutTxHash: string | null;
55175
55284
  cancellable: boolean;
55285
+ cancellableUntil: string | null;
55176
55286
  cancelledAt: string | null;
55177
55287
  }>;
55178
55288
  /**
@@ -55185,7 +55295,7 @@ declare class SandboxService {
55185
55295
  preparationId: string;
55186
55296
  kind: "deposit_authorization";
55187
55297
  expiresAt: string;
55188
- messageVersion: "v1" | "fomo_v1" | "fomo_v2";
55298
+ messageVersion: "v1" | "fomo_v1" | "fomo_v2" | "v2" | "fomo_v3" | "fomo_v4";
55189
55299
  message: string;
55190
55300
  authorizationStatement: string;
55191
55301
  submissionToken?: string;
@@ -56663,4 +56773,4 @@ declare function hasProblemCode<T extends string>(error: unknown, code: T): erro
56663
56773
  };
56664
56774
 
56665
56775
  export { APIConnectionError, APIConnectionTimeoutError, APIError, APIUserAbortError, AmountMode, AuthenticationError, BadRequestError, BankAccountSubType, BankAccountType, BillType, CardFeatureType, ConflictError, DebitCardNetwork, Environment, InternalServerError, NotFoundError, OfframpFeatureType, OnrampFeatureType, PayableAccountType, PaymentDeliveryMethod, PaymentNetwork, DirectPaymentStatus as PaymentRequestStatus, PaymentStatus, PermissionDeniedError, RateLimitError, RequirementType, SpritzApiClient, SpritzApiError, UnprocessableEntityError, VirtualCardType, hasProblemCode, hasProblemType, isAPIError, onrampSupportedTokens };
56666
- export type { AcceptTermsRequest, AcceptTermsResponse, AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitEligibilityRequest, AchDebitEligibilityResponse, AchDebitExposureResponse, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, AgreementType, AgreementsAcceptanceRequest, AgreementsPresentation, AgreementsReceipt, AgreementsState, AutoRampAccount, AutoRampAccountEstimate, AutoRampAccountList, BankAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BankAccountList, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CancelDepositResponse, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, ComplianceRequirementField, ComplianceRequirements, CreateAgreementsPresentationRequest, CreateAgreementsPresentationResponse, CreateAutoRampAccountRequest, CreateBankAccountInput, CreateBankAccountResponse, CreateDepositOptions, CreateDepositRequest, CreateDepositWithReturnRequest, CreateDepositWithReturnResponse, CreateDirectPaymentInput, CreateOffRampQuoteRequest, CreateOnrampPaymentInput, CreatePaymentRequestInput, CreateVirtualAccountInput, CreateWebhookParams, CurrentUser, CurrentUser_me, CurrentUser_verification, CurrentUser_verification_identity, CurrentUser_verification_identity_verificationMetadata, CurrentUser_verification_identity_verificationMetadata_details, DebitCardFragment, DebitCardInput, DeleteBankAccountResponse, DeleteFundingSourceResponse, Deposit, DepositCancelRefusalReason, DepositListQuery, DepositListResponse, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkBankAccountRequest, LinkBankAccountResponse, LinkTokenResponse, OffRampQuote, OffRampQuoteTransaction, OffRampQuoteTransactionRequest, OffRampRefundRequest, OffRampRefundResponse, OnRamp, OnRampDetail, OnRampListQuery, OnRampListResponse, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PathParams, PathQuery, PathRequestBody, PathResponse, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentFragment_transaction, PaymentLimits, PaymentLimitsResponse, PaymentLimitsVariables, PaymentLimits_paymentLimits, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, PrepareDepositRequest, PrepareDepositResponse, PrepareDepositWithProgramControlRequest, PrepareDepositWithProgramControlResponse, ProblemDetails, ProblemFieldError, ProblemSuggestedAction, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, SetAchDebitExposureCapRequest, SetAchDebitExposureCapResponse, SimulateAutoRampDepositRequest, SimulateAutoRampDepositResponse, SubmitComplianceRequest, SubmitComplianceResponse, SubmitOffRampQuoteRequest, TokenBalanceFragment, UpdateWebhookParams, UpdateWebhookSecretResponse, UserAccess, UserAccessCapabilities, UserAccess_bridgeUser, UserAccess_me, UserAccess_verification, UserAccess_verification_identity, UserAccess_verification_identity_verificationMetadata, UserAccess_verification_identity_verificationMetadata_details, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, UserProfile, UserVerification, UserVerification_verification, UserVerification_verification_identity, UserVerification_verification_identity_user, UserVerification_verification_identity_verificationMetadata, UserVerification_verification_identity_verificationMetadata_details, UserVirtualDebitCard, UserVirtualDebitCard_virtualDebitCard, UserVirtualDebitCard_virtualDebitCard_billingInfo, UserVirtualDebitCard_virtualDebitCard_billingInfo_address, UserVirtualDebitCard_virtualDebitCard_paymentAddresses, VerificationFragment, VerificationFragment_identity, VerificationFragment_identity_verificationMetadata, VerificationFragment_identity_verificationMetadata_details, VerificationSession, VirtualAccountFragment, VirtualAccountFragment_depositInstructions, VirtualAccounts, VirtualAccounts_virtualAccounts, VirtualAccounts_virtualAccounts_depositInstructions, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances, WebhookEvent };
56776
+ export type { AcceptTermsRequest, AcceptTermsResponse, AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitEligibilityRequest, AchDebitEligibilityResponse, AchDebitExposureResponse, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, AgreementType, AgreementsAcceptanceRequest, AgreementsPlacement, AgreementsPresentation, AgreementsReceipt, AgreementsScreen, AgreementsScreenKind, AgreementsState, AgreementsTextSegment, AutoRampAccount, AutoRampAccountEstimate, AutoRampAccountList, BankAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BankAccountList, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CancelDepositResponse, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, ComplianceRequirementField, ComplianceRequirements, CreateAgreementsPresentationRequest, CreateAgreementsPresentationResponse, CreateAutoRampAccountRequest, CreateBankAccountInput, CreateBankAccountResponse, CreateDepositOptions, CreateDepositRequest, CreateDepositWithReturnRequest, CreateDepositWithReturnResponse, CreateDirectPaymentInput, CreateOffRampQuoteRequest, CreateOnrampPaymentInput, CreatePaymentRequestInput, CreateVirtualAccountInput, CreateWebhookParams, CurrentUser, CurrentUser_me, CurrentUser_verification, CurrentUser_verification_identity, CurrentUser_verification_identity_verificationMetadata, CurrentUser_verification_identity_verificationMetadata_details, DebitCardFragment, DebitCardInput, DeleteBankAccountResponse, DeleteFundingSourceResponse, Deposit, DepositCancelRefusalReason, DepositListQuery, DepositListResponse, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkBankAccountRequest, LinkBankAccountResponse, LinkTokenResponse, OffRampQuote, OffRampQuoteTransaction, OffRampQuoteTransactionRequest, OffRampRefundRequest, OffRampRefundResponse, OnRamp, OnRampDetail, OnRampListQuery, OnRampListResponse, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PathParams, PathQuery, PathRequestBody, PathResponse, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentFragment_transaction, PaymentLimits, PaymentLimitsResponse, PaymentLimitsVariables, PaymentLimits_paymentLimits, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, PrepareDepositRequest, PrepareDepositResponse, PrepareDepositWithProgramControlRequest, PrepareDepositWithProgramControlResponse, ProblemDetails, ProblemFieldError, ProblemSuggestedAction, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, SetAchDebitExposureCapRequest, SetAchDebitExposureCapResponse, SimulateAutoRampDepositRequest, SimulateAutoRampDepositResponse, SubmitComplianceRequest, SubmitComplianceResponse, SubmitOffRampQuoteRequest, TokenBalanceFragment, UpdateWebhookParams, UpdateWebhookSecretResponse, UserAccess, UserAccessCapabilities, UserAccess_bridgeUser, UserAccess_me, UserAccess_verification, UserAccess_verification_identity, UserAccess_verification_identity_verificationMetadata, UserAccess_verification_identity_verificationMetadata_details, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, UserProfile, UserVerification, UserVerification_verification, UserVerification_verification_identity, UserVerification_verification_identity_user, UserVerification_verification_identity_verificationMetadata, UserVerification_verification_identity_verificationMetadata_details, UserVirtualDebitCard, UserVirtualDebitCard_virtualDebitCard, UserVirtualDebitCard_virtualDebitCard_billingInfo, UserVirtualDebitCard_virtualDebitCard_billingInfo_address, UserVirtualDebitCard_virtualDebitCard_paymentAddresses, VerificationFragment, VerificationFragment_identity, VerificationFragment_identity_verificationMetadata, VerificationFragment_identity_verificationMetadata_details, VerificationSession, VirtualAccountFragment, VirtualAccountFragment_depositInstructions, VirtualAccounts, VirtualAccounts_virtualAccounts, VirtualAccounts_virtualAccounts_depositInstructions, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances, WebhookEvent };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spritz-finance/api-client",
3
- "version": "0.26.0",
3
+ "version": "0.28.0",
4
4
  "packageManager": "yarn@1.22.22",
5
5
  "description": "Typescript library for interacting with the Spritz Finance API",
6
6
  "type": "module",