@spritz-finance/api-client 0.25.0 → 0.27.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
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`; 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))
@@ -1396,7 +1407,9 @@ A standalone sandbox demo is available at `scripts/sandbox/ach-onramp.html`. Run
1396
1407
  Before you show a bank deposit option to someone who is not yet a Spritz user, ask whether it is available for their email address:
1397
1408
 
1398
1409
  ```typescript
1399
- const { eligible } = await client.achDebit.checkEligibility({ email: 'user@example.com' })
1410
+ const { eligible } = await client.achDebit.checkEligibility({
1411
+ email: 'user@example.com',
1412
+ })
1400
1413
 
1401
1414
  if (eligible) {
1402
1415
  // Offer the bank deposit option
@@ -1517,7 +1530,10 @@ const { onRampId, depositId, status } = await client.sandbox.simulateAutoRampDep
1517
1530
  })
1518
1531
 
1519
1532
  // Advance the same on-ramp
1520
- await client.sandbox.simulateAutoRampDeposit(accountId, { amount: '2525.00', depositId })
1533
+ await client.sandbox.simulateAutoRampDeposit(accountId, {
1534
+ amount: '2525.00',
1535
+ depositId,
1536
+ })
1521
1537
 
1522
1538
  const onRamp = await client.onrampPayment.get(onRampId)
