@spritz-finance/api-client 0.17.0 → 0.18.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.
@@ -678,6 +678,26 @@ interface paths {
678
678
  patch?: never;
679
679
  trace?: never;
680
680
  };
681
+ "/v1/ach-debit/eligibility": {
682
+ parameters: {
683
+ query?: never;
684
+ header?: never;
685
+ path?: never;
686
+ cookie?: never;
687
+ };
688
+ get?: never;
689
+ put?: never;
690
+ /**
691
+ * Check ACH debit eligibility
692
+ * @description Once an email is eligible, it remains eligible. A false response may be transient, so re-check rather than caching it. Call this endpoint before showing a bank deposit option. Once the user exists, the capabilities returned by GET /v1/users/me remain the source of truth.
693
+ */
694
+ post: operations["postV1Ach-debitEligibility"];
695
+ delete?: never;
696
+ options?: never;
697
+ head?: never;
698
+ patch?: never;
699
+ trace?: never;
700
+ };
681
701
  "/v1/bank-accounts/link-token": {
682
702
  parameters: {
683
703
  query?: never;
@@ -3963,7 +3983,7 @@ interface operations {
3963
3983
  /**
3964
3984
  * Format: date-time
3965
3985
  * @description Creation timestamp
3966
- * @example 2026-09-16T17:08:54.978Z
3986
+ * @example 2026-09-17T18:15:20.160Z
3967
3987
  */
3968
3988
  createdAt?: string;
3969
3989
  }[];
@@ -4128,7 +4148,7 @@ interface operations {
4128
4148
  "application/json": {
4129
4149
  /**
4130
4150
  * @description Destination account ID
4131
- * @example 6aaacd26ca4e09cadce93883
4151
+ * @example 6aac2e387c3e374d463764d7
4132
4152
  */
4133
4153
  accountId: string;
4134
4154
  /**
@@ -4156,7 +4176,7 @@ interface operations {
4156
4176
  "application/x-www-form-urlencoded": {
4157
4177
  /**
4158
4178
  * @description Destination account ID
4159
- * @example 6aaacd26ca4e09cadce93883
4179
+ * @example 6aac2e387c3e374d463764d7
4160
4180
  */
4161
4181
  accountId: string;
4162
4182
  /**
@@ -4184,7 +4204,7 @@ interface operations {
4184
4204
  "multipart/form-data": {
4185
4205
  /**
4186
4206
  * @description Destination account ID
4187
- * @example 6aaacd26ca4e09cadce93883
4207
+ * @example 6aac2e387c3e374d463764d7
4188
4208
  */
4189
4209
  accountId: string;
4190
4210
  /**
@@ -4231,7 +4251,7 @@ interface operations {
4231
4251
  /**
4232
4252
  * Format: date-time
4233
4253
  * @description When the quote was created
4234
- * @example 2026-09-16T17:08:54.956Z
4254
+ * @example 2026-09-17T18:15:20.141Z
4235
4255
  */
4236
4256
  createdAt: string;
4237
4257
  /** @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. */
@@ -4270,7 +4290,7 @@ interface operations {
4270
4290
  rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
4271
4291
  /**
4272
4292
  * @description Destination account ID
4273
- * @example 6aaacd26ca4e09cadce93884
4293
+ * @example 6aac2e387c3e374d463764d8
4274
4294
  */
4275
4295
  accountId: string;
4276
4296
  /** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
@@ -4527,7 +4547,7 @@ interface operations {
4527
4547
  /**
4528
4548
  * Format: date-time
4529
4549
  * @description When the quote was created
4530
- * @example 2026-09-16T17:08:54.956Z
4550
+ * @example 2026-09-17T18:15:20.141Z
4531
4551
  */
4532
4552
  createdAt: string;
4533
4553
  /** @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. */
@@ -4566,7 +4586,7 @@ interface operations {
4566
4586
  rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
4567
4587
  /**
4568
4588
  * @description Destination account ID
4569
- * @example 6aaacd26ca4e09cadce93884
4589
+ * @example 6aac2e387c3e374d463764d8
4570
4590
  */
4571
4591
  accountId: string;
4572
4592
  /** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
@@ -5162,7 +5182,7 @@ interface operations {
5162
5182
  /**
5163
5183
  * Format: date-time
5164
5184
  * @description When the quote was created
5165
- * @example 2026-09-16T17:08:54.956Z
5185
+ * @example 2026-09-17T18:15:20.141Z
5166
5186
  */
5167
5187
  createdAt: string;
5168
5188
  /** @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. */
@@ -5201,7 +5221,7 @@ interface operations {
5201
5221
  rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
5202
5222
  /**
5203
5223
  * @description Destination account ID
5204
- * @example 6aaacd26ca4e09cadce93884
5224
+ * @example 6aac2e387c3e374d463764d8
5205
5225
  */
5206
5226
  accountId: string;
5207
5227
  /** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
@@ -5504,7 +5524,7 @@ interface operations {
5504
5524
  currency: string;
5505
5525
  /**
5506
5526
  * @description Destination account ID
5507
- * @example 6aaacd26ca4e09cadce93885
5527
+ * @example 6aac2e387c3e374d463764d9
5508
5528
  */
5509
5529
  accountId: string;
5510
5530
  /**
@@ -5795,7 +5815,7 @@ interface operations {
5795
5815
  currency: string;
5796
5816
  /**
5797
5817
  * @description Destination account ID
5798
- * @example 6aaacd26ca4e09cadce93885
5818
+ * @example 6aac2e387c3e374d463764d9
5799
5819
  */
5800
5820
  accountId: string;
5801
5821
  /**
@@ -6036,7 +6056,7 @@ interface operations {
6036
6056
  method: "account";
6037
6057
  /**
6038
6058
  * @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
6039
- * @example 6aaacd26ca4e09cadce93886
6059
+ * @example 6aac2e387c3e374d463764da
6040
6060
  */
6041
6061
  accountId?: string;
6042
6062
  };
@@ -6054,7 +6074,7 @@ interface operations {
6054
6074
  method: "account";
6055
6075
  /**
6056
6076
  * @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
6057
- * @example 6aaacd26ca4e09cadce93886
6077
+ * @example 6aac2e387c3e374d463764da
6058
6078
  */
6059
6079
  accountId?: string;
6060
6080
  };
@@ -6072,7 +6092,7 @@ interface operations {
6072
6092
  method: "account";
6073
6093
  /**
6074
6094
  * @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
6075
- * @example 6aaacd26ca4e09cadce93886
6095
+ * @example 6aac2e387c3e374d463764da
6076
6096
  */
6077
6097
  accountId?: string;
6078
6098
  };
@@ -6138,7 +6158,7 @@ interface operations {
6138
6158
  currency: string;
6139
6159
  /**
6140
6160
  * @description Destination account ID
6141
- * @example 6aaacd26ca4e09cadce93885
6161
+ * @example 6aac2e387c3e374d463764d9
6142
6162
  */
6143
6163
  accountId: string;
6144
6164
  /**
@@ -11850,8 +11870,13 @@ interface operations {
11850
11870
  kind: "deposit_authorization";
11851
11871
  /** Format: date-time */
11852
11872
  expiresAt: string;
11853
- /** @enum {string} */
11854
- messageVersion: "v1";
11873
+ /**
11874
+ * @description Identifies the authorization template that produced `message`. Spritz selects it server-side from the integrator; clients cannot request one. Display `message` verbatim and submit the preparation unchanged.
11875
+ * @default v1
11876
+ * @example v1
11877
+ * @enum {string}
11878
+ */
11879
+ messageVersion: "v1" | "fomo_v1";
11855
11880
  /** @description Display-ready ACH authorization message */
11856
11881
  message: string;
11857
11882
  /**
@@ -12973,6 +12998,237 @@ interface operations {
12973
12998
  };
12974
12999
  };
12975
13000
  };
13001
+ "postV1Ach-debitEligibility": {
13002
+ parameters: {
13003
+ query?: never;
13004
+ header?: never;
13005
+ path?: never;
13006
+ cookie?: never;
13007
+ };
13008
+ requestBody: {
13009
+ content: {
13010
+ "application/json": {
13011
+ /**
13012
+ * Format: email
13013
+ * @description Email address of the prospective Spritz user
13014
+ * @example user@example.com
13015
+ */
13016
+ email: string;
13017
+ };
13018
+ "application/x-www-form-urlencoded": {
13019
+ /**
13020
+ * Format: email
13021
+ * @description Email address of the prospective Spritz user
13022
+ * @example user@example.com
13023
+ */
13024
+ email: string;
13025
+ };
13026
+ "multipart/form-data": {
13027
+ /**
13028
+ * Format: email
13029
+ * @description Email address of the prospective Spritz user
13030
+ * @example user@example.com
13031
+ */
13032
+ email: string;
13033
+ };
13034
+ };
13035
+ };
13036
+ responses: {
13037
+ /** @description Response for status 200 */
13038
+ 200: {
13039
+ headers: {
13040
+ [name: string]: unknown;
13041
+ };
13042
+ content: {
13043
+ "application/json": {
13044
+ /** @description Whether the bank deposit option is available for this email address */
13045
+ eligible: boolean;
13046
+ };
13047
+ };
13048
+ };
13049
+ /** @description Response for status 400 */
13050
+ 400: {
13051
+ headers: {
13052
+ [name: string]: unknown;
13053
+ };
13054
+ content: {
13055
+ "application/problem+json": {
13056
+ /**
13057
+ * @description A URI reference that identifies the problem type
13058
+ * @default about:blank
13059
+ * @example urn:problem-type:auth:unauthorized
13060
+ */
13061
+ type: string;
13062
+ /**
13063
+ * @description A short, human-readable summary of the problem type
13064
+ * @example Unauthorized
13065
+ */
13066
+ title: string;
13067
+ /**
13068
+ * @description The HTTP status code
13069
+ * @example 400
13070
+ */
13071
+ status: number;
13072
+ /** @description A human-readable explanation specific to this occurrence */
13073
+ detail?: string;
13074
+ /**
13075
+ * @description A URI reference that identifies the specific occurrence
13076
+ * @example /errors/1234567890
13077
+ */
13078
+ instance?: string;
13079
+ /**
13080
+ * @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.
13081
+ * @example transaction_limit
13082
+ */
13083
+ code?: string;
13084
+ /**
13085
+ * @description The offending request field, present alongside `code`.
13086
+ * @example amountUsd
13087
+ */
13088
+ field?: string;
13089
+ /**
13090
+ * @description Whether retrying the same request later may succeed without changing its inputs.
13091
+ * @example true
13092
+ */
13093
+ retryable?: boolean;
13094
+ /**
13095
+ * @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.
13096
+ * @example 5
13097
+ */
13098
+ retryAfter?: number;
13099
+ /** @enum {string} */
13100
+ suggestedAction?: "auto_ramp" | "wait_for_settlement";
13101
+ /**
13102
+ * Format: date-time
13103
+ * @description Earliest known time the current temporary condition may clear.
13104
+ */
13105
+ clearsAt?: string | null;
13106
+ /**
13107
+ * Format: date-time
13108
+ * @description When a temporarily ineligible funding source may become available again.
13109
+ */
13110
+ availableAt?: string | null;
13111
+ /** @description Whether the current funding-source restriction will not clear automatically. */
13112
+ permanent?: boolean;
13113
+ } & {
13114
+ [key: string]: unknown;
13115
+ };
13116
+ };
13117
+ };
13118
+ /** @description Response for status 401 */
13119
+ 401: {
13120
+ headers: {
13121
+ [name: string]: unknown;
13122
+ };
13123
+ content: {
13124
+ "application/problem+json": {
13125
+ /**
13126
+ * @description A URI reference that identifies the problem type
13127
+ * @default about:blank
13128
+ * @example urn:problem-type:auth:unauthorized
13129
+ */
13130
+ type: string;
13131
+ /**
13132
+ * @description A short, human-readable summary of the problem type
13133
+ * @example Unauthorized
13134
+ */
13135
+ title: string;
13136
+ /**
13137
+ * @description The HTTP status code
13138
+ * @example 401
13139
+ */
13140
+ status: number;
13141
+ /**
13142
+ * @description A human-readable explanation specific to this occurrence
13143
+ * @example Bearer token required
13144
+ */
13145
+ detail?: string;
13146
+ /** @description A URI reference that identifies the specific occurrence */
13147
+ instance?: string;
13148
+ /**
13149
+ * @description The authentication realm
13150
+ * @example API
13151
+ */
13152
+ realm?: string;
13153
+ /**
13154
+ * @description The required scope for this resource
13155
+ * @example read:users
13156
+ */
13157
+ scope?: string;
13158
+ };
13159
+ };
13160
+ };
13161
+ /** @description Response for status 500 */
13162
+ 500: {
13163
+ headers: {
13164
+ [name: string]: unknown;
13165
+ };
13166
+ content: {
13167
+ "application/problem+json": {
13168
+ /**
13169
+ * @description A URI reference that identifies the problem type
13170
+ * @default about:blank
13171
+ * @example urn:problem-type:auth:unauthorized
13172
+ */
13173
+ type: string;
13174
+ /**
13175
+ * @description A short, human-readable summary of the problem type
13176
+ * @example Unauthorized
13177
+ */
13178
+ title: string;
13179
+ /**
13180
+ * @description The HTTP status code
13181
+ * @example 400
13182
+ */
13183
+ status: number;
13184
+ /** @description A human-readable explanation specific to this occurrence */
13185
+ detail?: string;
13186
+ /**
13187
+ * @description A URI reference that identifies the specific occurrence
13188
+ * @example /errors/1234567890
13189
+ */
13190
+ instance?: string;
13191
+ /**
13192
+ * @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.
13193
+ * @example transaction_limit
13194
+ */
13195
+ code?: string;
13196
+ /**
13197
+ * @description The offending request field, present alongside `code`.
13198
+ * @example amountUsd
13199
+ */
13200
+ field?: string;
13201
+ /**
13202
+ * @description Whether retrying the same request later may succeed without changing its inputs.
13203
+ * @example true
13204
+ */
13205
+ retryable?: boolean;
13206
+ /**
13207
+ * @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.
13208
+ * @example 5
13209
+ */
13210
+ retryAfter?: number;
13211
+ /** @enum {string} */
13212
+ suggestedAction?: "auto_ramp" | "wait_for_settlement";
13213
+ /**
13214
+ * Format: date-time
13215
+ * @description Earliest known time the current temporary condition may clear.
13216
+ */
13217
+ clearsAt?: string | null;
13218
+ /**
13219
+ * Format: date-time
13220
+ * @description When a temporarily ineligible funding source may become available again.
13221
+ */
13222
+ availableAt?: string | null;
13223
+ /** @description Whether the current funding-source restriction will not clear automatically. */
13224
+ permanent?: boolean;
13225
+ } & {
13226
+ [key: string]: unknown;
13227
+ };
13228
+ };
13229
+ };
13230
+ };
13231
+ };
12976
13232
  "postV1Bank-accountsLink-token": {
12977
13233
  parameters: {
12978
13234
  query?: never;
@@ -17661,7 +17917,7 @@ interface operations {
17661
17917
  data: {
17662
17918
  /**
17663
17919
  * @description Unique identifier for the debit card
17664
- * @example 6aaacd26ca4e09cadce9388a
17920
+ * @example 6aac2e387c3e374d463764de
17665
17921
  */
17666
17922
  id: string;
17667
17923
  /** @enum {string} */
@@ -18109,7 +18365,7 @@ interface operations {
18109
18365
  "application/json": {
18110
18366
  /**
18111
18367
  * @description Unique identifier for the debit card
18112
- * @example 6aaacd26ca4e09cadce9388a
18368
+ * @example 6aac2e387c3e374d463764de
18113
18369
  */
18114
18370
  id: string;
18115
18371
  /** @enum {string} */
@@ -18326,7 +18582,7 @@ interface operations {
18326
18582
  "application/json": {
18327
18583
  /**
18328
18584
  * @description Unique identifier for the debit card
18329
- * @example 6aaacd26ca4e09cadce9388a
18585
+ * @example 6aac2e387c3e374d463764de
18330
18586
  */
18331
18587
  id: string;
18332
18588
  /** @enum {string} */
@@ -18847,7 +19103,7 @@ interface operations {
18847
19103
  "application/json": {
18848
19104
  /**
18849
19105
  * @description Unique identifier for the debit card
18850
- * @example 6aaacd26ca4e09cadce9388a
19106
+ * @example 6aac2e387c3e374d463764de
18851
19107
  */
18852
19108
  id: string;
18853
19109
  /** @enum {string} */
@@ -20030,7 +20286,7 @@ interface operations {
20030
20286
  accessToken: string;
20031
20287
  /**
20032
20288
  * @description The internal ID of the authorized user
20033
- * @example 6aaacd27ca4e09cadce9388e
20289
+ * @example 6aac2e387c3e374d463764e2
20034
20290
  */
20035
20291
  userId: string;
20036
20292
  /**
@@ -20046,7 +20302,7 @@ interface operations {
20046
20302
  /**
20047
20303
  * Format: date-time
20048
20304
  * @description ISO 8601 timestamp when token expires
20049
- * @example 2026-09-16T18:08:55.457Z
20305
+ * @example 2026-09-17T19:15:20.442Z
20050
20306
  */
20051
20307
  expiresAt: string;
20052
20308
  };
@@ -20245,7 +20501,7 @@ interface operations {
20245
20501
  /**
20246
20502
  * Format: date-time
20247
20503
  * @description ISO 8601 timestamp of when the integrator was created
20248
- * @example 2026-09-16T17:08:55.457Z
20504
+ * @example 2026-09-17T18:15:20.442Z
20249
20505
  */
20250
20506
  createdAt: string;
20251
20507
  };
@@ -20458,7 +20714,7 @@ interface operations {
20458
20714
  "application/json": {
20459
20715
  /**
20460
20716
  * @description The internal ID of the newly created user
20461
- * @example 6aaacd27ca4e09cadce93890
20717
+ * @example 6aac2e387c3e374d463764e4
20462
20718
  */
20463
20719
  userId: string;
20464
20720
  /**
@@ -20802,7 +21058,7 @@ interface operations {
20802
21058
  depositId: string;
20803
21059
  /**
20804
21060
  * @description Spritz user ID associated with the returned deposit
20805
- * @example 6aaacd27ca4e09cadce9388d
21061
+ * @example 6aac2e387c3e374d463764e1
20806
21062
  */
20807
21063
  userId: string;
20808
21064
  /**
@@ -21014,7 +21270,7 @@ interface operations {
21014
21270
  depositId: string;
21015
21271
  /**
21016
21272
  * @description Spritz user ID associated with the returned deposit
21017
- * @example 6aaacd27ca4e09cadce9388d
21273
+ * @example 6aac2e387c3e374d463764e1
21018
21274
  */
21019
21275
  userId: string;
21020
21276
  /**
@@ -21207,7 +21463,7 @@ interface operations {
21207
21463
  "application/json": {
21208
21464
  /**
21209
21465
  * @description Unique identifier for the webhook
21210
- * @example 6aaacd27ca4e09cadce9388f
21466
+ * @example 6aac2e387c3e374d463764e3
21211
21467
  */
21212
21468
  id: string;
21213
21469
  /** @description List of event types this webhook is subscribed to */
@@ -21438,7 +21694,7 @@ interface operations {
21438
21694
  "application/json": {
21439
21695
  /**
21440
21696
  * @description Unique identifier for the webhook
21441
- * @example 6aaacd27ca4e09cadce9388f
21697
+ * @example 6aac2e387c3e374d463764e3
21442
21698
  */
21443
21699
  id: string;
21444
21700
  /** @description List of event types this webhook is subscribed to */
@@ -23406,7 +23662,7 @@ interface operations {
23406
23662
  "application/json": {
23407
23663
  /**
23408
23664
  * @description Unique identifier for the webhook
23409
- * @example 6aaacd27ca4e09cadce9388f
23665
+ * @example 6aac2e387c3e374d463764e3
23410
23666
  */
23411
23667
  id: string;
23412
23668
  /** @description List of event types this webhook is subscribed to */
@@ -23823,7 +24079,7 @@ interface operations {
23823
24079
  /**
23824
24080
  * Format: date-time
23825
24081
  * @description ISO 8601 timestamp when the old secret will expire. Only present if a grace period was specified.
23826
- * @example 2026-09-16T17:13:55.458Z
24082
+ * @example 2026-09-17T18:20:20.443Z
23827
24083
  */
23828
24084
  oldSecretExpiresAt?: string;
23829
24085
  };
@@ -23994,7 +24250,7 @@ interface operations {
23994
24250
  "application/json": {
23995
24251
  /**
23996
24252
  * @description Unique identifier for the user
23997
- * @example 6aaacd27ca4e09cadce9388b
24253
+ * @example 6aac2e387c3e374d463764df
23998
24254
  */
23999
24255
  id: string;
24000
24256
  /**
@@ -24011,7 +24267,7 @@ interface operations {
24011
24267
  /**
24012
24268
  * Format: date-time
24013
24269
  * @description ISO 8601 timestamp of when the user was created
24014
- * @example 2026-09-16T17:08:55.388Z
24270
+ * @example 2026-09-17T18:15:20.434Z
24015
24271
  */
24016
24272
  signedUpAt: string;
24017
24273
  /**
@@ -24383,7 +24639,7 @@ interface operations {
24383
24639
  "application/json": {
24384
24640
  /**
24385
24641
  * @description Unique identifier for the user
24386
- * @example 6aaacd27ca4e09cadce9388b
24642
+ * @example 6aac2e387c3e374d463764df
24387
24643
  */
24388
24644
  id: string;
24389
24645
  /**
@@ -24400,7 +24656,7 @@ interface operations {
24400
24656
  /**
24401
24657
  * Format: date-time
24402
24658
  * @description ISO 8601 timestamp of when the user was created
24403
- * @example 2026-09-16T17:08:55.388Z
24659
+ * @example 2026-09-17T18:15:20.434Z
24404
24660
  */
24405
24661
  signedUpAt: string;
24406
24662
  /**
@@ -24872,7 +25128,7 @@ interface operations {
24872
25128
  "application/json": {
24873
25129
  /**
24874
25130
  * @description Unique identifier for the user
24875
- * @example 6aaacd27ca4e09cadce9388b
25131
+ * @example 6aac2e387c3e374d463764df
24876
25132
  */
24877
25133
  id: string;
24878
25134
  /**
@@ -24889,7 +25145,7 @@ interface operations {
24889
25145
  /**
24890
25146
  * Format: date-time
24891
25147
  * @description ISO 8601 timestamp of when the user was created
24892
- * @example 2026-09-16T17:08:55.388Z
25148
+ * @example 2026-09-17T18:15:20.434Z
24893
25149
  */
24894
25150
  signedUpAt: string;
24895
25151
  /**
@@ -35254,8 +35510,13 @@ interface operations {
35254
35510
  kind: "deposit_authorization";
35255
35511
  /** Format: date-time */
35256
35512
  expiresAt: string;
35257
- /** @enum {string} */
35258
- messageVersion: "v1";
35513
+ /**
35514
+ * @description Identifies the authorization template that produced `message`. Spritz selects it server-side from the integrator; clients cannot request one. Display `message` verbatim and submit the preparation unchanged.
35515
+ * @default v1
35516
+ * @example v1
35517
+ * @enum {string}
35518
+ */
35519
+ messageVersion: "v1" | "fomo_v1";
35259
35520
  /** @description Display-ready ACH authorization message */
35260
35521
  message: string;
35261
35522
  /**
@@ -39782,6 +40043,31 @@ declare class SpritzClient {
39782
40043
  private makeStatusError;
39783
40044
  }
39784
40045
 
40046
+ type AchDebitEligibilityRequest = PathRequestBody<'/v1/ach-debit/eligibility', 'post'>;
40047
+ type AchDebitEligibilityResponse = PathResponse<'/v1/ach-debit/eligibility', 'post'>;
40048
+ declare class AchDebitService {
40049
+ private client;
40050
+ constructor(client: SpritzClient);
40051
+ /**
40052
+ * Checks whether the bank deposit option can be offered for an email address.
40053
+ *
40054
+ * Call this before showing a bank deposit option to someone who is not yet a
40055
+ * Spritz user. The route authenticates as the integrator (HMAC) and takes no
40056
+ * user bearer key, because the address it asks about need not belong to an
40057
+ * existing user.
40058
+ *
40059
+ * Eligibility only ever moves in one direction: once an address is eligible
40060
+ * it stays eligible. `eligible: false` may be transient, so re-check rather
40061
+ * than caching it against the address.
40062
+ *
40063
+ * Once the user exists, this is no longer the right question to ask — the
40064
+ * capabilities on `GET /v1/users/me` become the source of truth.
40065
+ */
40066
+ checkEligibility(input: AchDebitEligibilityRequest): Promise<{
40067
+ eligible: boolean;
40068
+ }>;
40069
+ }
40070
+
39785
40071
  type AchDebitReturnListResponse = PathResponse<'/v1/integrator/ach-debit/returns', 'get'>;
39786
40072
  type AchDebitReturn = AchDebitReturnListResponse['data'][number];
39787
40073
  type AchDebitReturnListQuery = PathQuery<'/v1/integrator/ach-debit/returns', 'get'>;
@@ -41658,7 +41944,7 @@ declare class DepositService {
41658
41944
  preparationId: string;
41659
41945
  kind: "deposit_authorization";
41660
41946
  expiresAt: string;
41661
- messageVersion: "v1";
41947
+ messageVersion: "v1" | "fomo_v1";
41662
41948
  message: string;
41663
41949
  submissionToken?: string;
41664
41950
  summary: {
@@ -42697,6 +42983,7 @@ declare class SpritzApiClient {
42697
42983
  bankAccount: BankAccountService;
42698
42984
  debitCard: DebitCardService;
42699
42985
  deposit: DepositService;
42986
+ achDebit: AchDebitService;
42700
42987
  achDebitReturn: AchDebitReturnService;
42701
42988
  fundingSource: FundingSourceService;
42702
42989
  paymentRequest: PaymentRequestService;
@@ -42865,4 +43152,4 @@ declare function hasProblemCode<T extends string>(error: unknown, code: T): erro
42865
43152
  };
42866
43153
 
42867
43154
  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 };
42868
- export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, 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, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, CreateBankAccountInput, CreateBankAccountResponse, CreateDepositOptions, CreateDepositRequest, CreateDepositWithReturnRequest, CreateDepositWithReturnResponse, CreateDirectPaymentInput, 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, DepositListQuery, DepositListResponse, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkTokenResponse, 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, ProblemDetails, ProblemFieldError, ProblemSuggestedAction, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, 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 };
43155
+ export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitEligibilityRequest, AchDebitEligibilityResponse, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, 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, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, CreateBankAccountInput, CreateBankAccountResponse, CreateDepositOptions, CreateDepositRequest, CreateDepositWithReturnRequest, CreateDepositWithReturnResponse, CreateDirectPaymentInput, 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, DepositListQuery, DepositListResponse, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkTokenResponse, 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, ProblemDetails, ProblemFieldError, ProblemSuggestedAction, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, 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 };