1523
1539
  ```
@@ -2073,7 +2073,7 @@ interface paths {
2073
2073
  put?: never;
2074
2074
  /**
2075
2075
  * Prepare Solana transaction
2076
- * @description Prepares an unsigned Solana v0 message for the authenticated user's embedded wallet to sign. Supports `transfer`, `payment`, `yield.deposit`, and `yield.withdraw` intents. Kamino is the only yield protocol supported today. The response `messageBytes` are base64-encoded Solana message bytes, not a serialized transaction; the wallet must sign the decoded bytes exactly and submit only the detached signature.
2076
+ * @description Prepares an unsigned Solana v0 message for the authenticated user's embedded wallet to sign. Supports `transfer`, `payment`, `yield.deposit`, and `yield.withdraw` intents. Kamino is the only yield protocol supported today. `intent.from` must be one of the caller's embedded wallet Solana addresses, or the request is refused with 403 `SOURCE_WALLET_NOT_OWNED`. The response `messageBytes` are base64-encoded Solana message bytes, not a serialized transaction; the wallet must sign the decoded bytes exactly and submit only the detached signature.
2077
2077
  */
2078
2078
  post: operations["postV1Wallet-kitSolanaTransactionsPrepare"];
2079
2079
  delete?: never;
@@ -4566,7 +4566,7 @@ interface operations {
4566
4566
  /**
4567
4567
  * Format: date-time
4568
4568
  * @description Creation timestamp
4569
- * @example 2026-11-12T11:47:43.743Z
4569
+ * @example 2026-11-13T11:49:12.976Z
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 6af5a75fc6fd3bb395e9d0d0
4807
+ * @example 6af6f9380974dd7f7609c738
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 6af5a75fc6fd3bb395e9d0d0
4835
+ * @example 6af6f9380974dd7f7609c738
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 6af5a75fc6fd3bb395e9d0d0
4863
+ * @example 6af6f9380974dd7f7609c738
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-12T11:47:43.671Z
4910
+ * @example 2026-11-13T11:49:12.955Z
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 6af5a75fc6fd3bb395e9d0d1
4949
+ * @example 6af6f9380974dd7f7609c739
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-12T11:47:43.671Z
5279
+ * @example 2026-11-13T11:49:12.955Z
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 6af5a75fc6fd3bb395e9d0d1
5318
+ * @example 6af6f9380974dd7f7609c739
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-12T11:47:43.671Z
6273
+ * @example 2026-11-13T11:49:12.955Z
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 6af5a75fc6fd3bb395e9d0d1
6312
+ * @example 6af6f9380974dd7f7609c739
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 6af5a75fc6fd3bb395e9d0d2
6688
+ * @example 6af6f9380974dd7f7609c73a
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 6af5a75fc6fd3bb395e9d0d2
7052
+ * @example 6af6f9380974dd7f7609c73a
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 6af5a75fc6fd3bb395e9d0d3
7366
+ * @example 6af6f9380974dd7f7609c73b
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 6af5a75fc6fd3bb395e9d0d3
7384
+ * @example 6af6f9380974dd7f7609c73b
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 6af5a75fc6fd3bb395e9d0d3
7402
+ * @example 6af6f9380974dd7f7609c73b
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 6af5a75fc6fd3bb395e9d0d2
7468
+ * @example 6af6f9380974dd7f7609c73a
7469
7469
  */
7470
7470
  accountId: string;
7471
7471
  /**
@@ -14992,9 +14992,11 @@ interface operations {
14992
14992
  * @example v1
14993
14993
  * @enum {string}
14994
14994
  */
14995
- messageVersion: "v1" | "fomo_v1";
14995
+ messageVersion: "v1" | "fomo_v1" | "fomo_v2";
14996
14996
  /** @description Display-ready ACH authorization message */
14997
14997
  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. */
14999
+ authorizationStatement: string;
14998
15000
  /**
14999
15001
  * @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.
15000
15002
  * @example ach_submit_eyJhbGciOiJIUzI1NiJ9...
@@ -22824,7 +22826,7 @@ interface operations {
22824
22826
  data: {
22825
22827
  /**
22826
22828
  * @description Unique identifier for the debit card
22827
- * @example 6af5a75fc6fd3bb395e9d0d7
22829
+ * @example 6af6f9380974dd7f7609c73f
22828
22830
  */
22829
22831
  id: string;
22830
22832
  /** @enum {string} */
@@ -23345,7 +23347,7 @@ interface operations {
23345
23347
  "application/json": {
23346
23348
  /**
23347
23349
  * @description Unique identifier for the debit card
23348
- * @example 6af5a75fc6fd3bb395e9d0d7
23350
+ * @example 6af6f9380974dd7f7609c73f
23349
23351
  */
23350
23352
  id: string;
23351
23353
  /** @enum {string} */
@@ -23635,7 +23637,7 @@ interface operations {
23635
23637
  "application/json": {
23636
23638
  /**
23637
23639
  * @description Unique identifier for the debit card
23638
- * @example 6af5a75fc6fd3bb395e9d0d7
23640
+ * @example 6af6f9380974dd7f7609c73f
23639
23641
  */
23640
23642
  id: string;
23641
23643
  /** @enum {string} */
@@ -24302,7 +24304,7 @@ interface operations {
24302
24304
  "application/json": {
24303
24305
  /**
24304
24306
  * @description Unique identifier for the debit card
24305
- * @example 6af5a75fc6fd3bb395e9d0d7
24307
+ * @example 6af6f9380974dd7f7609c73f
24306
24308
  */
24307
24309
  id: string;
24308
24310
  /** @enum {string} */
@@ -24637,7 +24639,7 @@ interface operations {
24637
24639
  accessToken: string;
24638
24640
  /**
24639
24641
  * @description The internal ID of the authorized user
24640
- * @example 6af5a760c6fd3bb395e9d0db
24642
+ * @example 6af6f9390974dd7f7609c743
24641
24643
  */
24642
24644
  userId: string;
24643
24645
  /**
@@ -24653,7 +24655,7 @@ interface operations {
24653
24655
  /**
24654
24656
  * Format: date-time
24655
24657
  * @description ISO 8601 timestamp when token expires
24656
- * @example 2026-11-12T12:47:44.042Z
24658
+ * @example 2026-11-13T12:49:13.268Z
24657
24659
  */
24658
24660
  expiresAt: string;
24659
24661
  };
@@ -24925,7 +24927,7 @@ interface operations {
24925
24927
  /**
24926
24928
  * Format: date-time
24927
24929
  * @description ISO 8601 timestamp of when the integrator was created
24928
- * @example 2026-11-12T11:47:44.042Z
24930
+ * @example 2026-11-13T11:49:13.267Z
24929
24931
  */
24930
24932
  createdAt: string;
24931
24933
  };
@@ -25211,7 +25213,7 @@ interface operations {
25211
25213
  "application/json": {
25212
25214
  /**
25213
25215
  * @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.
25214
- * @example 6af5a760c6fd3bb395e9d0dd
25216
+ * @example 6af6f9390974dd7f7609c745
25215
25217
  */
25216
25218
  userId: string;
25217
25219
  /**
@@ -25703,7 +25705,7 @@ interface operations {
25703
25705
  depositId: string;
25704
25706
  /**
25705
25707
  * @description Spritz user ID associated with the returned deposit
25706
- * @example 6af5a760c6fd3bb395e9d0da
25708
+ * @example 6af6f9390974dd7f7609c742
25707
25709
  */
25708
25710
  userId: string;
25709
25711
  /**
@@ -25988,7 +25990,7 @@ interface operations {
25988
25990
  depositId: string;
25989
25991
  /**
25990
25992
  * @description Spritz user ID associated with the returned deposit
25991
- * @example 6af5a760c6fd3bb395e9d0da
25993
+ * @example 6af6f9390974dd7f7609c742
25992
25994
  */
25993
25995
  userId: string;
25994
25996
  /**
@@ -26254,7 +26256,7 @@ interface operations {
26254
26256
  "application/json": {
26255
26257
  /**
26256
26258
  * @description Unique identifier for the webhook
26257
- * @example 6af5a760c6fd3bb395e9d0dc
26259
+ * @example 6af6f9390974dd7f7609c744
26258
26260
  */
26259
26261
  id: string;
26260
26262
  /** @description List of event types this webhook is subscribed to */
@@ -26558,7 +26560,7 @@ interface operations {
26558
26560
  "application/json": {
26559
26561
  /**
26560
26562
  * @description Unique identifier for the webhook
26561
- * @example 6af5a760c6fd3bb395e9d0dc
26563
+ * @example 6af6f9390974dd7f7609c744
26562
26564
  */
26563
26565
  id: string;
26564
26566
  /** @description List of event types this webhook is subscribed to */
@@ -30415,7 +30417,7 @@ interface operations {
30415
30417
  "application/json": {
30416
30418
  /**
30417
30419
  * @description Unique identifier for the webhook
30418
- * @example 6af5a760c6fd3bb395e9d0dc
30420
+ * @example 6af6f9390974dd7f7609c744
30419
30421
  */
30420
30422
  id: string;
30421
30423
  /** @description List of event types this webhook is subscribed to */
@@ -31055,7 +31057,7 @@ interface operations {
31055
31057
  /**
31056
31058
  * Format: date-time
31057
31059
  * @description ISO 8601 timestamp when the old secret will expire. Only present if a grace period was specified.
31058
- * @example 2026-11-12T11:52:44.043Z
31060
+ * @example 2026-11-13T11:54:13.268Z
31059
31061
  */
31060
31062
  oldSecretExpiresAt?: string;
31061
31063
  };
@@ -31299,7 +31301,7 @@ interface operations {
31299
31301
  "application/json": {
31300
31302
  /**
31301
31303
  * @description Unique identifier for the user
31302
- * @example 6af5a760c6fd3bb395e9d0d8
31304
+ * @example 6af6f9390974dd7f7609c740
31303
31305
  */
31304
31306
  id: string;
31305
31307
  /**
@@ -31316,7 +31318,7 @@ interface operations {
31316
31318
  /**
31317
31319
  * Format: date-time
31318
31320
  * @description ISO 8601 timestamp of when the user was created
31319
- * @example 2026-11-12T11:47:44.036Z
31321
+ * @example 2026-11-13T11:49:13.255Z
31320
31322
  */
31321
31323
  signedUpAt: string;
31322
31324
  /**
@@ -31795,7 +31797,7 @@ interface operations {
31795
31797
  "application/json": {
31796
31798
  /**
31797
31799
  * @description Unique identifier for the user
31798
- * @example 6af5a760c6fd3bb395e9d0d8
31800
+ * @example 6af6f9390974dd7f7609c740
31799
31801
  */
31800
31802
  id: string;
31801
31803
  /**
@@ -31812,7 +31814,7 @@ interface operations {
31812
31814
  /**
31813
31815
  * Format: date-time
31814
31816
  * @description ISO 8601 timestamp of when the user was created
31815
- * @example 2026-11-12T11:47:44.036Z
31817
+ * @example 2026-11-13T11:49:13.255Z
31816
31818
  */
31817
31819
  signedUpAt: string;
31818
31820
  /**
@@ -32655,7 +32657,7 @@ interface operations {
32655
32657
  "application/json": {
32656
32658
  /**
32657
32659
  * @description Unique identifier for the user
32658
- * @example 6af5a760c6fd3bb395e9d0d8
32660
+ * @example 6af6f9390974dd7f7609c740
32659
32661
  */
32660
32662
  id: string;
32661
32663
  /**
@@ -32672,7 +32674,7 @@ interface operations {
32672
32674
  /**
32673
32675
  * Format: date-time
32674
32676
  * @description ISO 8601 timestamp of when the user was created
32675
- * @example 2026-11-12T11:47:44.036Z
32677
+ * @example 2026-11-13T11:49:13.255Z
32676
32678
  */
32677
32679
  signedUpAt: string;
32678
32680
  /**
@@ -34675,13 +34677,16 @@ interface operations {
34675
34677
  requestBody: {
34676
34678
  content: {
34677
34679
  "application/json": {
34678
- types?: ("terms_of_service" | "privacy_policy" | "esign_consent")[];
34680
+ /** @enum {string} */
34681
+ placement?: "standalone" | "kyc";
34679
34682
  };
34680
34683
  "application/x-www-form-urlencoded": {
34681
- types?: ("terms_of_service" | "privacy_policy" | "esign_consent")[];
34684
+ /** @enum {string} */
34685
+ placement?: "standalone" | "kyc";
34682
34686
  };
34683
34687
  "multipart/form-data": {
34684
- types?: ("terms_of_service" | "privacy_policy" | "esign_consent")[];
34688
+ /** @enum {string} */
34689
+ placement?: "standalone" | "kyc";
34685
34690
  };
34686
34691
  };
34687
34692
  };
@@ -34697,31 +34702,47 @@ interface operations {
34697
34702
  nothingToPresent: true;
34698
34703
  } | {
34699
34704
  presentationId: string;
34700
- /** @enum {string} */
34701
- statementKey: "continueStatement" | "updatedStatement" | "privacyOnlyStatement";
34702
34705
  /** Format: date-time */
34703
34706
  expiresAt: string;
34704
34707
  baseRevision: string;
34705
- copySha256: string;
34706
34708
  submissionToken?: string;
34707
- copy: {
34708
- copyVersion: string;
34709
+ copyVersion: string;
34710
+ /** @description Echo on acceptance. Never compute it yourself. */
34711
+ screenSha256: string;
34712
+ /** @enum {string} */
34713
+ language: "en";
34714
+ /** @description The consent screen to render exactly as given. */
34715
+ screen: {
34716
+ /**
34717
+ * @description For analytics only; never choose text by it.
34718
+ * @enum {string}
34719
+ */
34720
+ kind: "first_time" | "updated" | "privacy_only" | "esign_only";
34709
34721
  /** @enum {string} */
34710
- language: "en";
34711
- continueStatement: string;
34712
- updatedStatement: string;
34713
- privacyOnlyStatement: string;
34722
+ placement: "standalone" | "kyc";
34723
+ title: string | null;
34724
+ /** @description Render the segments in order as one paragraph. A segment with `link` opens `link.url` as given. */
34725
+ statement: {
34726
+ text: string;
34727
+ link?: {
34728
+ /** @enum {string} */
34729
+ type: "terms_of_service" | "privacy_policy" | "esign_consent";
34730
+ url: string;
34731
+ };
34732
+ }[] | null;
34733
+ /** @description Present exactly when E-SIGN consent is presented. Show it unchecked; enable the button only once it is checked. */
34734
+ checkbox: {
34735
+ /** @description Render the segments in order as one paragraph. A segment with `link` opens `link.url` as given. */
34736
+ label: {
34737
+ text: string;
34738
+ link?: {
34739
+ /** @enum {string} */
34740
+ type: "terms_of_service" | "privacy_policy" | "esign_consent";
34741
+ url: string;
34742
+ };
34743
+ }[];
34744
+ } | null;
34714
34745
  buttonLabel: string;
34715
- supportEmail: string;
34716
- /** @enum {string} */
34717
- consentPattern: "clickwrap" | "esign_checkbox";
34718
- esignCheckboxLabel?: string;
34719
- links: {
34720
- /** @enum {string} */
34721
- type: "terms_of_service" | "privacy_policy" | "esign_consent";
34722
- label: string;
34723
- url: string;
34724
- }[];
34725
34746
  };
34726
34747
  items: {
34727
34748
  /** @enum {string} */
@@ -35236,21 +35257,27 @@ interface operations {
35236
35257
  /** Format: uuid */
35237
35258
  presentationId: string;
35238
35259
  accept: ("terms_of_service" | "privacy_policy" | "esign_consent")[];
35239
- copySha256?: string;
35260
+ /** @description The presentation's `screenSha256`, echoed unchanged. */
35261
+ screenSha256: string;
35262
+ /** @description Send only when `screen.checkbox` is present, and only `true`: otherwise the acceptance is refused with `esign_consent_required` or `unexpected_esign_checkbox`. */
35240
35263
  esignCheckboxChecked?: boolean;
35241
35264
  };
35242
35265
  "application/x-www-form-urlencoded": {
35243
35266
  /** Format: uuid */
35244
35267
  presentationId: string;
35245
35268
  accept: ("terms_of_service" | "privacy_policy" | "esign_consent")[];
35246
- copySha256?: string;
35269
+ /** @description The presentation's `screenSha256`, echoed unchanged. */
35270
+ screenSha256: string;
35271
+ /** @description Send only when `screen.checkbox` is present, and only `true`: otherwise the acceptance is refused with `esign_consent_required` or `unexpected_esign_checkbox`. */
35247
35272
  esignCheckboxChecked?: boolean;
35248
35273
  };
35249
35274
  "multipart/form-data": {
35250
35275
  /** Format: uuid */
35251
35276
  presentationId: string;
35252
35277
  accept: ("terms_of_service" | "privacy_policy" | "esign_consent")[];
35253
- copySha256?: string;
35278
+ /** @description The presentation's `screenSha256`, echoed unchanged. */
35279
+ screenSha256: string;
35280
+ /** @description Send only when `screen.checkbox` is present, and only `true`: otherwise the acceptance is refused with `esign_consent_required` or `unexpected_esign_checkbox`. */
35254
35281
  esignCheckboxChecked?: boolean;
35255
35282
  };
35256
35283
  };
@@ -38954,6 +38981,77 @@ interface operations {
38954
38981
  };
38955
38982
  };
38956
38983
  };
38984
+ /** @description Response for status 403 */
38985
+ 403: {
38986
+ headers: {
38987
+ [name: string]: unknown;
38988
+ };
38989
+ content: {
38990
+ "application/problem+json": {
38991
+ /**
38992
+ * @description A URI reference that identifies the problem type
38993
+ * @default about:blank
38994
+ * @example urn:problem-type:auth:unauthorized
38995
+ */
38996
+ type: string;
38997
+ /**
38998
+ * @description A short, human-readable summary of the problem type
38999
+ * @example Unauthorized
39000
+ */
39001
+ title: string;
39002
+ /**
39003
+ * @description The HTTP status code
39004
+ * @example 400
39005
+ */
39006
+ status: number;
39007
+ /** @description A human-readable explanation specific to this occurrence */
39008
+ detail?: string;
39009
+ /**
39010
+ * @description A URI reference that identifies the specific occurrence
39011
+ * @example /errors/1234567890
39012
+ */
39013
+ instance?: string;
39014
+ /**
39015
+ * @description Machine-readable cause, present when exactly one thing failed. Branch on this, never on `detail`, which is human-facing copy and may change. For deposit limits the vocabulary matches the `reason` values the limits API returns pre-flight.
39016
+ * @example transaction_limit
39017
+ */
39018
+ code?: string;
39019
+ /**
39020
+ * @description The offending request field, present alongside `code`.
39021
+ * @example amountUsd
39022
+ */
39023
+ field?: string;
39024
+ /**
39025
+ * @description Whether retrying the same request later may succeed without changing its inputs.
39026
+ * @example true
39027
+ */
39028
+ retryable?: boolean;
39029
+ /**
39030
+ * @description Seconds to wait before retrying, present alongside `retryable: true`. Mirrors the `Retry-After` response header and is meant for short backoffs the server chose (load shedding); for a condition that clears on its own schedule, `clearsAt` carries the absolute time instead.
39031
+ * @example 5
39032
+ */
39033
+ retryAfter?: number;
39034
+ /** @enum {string} */
39035
+ suggestedAction?: "auto_ramp" | "wait_for_settlement";
39036
+ /**
39037
+ * Format: date-time
39038
+ * @description Earliest known time the current temporary condition may clear.
39039
+ */
39040
+ clearsAt?: string | null;
39041
+ /**
39042
+ * Format: date-time
39043
+ * @description When a temporary block lifts: a temporarily ineligible funding source, or new deposits paused after repeated cancellations (`ach_debit_cancel_cooldown`).
39044
+ */
39045
+ availableAt?: string | null;
39046
+ /** @description Whether the current funding-source restriction will not clear automatically. */
39047
+ permanent?: boolean;
39048
+ /** @enum {string} */
39049
+ reason?: "crypto_released" | "debit_in_progress" | "deposit_closed";
39050
+ } & {
39051
+ [key: string]: unknown;
39052
+ };
39053
+ };
39054
+ };
38957
39055
  /** @description Response for status 409 */
38958
39056
  409: {
38959
39057
  headers: {
@@ -47267,9 +47365,11 @@ interface operations {
47267
47365
  * @example v1
47268
47366
  * @enum {string}
47269
47367
  */
47270
- messageVersion: "v1" | "fomo_v1";
47368
+ messageVersion: "v1" | "fomo_v1" | "fomo_v2";
47271
47369
  /** @description Display-ready ACH authorization message */
47272
47370
  message: string;
47371
+ /** @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. */
47372
+ authorizationStatement: string;
47273
47373
  /**
47274
47374
  * @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.
47275
47375
  * @example ach_submit_eyJhbGciOiJIUzI1NiJ9...
@@ -52674,6 +52774,10 @@ type AgreementsReceipt = PathResponse<'/v1/users/me/agreements/operations/{prese
52674
52774
  type AgreementsAcceptanceRequest = PathRequestBody<'/v1/agreements/acceptances', 'post'>;
52675
52775
  type AgreementsState = AgreementsReceipt['agreements'];
52676
52776
  type AgreementType = AgreementsPresentation['items'][number]['type'];
52777
+ type AgreementsScreen = AgreementsPresentation['screen'];
52778
+ type AgreementsScreenKind = AgreementsScreen['kind'];
52779
+ type AgreementsPlacement = AgreementsScreen['placement'];
52780
+ type AgreementsTextSegment = NonNullable<AgreementsScreen['statement']>[number];
52677
52781
  /**
52678
52782
  * Spritz agreements (Terms of Service, Privacy Policy, E-Sign Consent) are the
52679
52783
  * user's relationship-level consent with Spritz, separate from provider terms
@@ -52691,20 +52795,23 @@ declare class AgreementsService {
52691
52795
  * (`POST /v1/users/me/agreements/presentations`).
52692
52796
  *
52693
52797
  * Resolves with `{ nothingToPresent: true }` when the user has nothing to
52694
- * accept. Otherwise render `copy[statementKey]` verbatim directly above a
52695
- * button labelled `copy.buttonLabel`, linking each document from
52696
- * `copy.links`. Do not translate or rephrase it. Document URLs are relative
52697
- * to the Spritz API origin.
52798
+ * accept. Otherwise `screen` is the one consent screen to show: render its
52799
+ * `title`, `statement` segments, `checkbox` (unchecked; the button stays
52800
+ * disabled until it is checked) and `buttonLabel` exactly as given. Pass
52801
+ * `placement: 'kyc'` when the screen sits inside the step that starts
52802
+ * identity verification. Document URLs are absolute.
52698
52803
  *
52699
- * Forward `presentationId`, `copySha256`, the presented `items[].type` and
52700
- * the short-lived `submissionToken` (15 minutes, this presentation only) to
52701
- * the user's client. That client sends `POST /v1/agreements/acceptances`
52702
- * itself, with `Authorization: Bearer <submissionToken>` and body
52703
- * `{ presentationId, accept, copySha256 }`. Spritz refuses an acceptance sent
52804
+ * Forward `presentationId`, `screenSha256`, the presented `items[].type`
52805
+ * and the short-lived `submissionToken` (15 minutes, this presentation
52806
+ * only) to the user's client. That client sends
52807
+ * `POST /v1/agreements/acceptances` itself, with
52808
+ * `Authorization: Bearer <submissionToken>` and body
52809
+ * `{ presentationId, accept, screenSha256 }`, plus
52810
+ * `esignCheckboxChecked: true` exactly when `screen.checkbox` is present.
52811
+ * `accept` lists every presented type. Spritz refuses an acceptance sent
52704
52812
  * from your backend, including one sent from the network that created the
52705
52813
  * presentation (`403 client_submission_required`), so this SDK does not
52706
- * make that request. Under the default `clickwrap` pattern, `accept` must
52707
- * list every presented type.
52814
+ * make that request.
52708
52815
  *
52709
52816
  * Throws a `RateLimitError` with `problem.code ===
52710
52817
  * 'agreement_presentation_rate_limited'` after ten presentations for one user
@@ -54665,8 +54772,9 @@ declare class DepositService {
54665
54772
  preparationId: string;
54666
54773
  kind: "deposit_authorization";
54667
54774
  expiresAt: string;
54668
- messageVersion: "v1" | "fomo_v1";
54775
+ messageVersion: "v1" | "fomo_v1" | "fomo_v2";
54669
54776
  message: string;
54777
+ authorizationStatement: string;
54670
54778
  submissionToken?: string;
54671
54779
  summary: {
54672
54780
  quoteType: "exact_input" | "exact_output";
@@ -55109,8 +55217,9 @@ declare class SandboxService {
55109
55217
  preparationId: string;
55110
55218
  kind: "deposit_authorization";
55111
55219
  expiresAt: string;
55112
- messageVersion: "v1" | "fomo_v1";
55220
+ messageVersion: "v1" | "fomo_v1" | "fomo_v2";
55113
55221
  message: string;
55222
+ authorizationStatement: string;
55114
55223
  submissionToken?: string;
55115
55224
  summary: {
55116
55225
  quoteType: "exact_input" | "exact_output";
@@ -56586,4 +56695,4 @@ declare function hasProblemCode<T extends string>(error: unknown, code: T): erro
56586
56695
  };
56587
56696
 
56588
56697
  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 };
56589
- 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 };
56698
+ 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.25.0",
3
+ "version": "0.27.0",
4
4
  "packageManager": "yarn@1.22.22",
5
5
  "description": "Typescript library for interacting with the Spritz Finance API",
6
6
  "type": "module",