@spritz-finance/api-client 0.15.0 → 0.16.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.
@@ -649,7 +649,7 @@ interface paths {
649
649
  put?: never;
650
650
  /**
651
651
  * Prepare a direct deposit authorization
652
- * @description Creates the canonical ACH authorization message for a deposit targeting a raw wallet address. Authorization is derived from the verified ACH funding source; no wallet signature is required.
652
+ * @description Creates the canonical ACH authorization message for a deposit targeting a raw wallet address. Integrators can include the public client IP their edge observed to receive a short-lived submissionToken for direct client submission. During migration, an integrator can omit clientNetwork and submit through its HMAC-authenticated backend by including clientIp on create. Authorization is derived from the verified ACH funding source; no wallet signature is required.
653
653
  */
654
654
  post: operations["postV1DepositsDirectPrepare"];
655
655
  delete?: never;
@@ -669,7 +669,7 @@ interface paths {
669
669
  put?: never;
670
670
  /**
671
671
  * Create a direct deposit
672
- * @description Authorizes and creates a deposit against a raw wallet address prepared via /direct/prepare. Authorization is derived from the verified ACH funding source; no wallet signature is required. Idempotency-Key is required; reuse the same key and body after a timeout to recover the original response without creating another deposit.
672
+ * @description Authorizes and creates a deposit against a raw wallet address prepared via /direct/prepare. Integrators should send the preparation's short-lived submissionToken to the authorizing client and call this endpoint directly from that client; the capability can submit only its bound preparation. During migration, integrators can continue submitting with HMAC backend authentication but must include the public clientIp observed by their edge. Authorization is derived from the verified ACH funding source; no wallet signature is required. Idempotency-Key is required; reuse the same key and body after a timeout to recover the original response without creating another deposit.
673
673
  */
674
674
  post: operations["postV1DepositsDirect"];
675
675
  delete?: never;
@@ -1210,6 +1210,26 @@ interface paths {
1210
1210
  patch: operations["patchV1Debit-cardsByCardIdCardholder-info"];
1211
1211
  trace?: never;
1212
1212
  };
1213
+ "/v1/connect/sessions/{sessionId}/return": {
1214
+ parameters: {
1215
+ query?: never;
1216
+ header?: never;
1217
+ path?: never;
1218
+ cookie?: never;
1219
+ };
1220
+ get?: never;
1221
+ put?: never;
1222
+ /**
1223
+ * Return from an unfinished connect session
1224
+ * @description Ends a pending session without granting access. Requires the scoped returnToken delivered in the authorization URL fragment; a session ID alone grants no authority. Sign-in is not required. The token expires 15 minutes after creation, including a five-minute grace period after consent expires. Invalid or expired tokens return 404. Returns only the registered callback with its original state and a server-selected error. Retries preserve the first terminal outcome. Approved sessions return 409.
1225
+ */
1226
+ post: operations["postV1ConnectSessionsBySessionIdReturn"];
1227
+ delete?: never;
1228
+ options?: never;
1229
+ head?: never;
1230
+ patch?: never;
1231
+ trace?: never;
1232
+ };
1213
1233
  "/v1/integrator/connect/sessions": {
1214
1234
  parameters: {
1215
1235
  query?: never;
@@ -1353,7 +1373,7 @@ interface paths {
1353
1373
  *
1354
1374
  * The response includes the user's API key (`ak_...`), which is returned only once at creation - store it securely.
1355
1375
  *
1356
- * **Conflict**: If a user with the given email already exists, the request fails with `409 Conflict`. In that case, use Spritz Connect (`POST /v1/integrator/connect/sessions`) to have the existing user authorize this integrator.
1376
+ * **Conflict**: If a user with the given email already exists, the request fails with `409 Conflict`. In that case, use Spritz Connect (`POST /v1/integrator/connect/sessions`) to have the existing user authorize this integrator. A concurrent request to create a user with the same email also returns `409 Conflict`; retry shortly.
1357
1377
  */
1358
1378
  post: operations["postV1IntegratorUsers"];
1359
1379
  delete?: never;
@@ -1643,7 +1663,7 @@ interface paths {
1643
1663
  put?: never;
1644
1664
  /**
1645
1665
  * Create, resume, or retry an identity verification session
1646
- * @description Creates or resumes the authenticated user's Persona identity verification session without requesting an implicit enhanced upgrade, or starts a new inquiry when a failed verification is retryable. Check GET /v1/users/me: verification.status=retry and identity_verification requirements with retryable=true indicate eligibility. Overlapping REST session requests for the same user return 409 Conflict while a request is in progress. Retry the same POST after the first request completes. Temporary provider unavailability returns 503 VERIFICATION_TEMPORARILY_UNAVAILABLE with retryAfter (seconds). URLs and tokens may expire and are retrieved just in time. Returns 409 VERIFICATION_NOT_RETRYABLE for a permanent failure, VERIFICATION_UNDER_REVIEW while review is pending, VERIFICATION_ALREADY_VERIFIED when verified with no pending verification, or VERIFICATION_SESSION_UNAVAILABLE when unavailable. An existing pending step-up remains resumable; this call does not initiate a new step-up for an already verified user.
1666
+ * @description Creates or resumes the authenticated user's Persona identity verification session without requesting an implicit enhanced upgrade, or starts a new inquiry when a failed verification is retryable. Check GET /v1/users/me: verification.status=retry and identity_verification requirements with retryable=true indicate eligibility. Overlapping REST session requests for the same user return 409 Conflict while a request is in progress. Retry the same POST after the first request completes. Temporary provider unavailability returns 503 VERIFICATION_TEMPORARILY_UNAVAILABLE with retryAfter (seconds). URLs and tokens may expire and are retrieved just in time. Returns 409 VERIFICATION_NOT_RETRYABLE for a permanent failure, VERIFICATION_UNDER_REVIEW while review is pending, VERIFICATION_ALREADY_VERIFIED when verified with no pending verification, or VERIFICATION_SESSION_UNAVAILABLE when unavailable or an interrupted retry requires support reconciliation. An interrupted retry with a saved Persona idempotency key or inquiry ID resumes that inquiry and completes pending event delivery on a subsequent POST; creation that is still ambiguous after 23 hours returns VERIFICATION_SESSION_UNAVAILABLE instead of starting another inquiry. An existing pending step-up remains resumable; this call does not initiate a new step-up for an already verified user.
1647
1667
  */
1648
1668
  post: operations["postV1UsersMeVerification-sessions"];
1649
1669
  delete?: never;
@@ -3943,7 +3963,7 @@ interface operations {
3943
3963
  /**
3944
3964
  * Format: date-time
3945
3965
  * @description Creation timestamp
3946
- * @example 2026-09-14T21:03:08.629Z
3966
+ * @example 2026-09-16T17:08:54.978Z
3947
3967
  */
3948
3968
  createdAt?: string;
3949
3969
  }[];
@@ -4108,7 +4128,7 @@ interface operations {
4108
4128
  "application/json": {
4109
4129
  /**
4110
4130
  * @description Destination account ID
4111
- * @example 6aa8610c7b1776d095a9389b
4131
+ * @example 6aaacd26ca4e09cadce93883
4112
4132
  */
4113
4133
  accountId: string;
4114
4134
  /**
@@ -4136,7 +4156,7 @@ interface operations {
4136
4156
  "application/x-www-form-urlencoded": {
4137
4157
  /**
4138
4158
  * @description Destination account ID
4139
- * @example 6aa8610c7b1776d095a9389b
4159
+ * @example 6aaacd26ca4e09cadce93883
4140
4160
  */
4141
4161
  accountId: string;
4142
4162
  /**
@@ -4164,7 +4184,7 @@ interface operations {
4164
4184
  "multipart/form-data": {
4165
4185
  /**
4166
4186
  * @description Destination account ID
4167
- * @example 6aa8610c7b1776d095a9389b
4187
+ * @example 6aaacd26ca4e09cadce93883
4168
4188
  */
4169
4189
  accountId: string;
4170
4190
  /**
@@ -4211,7 +4231,7 @@ interface operations {
4211
4231
  /**
4212
4232
  * Format: date-time
4213
4233
  * @description When the quote was created
4214
- * @example 2026-09-14T21:03:08.611Z
4234
+ * @example 2026-09-16T17:08:54.956Z
4215
4235
  */
4216
4236
  createdAt: string;
4217
4237
  /** @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. */
@@ -4250,7 +4270,7 @@ interface operations {
4250
4270
  rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
4251
4271
  /**
4252
4272
  * @description Destination account ID
4253
- * @example 6aa8610c7b1776d095a9389c
4273
+ * @example 6aaacd26ca4e09cadce93884
4254
4274
  */
4255
4275
  accountId: string;
4256
4276
  /** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
@@ -4507,7 +4527,7 @@ interface operations {
4507
4527
  /**
4508
4528
  * Format: date-time
4509
4529
  * @description When the quote was created
4510
- * @example 2026-09-14T21:03:08.611Z
4530
+ * @example 2026-09-16T17:08:54.956Z
4511
4531
  */
4512
4532
  createdAt: string;
4513
4533
  /** @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. */
@@ -4546,7 +4566,7 @@ interface operations {
4546
4566
  rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
4547
4567
  /**
4548
4568
  * @description Destination account ID
4549
- * @example 6aa8610c7b1776d095a9389c
4569
+ * @example 6aaacd26ca4e09cadce93884
4550
4570
  */
4551
4571
  accountId: string;
4552
4572
  /** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
@@ -5142,7 +5162,7 @@ interface operations {
5142
5162
  /**
5143
5163
  * Format: date-time
5144
5164
  * @description When the quote was created
5145
- * @example 2026-09-14T21:03:08.611Z
5165
+ * @example 2026-09-16T17:08:54.956Z
5146
5166
  */
5147
5167
  createdAt: string;
5148
5168
  /** @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. */
@@ -5181,7 +5201,7 @@ interface operations {
5181
5201
  rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
5182
5202
  /**
5183
5203
  * @description Destination account ID
5184
- * @example 6aa8610c7b1776d095a9389c
5204
+ * @example 6aaacd26ca4e09cadce93884
5185
5205
  */
5186
5206
  accountId: string;
5187
5207
  /** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
@@ -5484,7 +5504,7 @@ interface operations {
5484
5504
  currency: string;
5485
5505
  /**
5486
5506
  * @description Destination account ID
5487
- * @example 6aa8610c7b1776d095a9389d
5507
+ * @example 6aaacd26ca4e09cadce93885
5488
5508
  */
5489
5509
  accountId: string;
5490
5510
  /**
@@ -5775,7 +5795,7 @@ interface operations {
5775
5795
  currency: string;
5776
5796
  /**
5777
5797
  * @description Destination account ID
5778
- * @example 6aa8610c7b1776d095a9389d
5798
+ * @example 6aaacd26ca4e09cadce93885
5779
5799
  */
5780
5800
  accountId: string;
5781
5801
  /**
@@ -6016,7 +6036,7 @@ interface operations {
6016
6036
  method: "account";
6017
6037
  /**
6018
6038
  * @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
6019
- * @example 6aa8610c7b1776d095a9389e
6039
+ * @example 6aaacd26ca4e09cadce93886
6020
6040
  */
6021
6041
  accountId?: string;
6022
6042
  };
@@ -6034,7 +6054,7 @@ interface operations {
6034
6054
  method: "account";
6035
6055
  /**
6036
6056
  * @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
6037
- * @example 6aa8610c7b1776d095a9389e
6057
+ * @example 6aaacd26ca4e09cadce93886
6038
6058
  */
6039
6059
  accountId?: string;
6040
6060
  };
@@ -6052,7 +6072,7 @@ interface operations {
6052
6072
  method: "account";
6053
6073
  /**
6054
6074
  * @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
6055
- * @example 6aa8610c7b1776d095a9389e
6075
+ * @example 6aaacd26ca4e09cadce93886
6056
6076
  */
6057
6077
  accountId?: string;
6058
6078
  };
@@ -6118,7 +6138,7 @@ interface operations {
6118
6138
  currency: string;
6119
6139
  /**
6120
6140
  * @description Destination account ID
6121
- * @example 6aa8610c7b1776d095a9389d
6141
+ * @example 6aaacd26ca4e09cadce93885
6122
6142
  */
6123
6143
  accountId: string;
6124
6144
  /**
@@ -7584,6 +7604,7 @@ interface operations {
7584
7604
  * @description Payment rails available for this account
7585
7605
  * @example [
7586
7606
  * "ach_standard",
7607
+ * "ach_same_day",
7587
7608
  * "rtp"
7588
7609
  * ]
7589
7610
  */
@@ -7667,6 +7688,7 @@ interface operations {
7667
7688
  * @description Payment rails available for this account
7668
7689
  * @example [
7669
7690
  * "ach_standard",
7691
+ * "ach_same_day",
7670
7692
  * "rtp"
7671
7693
  * ]
7672
7694
  */
@@ -7755,6 +7777,7 @@ interface operations {
7755
7777
  * @description Payment rails available for this account
7756
7778
  * @example [
7757
7779
  * "ach_standard",
7780
+ * "ach_same_day",
7758
7781
  * "rtp"
7759
7782
  * ]
7760
7783
  */
@@ -7832,6 +7855,7 @@ interface operations {
7832
7855
  * @description Payment rails available for this account
7833
7856
  * @example [
7834
7857
  * "ach_standard",
7858
+ * "ach_same_day",
7835
7859
  * "rtp"
7836
7860
  * ]
7837
7861
  */
@@ -8820,6 +8844,7 @@ interface operations {
8820
8844
  * @description Payment rails available for this account
8821
8845
  * @example [
8822
8846
  * "ach_standard",
8847
+ * "ach_same_day",
8823
8848
  * "rtp"
8824
8849
  * ]
8825
8850
  */
@@ -8903,6 +8928,7 @@ interface operations {
8903
8928
  * @description Payment rails available for this account
8904
8929
  * @example [
8905
8930
  * "ach_standard",
8931
+ * "ach_same_day",
8906
8932
  * "rtp"
8907
8933
  * ]
8908
8934
  */
@@ -8991,6 +9017,7 @@ interface operations {
8991
9017
  * @description Payment rails available for this account
8992
9018
  * @example [
8993
9019
  * "ach_standard",
9020
+ * "ach_same_day",
8994
9021
  * "rtp"
8995
9022
  * ]
8996
9023
  */
@@ -9068,6 +9095,7 @@ interface operations {
9068
9095
  * @description Payment rails available for this account
9069
9096
  * @example [
9070
9097
  * "ach_standard",
9098
+ * "ach_same_day",
9071
9099
  * "rtp"
9072
9100
  * ]
9073
9101
  */
@@ -9316,6 +9344,7 @@ interface operations {
9316
9344
  * @description Payment rails available for this account
9317
9345
  * @example [
9318
9346
  * "ach_standard",
9347
+ * "ach_same_day",
9319
9348
  * "rtp"
9320
9349
  * ]
9321
9350
  */
@@ -9399,6 +9428,7 @@ interface operations {
9399
9428
  * @description Payment rails available for this account
9400
9429
  * @example [
9401
9430
  * "ach_standard",
9431
+ * "ach_same_day",
9402
9432
  * "rtp"
9403
9433
  * ]
9404
9434
  */
@@ -9487,6 +9517,7 @@ interface operations {
9487
9517
  * @description Payment rails available for this account
9488
9518
  * @example [
9489
9519
  * "ach_standard",
9520
+ * "ach_same_day",
9490
9521
  * "rtp"
9491
9522
  * ]
9492
9523
  */
@@ -9564,6 +9595,7 @@ interface operations {
9564
9595
  * @description Payment rails available for this account
9565
9596
  * @example [
9566
9597
  * "ach_standard",
9598
+ * "ach_same_day",
9567
9599
  * "rtp"
9568
9600
  * ]
9569
9601
  */
@@ -11702,6 +11734,16 @@ interface operations {
11702
11734
  percentage: number;
11703
11735
  maxAmountUsd?: string;
11704
11736
  };
11737
+ clientNetwork?: {
11738
+ /**
11739
+ * @description Public IP addresses observed by the integrator edge for the authorizing client. Include at most one IPv4 and one IPv6 address. When provided by an integrator, the response includes a submissionToken and the addresses are matched against the later direct client submission.
11740
+ * @example [
11741
+ * "1.1.1.1",
11742
+ * "2606:4700:4700::1111"
11743
+ * ]
11744
+ */
11745
+ ipAddresses: string[];
11746
+ };
11705
11747
  };
11706
11748
  "application/x-www-form-urlencoded": {
11707
11749
  /**
@@ -11735,6 +11777,16 @@ interface operations {
11735
11777
  percentage: number;
11736
11778
  maxAmountUsd?: string;
11737
11779
  };
11780
+ clientNetwork?: {
11781
+ /**
11782
+ * @description Public IP addresses observed by the integrator edge for the authorizing client. Include at most one IPv4 and one IPv6 address. When provided by an integrator, the response includes a submissionToken and the addresses are matched against the later direct client submission.
11783
+ * @example [
11784
+ * "1.1.1.1",
11785
+ * "2606:4700:4700::1111"
11786
+ * ]
11787
+ */
11788
+ ipAddresses: string[];
11789
+ };
11738
11790
  };
11739
11791
  "multipart/form-data": {
11740
11792
  /**
@@ -11768,6 +11820,16 @@ interface operations {
11768
11820
  percentage: number;
11769
11821
  maxAmountUsd?: string;
11770
11822
  };
11823
+ clientNetwork?: {
11824
+ /**
11825
+ * @description Public IP addresses observed by the integrator edge for the authorizing client. Include at most one IPv4 and one IPv6 address. When provided by an integrator, the response includes a submissionToken and the addresses are matched against the later direct client submission.
11826
+ * @example [
11827
+ * "1.1.1.1",
11828
+ * "2606:4700:4700::1111"
11829
+ * ]
11830
+ */
11831
+ ipAddresses: string[];
11832
+ };
11771
11833
  };
11772
11834
  };
11773
11835
  };
@@ -11792,6 +11854,11 @@ interface operations {
11792
11854
  messageVersion: "v1";
11793
11855
  /** @description Display-ready ACH authorization message */
11794
11856
  message: string;
11857
+ /**
11858
+ * @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.
11859
+ * @example ach_submit_eyJhbGciOiJIUzI1NiJ9...
11860
+ */
11861
+ submissionToken?: string;
11795
11862
  summary: {
11796
11863
  /** @enum {string} */
11797
11864
  quoteType: "exact_input" | "exact_output";
@@ -12284,6 +12351,11 @@ interface operations {
12284
12351
  * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
12285
12352
  */
12286
12353
  preparationId: string;
12354
+ /**
12355
+ * @description Public client IP observed by the integrator edge. Required when an integrator submits through its backend with HMAC authentication; omit for direct submission with a submissionToken.
12356
+ * @example 1.1.1.1
12357
+ */
12358
+ clientIp?: string;
12287
12359
  };
12288
12360
  "application/x-www-form-urlencoded": {
12289
12361
  /**
@@ -12291,6 +12363,11 @@ interface operations {
12291
12363
  * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
12292
12364
  */
12293
12365
  preparationId: string;
12366
+ /**
12367
+ * @description Public client IP observed by the integrator edge. Required when an integrator submits through its backend with HMAC authentication; omit for direct submission with a submissionToken.
12368
+ * @example 1.1.1.1
12369
+ */
12370
+ clientIp?: string;
12294
12371
  };
12295
12372
  "multipart/form-data": {
12296
12373
  /**
@@ -12298,6 +12375,11 @@ interface operations {
12298
12375
  * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
12299
12376
  */
12300
12377
  preparationId: string;
12378
+ /**
12379
+ * @description Public client IP observed by the integrator edge. Required when an integrator submits through its backend with HMAC authentication; omit for direct submission with a submissionToken.
12380
+ * @example 1.1.1.1
12381
+ */
12382
+ clientIp?: string;
12301
12383
  };
12302
12384
  };
12303
12385
  };
@@ -13145,6 +13227,7 @@ interface operations {
13145
13227
  * @description Payment rails available for this account
13146
13228
  * @example [
13147
13229
  * "ach_standard",
13230
+ * "ach_same_day",
13148
13231
  * "rtp"
13149
13232
  * ]
13150
13233
  */
@@ -13228,6 +13311,7 @@ interface operations {
13228
13311
  * @description Payment rails available for this account
13229
13312
  * @example [
13230
13313
  * "ach_standard",
13314
+ * "ach_same_day",
13231
13315
  * "rtp"
13232
13316
  * ]
13233
13317
  */
@@ -13316,6 +13400,7 @@ interface operations {
13316
13400
  * @description Payment rails available for this account
13317
13401
  * @example [
13318
13402
  * "ach_standard",
13403
+ * "ach_same_day",
13319
13404
  * "rtp"
13320
13405
  * ]
13321
13406
  */
@@ -13393,6 +13478,7 @@ interface operations {
13393
13478
  * @description Payment rails available for this account
13394
13479
  * @example [
13395
13480
  * "ach_standard",
13481
+ * "ach_same_day",
13396
13482
  * "rtp"
13397
13483
  * ]
13398
13484
  */
@@ -17575,7 +17661,7 @@ interface operations {
17575
17661
  data: {
17576
17662
  /**
17577
17663
  * @description Unique identifier for the debit card
17578
- * @example 6aa8610c7b1776d095a938a2
17664
+ * @example 6aaacd26ca4e09cadce9388a
17579
17665
  */
17580
17666
  id: string;
17581
17667
  /** @enum {string} */
@@ -18023,7 +18109,7 @@ interface operations {
18023
18109
  "application/json": {
18024
18110
  /**
18025
18111
  * @description Unique identifier for the debit card
18026
- * @example 6aa8610c7b1776d095a938a2
18112
+ * @example 6aaacd26ca4e09cadce9388a
18027
18113
  */
18028
18114
  id: string;
18029
18115
  /** @enum {string} */
@@ -18240,7 +18326,7 @@ interface operations {
18240
18326
  "application/json": {
18241
18327
  /**
18242
18328
  * @description Unique identifier for the debit card
18243
- * @example 6aa8610c7b1776d095a938a2
18329
+ * @example 6aaacd26ca4e09cadce9388a
18244
18330
  */
18245
18331
  id: string;
18246
18332
  /** @enum {string} */
@@ -18761,7 +18847,7 @@ interface operations {
18761
18847
  "application/json": {
18762
18848
  /**
18763
18849
  * @description Unique identifier for the debit card
18764
- * @example 6aa8610c7b1776d095a938a2
18850
+ * @example 6aaacd26ca4e09cadce9388a
18765
18851
  */
18766
18852
  id: string;
18767
18853
  /** @enum {string} */
@@ -18958,6 +19044,267 @@ interface operations {
18958
19044
  };
18959
19045
  };
18960
19046
  };
19047
+ postV1ConnectSessionsBySessionIdReturn: {
19048
+ parameters: {
19049
+ query?: never;
19050
+ header?: never;
19051
+ path: {
19052
+ sessionId: string;
19053
+ };
19054
+ cookie?: never;
19055
+ };
19056
+ requestBody: {
19057
+ content: {
19058
+ "application/json": {
19059
+ /** @description Scoped return capability from the authorization URL fragment. */
19060
+ returnToken: string;
19061
+ /** @enum {string} */
19062
+ reason: "cancelled" | "failed";
19063
+ };
19064
+ "application/x-www-form-urlencoded": {
19065
+ /** @description Scoped return capability from the authorization URL fragment. */
19066
+ returnToken: string;
19067
+ /** @enum {string} */
19068
+ reason: "cancelled" | "failed";
19069
+ };
19070
+ "multipart/form-data": {
19071
+ /** @description Scoped return capability from the authorization URL fragment. */
19072
+ returnToken: string;
19073
+ /** @enum {string} */
19074
+ reason: "cancelled" | "failed";
19075
+ };
19076
+ };
19077
+ };
19078
+ responses: {
19079
+ /** @description Response for status 200 */
19080
+ 200: {
19081
+ headers: {
19082
+ [name: string]: unknown;
19083
+ };
19084
+ content: {
19085
+ "application/json": {
19086
+ callbackUri: string;
19087
+ /** @enum {string} */
19088
+ error: "access_denied" | "server_error" | "session_expired";
19089
+ };
19090
+ };
19091
+ };
19092
+ /** @description Response for status 401 */
19093
+ 401: {
19094
+ headers: {
19095
+ [name: string]: unknown;
19096
+ };
19097
+ content: {
19098
+ "application/problem+json": {
19099
+ /**
19100
+ * @description A URI reference that identifies the problem type
19101
+ * @default about:blank
19102
+ * @example urn:problem-type:auth:unauthorized
19103
+ */
19104
+ type: string;
19105
+ /**
19106
+ * @description A short, human-readable summary of the problem type
19107
+ * @example Unauthorized
19108
+ */
19109
+ title: string;
19110
+ /**
19111
+ * @description The HTTP status code
19112
+ * @example 401
19113
+ */
19114
+ status: number;
19115
+ /**
19116
+ * @description A human-readable explanation specific to this occurrence
19117
+ * @example Bearer token required
19118
+ */
19119
+ detail?: string;
19120
+ /** @description A URI reference that identifies the specific occurrence */
19121
+ instance?: string;
19122
+ /**
19123
+ * @description The authentication realm
19124
+ * @example API
19125
+ */
19126
+ realm?: string;
19127
+ /**
19128
+ * @description The required scope for this resource
19129
+ * @example read:users
19130
+ */
19131
+ scope?: string;
19132
+ };
19133
+ };
19134
+ };
19135
+ /** @description Response for status 404 */
19136
+ 404: {
19137
+ headers: {
19138
+ [name: string]: unknown;
19139
+ };
19140
+ content: {
19141
+ "application/problem+json": {
19142
+ /**
19143
+ * @description A URI reference that identifies the problem type
19144
+ * @default about:blank
19145
+ */
19146
+ type: string;
19147
+ /** @description A short, human-readable summary of the problem type */
19148
+ title: string;
19149
+ /**
19150
+ * @description The HTTP status code
19151
+ * @example 404
19152
+ */
19153
+ status: number;
19154
+ /** @description A human-readable explanation specific to this occurrence */
19155
+ detail?: string;
19156
+ /** @description A URI reference that identifies the specific occurrence */
19157
+ instance?: string;
19158
+ /**
19159
+ * @description The type of resource that was not found
19160
+ * @example user
19161
+ */
19162
+ resourceType: string;
19163
+ /** @description The identifier of the resource that was not found */
19164
+ resourceId: string;
19165
+ };
19166
+ };
19167
+ };
19168
+ /** @description Response for status 409 */
19169
+ 409: {
19170
+ headers: {
19171
+ [name: string]: unknown;
19172
+ };
19173
+ content: {
19174
+ "application/problem+json": {
19175
+ /**
19176
+ * @description A URI reference that identifies the problem type
19177
+ * @default about:blank
19178
+ * @example urn:problem-type:auth:unauthorized
19179
+ */
19180
+ type: string;
19181
+ /**
19182
+ * @description A short, human-readable summary of the problem type
19183
+ * @example Unauthorized
19184
+ */
19185
+ title: string;
19186
+ /**
19187
+ * @description The HTTP status code
19188
+ * @example 400
19189
+ */
19190
+ status: number;
19191
+ /** @description A human-readable explanation specific to this occurrence */
19192
+ detail?: string;
19193
+ /**
19194
+ * @description A URI reference that identifies the specific occurrence
19195
+ * @example /errors/1234567890
19196
+ */
19197
+ instance?: string;
19198
+ /**
19199
+ * @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.
19200
+ * @example transaction_limit
19201
+ */
19202
+ code?: string;
19203
+ /**
19204
+ * @description The offending request field, present alongside `code`.
19205
+ * @example amountUsd
19206
+ */
19207
+ field?: string;
19208
+ /**
19209
+ * @description Whether retrying the same request later may succeed without changing its inputs.
19210
+ * @example true
19211
+ */
19212
+ retryable?: boolean;
19213
+ /**
19214
+ * @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.
19215
+ * @example 5
19216
+ */
19217
+ retryAfter?: number;
19218
+ /** @enum {string} */
19219
+ suggestedAction?: "auto_ramp" | "wait_for_settlement";
19220
+ /**
19221
+ * Format: date-time
19222
+ * @description Earliest known time the current temporary condition may clear.
19223
+ */
19224
+ clearsAt?: string | null;
19225
+ /**
19226
+ * Format: date-time
19227
+ * @description When a temporarily ineligible funding source may become available again.
19228
+ */
19229
+ availableAt?: string | null;
19230
+ /** @description Whether the current funding-source restriction will not clear automatically. */
19231
+ permanent?: boolean;
19232
+ } & {
19233
+ [key: string]: unknown;
19234
+ };
19235
+ };
19236
+ };
19237
+ /** @description Response for status 500 */
19238
+ 500: {
19239
+ headers: {
19240
+ [name: string]: unknown;
19241
+ };
19242
+ content: {
19243
+ "application/problem+json": {
19244
+ /**
19245
+ * @description A URI reference that identifies the problem type
19246
+ * @default about:blank
19247
+ * @example urn:problem-type:auth:unauthorized
19248
+ */
19249
+ type: string;
19250
+ /**
19251
+ * @description A short, human-readable summary of the problem type
19252
+ * @example Unauthorized
19253
+ */
19254
+ title: string;
19255
+ /**
19256
+ * @description The HTTP status code
19257
+ * @example 400
19258
+ */
19259
+ status: number;
19260
+ /** @description A human-readable explanation specific to this occurrence */
19261
+ detail?: string;
19262
+ /**
19263
+ * @description A URI reference that identifies the specific occurrence
19264
+ * @example /errors/1234567890
19265
+ */
19266
+ instance?: string;
19267
+ /**
19268
+ * @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.
19269
+ * @example transaction_limit
19270
+ */
19271
+ code?: string;
19272
+ /**
19273
+ * @description The offending request field, present alongside `code`.
19274
+ * @example amountUsd
19275
+ */
19276
+ field?: string;
19277
+ /**
19278
+ * @description Whether retrying the same request later may succeed without changing its inputs.
19279
+ * @example true
19280
+ */
19281
+ retryable?: boolean;
19282
+ /**
19283
+ * @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.
19284
+ * @example 5
19285
+ */
19286
+ retryAfter?: number;
19287
+ /** @enum {string} */
19288
+ suggestedAction?: "auto_ramp" | "wait_for_settlement";
19289
+ /**
19290
+ * Format: date-time
19291
+ * @description Earliest known time the current temporary condition may clear.
19292
+ */
19293
+ clearsAt?: string | null;
19294
+ /**
19295
+ * Format: date-time
19296
+ * @description When a temporarily ineligible funding source may become available again.
19297
+ */
19298
+ availableAt?: string | null;
19299
+ /** @description Whether the current funding-source restriction will not clear automatically. */
19300
+ permanent?: boolean;
19301
+ } & {
19302
+ [key: string]: unknown;
19303
+ };
19304
+ };
19305
+ };
19306
+ };
19307
+ };
18961
19308
  postV1IntegratorConnectSessions: {
18962
19309
  parameters: {
18963
19310
  query?: never;
@@ -19683,7 +20030,7 @@ interface operations {
19683
20030
  accessToken: string;
19684
20031
  /**
19685
20032
  * @description The internal ID of the authorized user
19686
- * @example 6aa8610c7b1776d095a938a6
20033
+ * @example 6aaacd27ca4e09cadce9388e
19687
20034
  */
19688
20035
  userId: string;
19689
20036
  /**
@@ -19699,7 +20046,7 @@ interface operations {
19699
20046
  /**
19700
20047
  * Format: date-time
19701
20048
  * @description ISO 8601 timestamp when token expires
19702
- * @example 2026-09-14T22:03:08.919Z
20049
+ * @example 2026-09-16T18:08:55.457Z
19703
20050
  */
19704
20051
  expiresAt: string;
19705
20052
  };
@@ -19898,7 +20245,7 @@ interface operations {
19898
20245
  /**
19899
20246
  * Format: date-time
19900
20247
  * @description ISO 8601 timestamp of when the integrator was created
19901
- * @example 2026-09-14T21:03:08.919Z
20248
+ * @example 2026-09-16T17:08:55.457Z
19902
20249
  */
19903
20250
  createdAt: string;
19904
20251
  };
@@ -20111,7 +20458,7 @@ interface operations {
20111
20458
  "application/json": {
20112
20459
  /**
20113
20460
  * @description The internal ID of the newly created user
20114
- * @example 6aa8610c7b1776d095a938a8
20461
+ * @example 6aaacd27ca4e09cadce93890
20115
20462
  */
20116
20463
  userId: string;
20117
20464
  /**
@@ -20342,6 +20689,75 @@ interface operations {
20342
20689
  };
20343
20690
  };
20344
20691
  };
20692
+ /** @description Response for status 503 */
20693
+ 503: {
20694
+ headers: {
20695
+ [name: string]: unknown;
20696
+ };
20697
+ content: {
20698
+ "application/problem+json": {
20699
+ /**
20700
+ * @description A URI reference that identifies the problem type
20701
+ * @default about:blank
20702
+ * @example urn:problem-type:auth:unauthorized
20703
+ */
20704
+ type: string;
20705
+ /**
20706
+ * @description A short, human-readable summary of the problem type
20707
+ * @example Unauthorized
20708
+ */
20709
+ title: string;
20710
+ /**
20711
+ * @description The HTTP status code
20712
+ * @example 400
20713
+ */
20714
+ status: number;
20715
+ /** @description A human-readable explanation specific to this occurrence */
20716
+ detail?: string;
20717
+ /**
20718
+ * @description A URI reference that identifies the specific occurrence
20719
+ * @example /errors/1234567890
20720
+ */
20721
+ instance?: string;
20722
+ /**
20723
+ * @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.
20724
+ * @example transaction_limit
20725
+ */
20726
+ code?: string;
20727
+ /**
20728
+ * @description The offending request field, present alongside `code`.
20729
+ * @example amountUsd
20730
+ */
20731
+ field?: string;
20732
+ /**
20733
+ * @description Whether retrying the same request later may succeed without changing its inputs.
20734
+ * @example true
20735
+ */
20736
+ retryable?: boolean;
20737
+ /**
20738
+ * @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.
20739
+ * @example 5
20740
+ */
20741
+ retryAfter?: number;
20742
+ /** @enum {string} */
20743
+ suggestedAction?: "auto_ramp" | "wait_for_settlement";
20744
+ /**
20745
+ * Format: date-time
20746
+ * @description Earliest known time the current temporary condition may clear.
20747
+ */
20748
+ clearsAt?: string | null;
20749
+ /**
20750
+ * Format: date-time
20751
+ * @description When a temporarily ineligible funding source may become available again.
20752
+ */
20753
+ availableAt?: string | null;
20754
+ /** @description Whether the current funding-source restriction will not clear automatically. */
20755
+ permanent?: boolean;
20756
+ } & {
20757
+ [key: string]: unknown;
20758
+ };
20759
+ };
20760
+ };
20345
20761
  };
20346
20762
  };
20347
20763
  "getV1IntegratorAch-debitReturns": {
@@ -20386,7 +20802,7 @@ interface operations {
20386
20802
  depositId: string;
20387
20803
  /**
20388
20804
  * @description Spritz user ID associated with the returned deposit
20389
- * @example 6aa8610c7b1776d095a938a5
20805
+ * @example 6aaacd27ca4e09cadce9388d
20390
20806
  */
20391
20807
  userId: string;
20392
20808
  /**
@@ -20598,7 +21014,7 @@ interface operations {
20598
21014
  depositId: string;
20599
21015
  /**
20600
21016
  * @description Spritz user ID associated with the returned deposit
20601
- * @example 6aa8610c7b1776d095a938a5
21017
+ * @example 6aaacd27ca4e09cadce9388d
20602
21018
  */
20603
21019
  userId: string;
20604
21020
  /**
@@ -20791,7 +21207,7 @@ interface operations {
20791
21207
  "application/json": {
20792
21208
  /**
20793
21209
  * @description Unique identifier for the webhook
20794
- * @example 6aa8610c7b1776d095a938a7
21210
+ * @example 6aaacd27ca4e09cadce9388f
20795
21211
  */
20796
21212
  id: string;
20797
21213
  /** @description List of event types this webhook is subscribed to */
@@ -21022,7 +21438,7 @@ interface operations {
21022
21438
  "application/json": {
21023
21439
  /**
21024
21440
  * @description Unique identifier for the webhook
21025
- * @example 6aa8610c7b1776d095a938a7
21441
+ * @example 6aaacd27ca4e09cadce9388f
21026
21442
  */
21027
21443
  id: string;
21028
21444
  /** @description List of event types this webhook is subscribed to */
@@ -22990,7 +23406,7 @@ interface operations {
22990
23406
  "application/json": {
22991
23407
  /**
22992
23408
  * @description Unique identifier for the webhook
22993
- * @example 6aa8610c7b1776d095a938a7
23409
+ * @example 6aaacd27ca4e09cadce9388f
22994
23410
  */
22995
23411
  id: string;
22996
23412
  /** @description List of event types this webhook is subscribed to */
@@ -23407,7 +23823,7 @@ interface operations {
23407
23823
  /**
23408
23824
  * Format: date-time
23409
23825
  * @description ISO 8601 timestamp when the old secret will expire. Only present if a grace period was specified.
23410
- * @example 2026-09-14T21:08:08.920Z
23826
+ * @example 2026-09-16T17:13:55.458Z
23411
23827
  */
23412
23828
  oldSecretExpiresAt?: string;
23413
23829
  };
@@ -23578,7 +23994,7 @@ interface operations {
23578
23994
  "application/json": {
23579
23995
  /**
23580
23996
  * @description Unique identifier for the user
23581
- * @example 6aa8610c7b1776d095a938a3
23997
+ * @example 6aaacd27ca4e09cadce9388b
23582
23998
  */
23583
23999
  id: string;
23584
24000
  /**
@@ -23595,7 +24011,7 @@ interface operations {
23595
24011
  /**
23596
24012
  * Format: date-time
23597
24013
  * @description ISO 8601 timestamp of when the user was created
23598
- * @example 2026-09-14T21:03:08.911Z
24014
+ * @example 2026-09-16T17:08:55.388Z
23599
24015
  */
23600
24016
  signedUpAt: string;
23601
24017
  /**
@@ -23967,7 +24383,7 @@ interface operations {
23967
24383
  "application/json": {
23968
24384
  /**
23969
24385
  * @description Unique identifier for the user
23970
- * @example 6aa8610c7b1776d095a938a3
24386
+ * @example 6aaacd27ca4e09cadce9388b
23971
24387
  */
23972
24388
  id: string;
23973
24389
  /**
@@ -23984,7 +24400,7 @@ interface operations {
23984
24400
  /**
23985
24401
  * Format: date-time
23986
24402
  * @description ISO 8601 timestamp of when the user was created
23987
- * @example 2026-09-14T21:03:08.911Z
24403
+ * @example 2026-09-16T17:08:55.388Z
23988
24404
  */
23989
24405
  signedUpAt: string;
23990
24406
  /**
@@ -24456,7 +24872,7 @@ interface operations {
24456
24872
  "application/json": {
24457
24873
  /**
24458
24874
  * @description Unique identifier for the user
24459
- * @example 6aa8610c7b1776d095a938a3
24875
+ * @example 6aaacd27ca4e09cadce9388b
24460
24876
  */
24461
24877
  id: string;
24462
24878
  /**
@@ -24473,7 +24889,7 @@ interface operations {
24473
24889
  /**
24474
24890
  * Format: date-time
24475
24891
  * @description ISO 8601 timestamp of when the user was created
24476
- * @example 2026-09-14T21:03:08.911Z
24892
+ * @example 2026-09-16T17:08:55.388Z
24477
24893
  */
24478
24894
  signedUpAt: string;
24479
24895
  /**
@@ -34695,6 +35111,16 @@ interface operations {
34695
35111
  percentage: number;
34696
35112
  maxAmountUsd?: string;
34697
35113
  };
35114
+ clientNetwork?: {
35115
+ /**
35116
+ * @description Public IP addresses observed by the integrator edge for the authorizing client. Include at most one IPv4 and one IPv6 address. When provided by an integrator, the response includes a submissionToken and the addresses are matched against the later direct client submission.
35117
+ * @example [
35118
+ * "1.1.1.1",
35119
+ * "2606:4700:4700::1111"
35120
+ * ]
35121
+ */
35122
+ ipAddresses: string[];
35123
+ };
34698
35124
  programControlSimulation: {
34699
35125
  /**
34700
35126
  * @description Sandbox-only program state to evaluate through the normal deposit policy gate.
@@ -34737,6 +35163,16 @@ interface operations {
34737
35163
  percentage: number;
34738
35164
  maxAmountUsd?: string;
34739
35165
  };
35166
+ clientNetwork?: {
35167
+ /**
35168
+ * @description Public IP addresses observed by the integrator edge for the authorizing client. Include at most one IPv4 and one IPv6 address. When provided by an integrator, the response includes a submissionToken and the addresses are matched against the later direct client submission.
35169
+ * @example [
35170
+ * "1.1.1.1",
35171
+ * "2606:4700:4700::1111"
35172
+ * ]
35173
+ */
35174
+ ipAddresses: string[];
35175
+ };
34740
35176
  programControlSimulation: {
34741
35177
  /**
34742
35178
  * @description Sandbox-only program state to evaluate through the normal deposit policy gate.
@@ -34779,6 +35215,16 @@ interface operations {
34779
35215
  percentage: number;
34780
35216
  maxAmountUsd?: string;
34781
35217
  };
35218
+ clientNetwork?: {
35219
+ /**
35220
+ * @description Public IP addresses observed by the integrator edge for the authorizing client. Include at most one IPv4 and one IPv6 address. When provided by an integrator, the response includes a submissionToken and the addresses are matched against the later direct client submission.
35221
+ * @example [
35222
+ * "1.1.1.1",
35223
+ * "2606:4700:4700::1111"
35224
+ * ]
35225
+ */
35226
+ ipAddresses: string[];
35227
+ };
34782
35228
  programControlSimulation: {
34783
35229
  /**
34784
35230
  * @description Sandbox-only program state to evaluate through the normal deposit policy gate.
@@ -34812,6 +35258,11 @@ interface operations {
34812
35258
  messageVersion: "v1";
34813
35259
  /** @description Display-ready ACH authorization message */
34814
35260
  message: string;
35261
+ /**
35262
+ * @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.
35263
+ * @example ach_submit_eyJhbGciOiJIUzI1NiJ9...
35264
+ */
35265
+ submissionToken?: string;
34815
35266
  summary: {
34816
35267
  /** @enum {string} */
34817
35268
  quoteType: "exact_input" | "exact_output";
@@ -36830,6 +37281,7 @@ interface operations {
36830
37281
  * @description Payment rails available for this account
36831
37282
  * @example [
36832
37283
  * "ach_standard",
37284
+ * "ach_same_day",
36833
37285
  * "rtp"
36834
37286
  * ]
36835
37287
  */
@@ -36913,6 +37365,7 @@ interface operations {
36913
37365
  * @description Payment rails available for this account
36914
37366
  * @example [
36915
37367
  * "ach_standard",
37368
+ * "ach_same_day",
36916
37369
  * "rtp"
36917
37370
  * ]
36918
37371
  */
@@ -37001,6 +37454,7 @@ interface operations {
37001
37454
  * @description Payment rails available for this account
37002
37455
  * @example [
37003
37456
  * "ach_standard",
37457
+ * "ach_same_day",
37004
37458
  * "rtp"
37005
37459
  * ]
37006
37460
  */
@@ -37078,6 +37532,7 @@ interface operations {
37078
37532
  * @description Payment rails available for this account
37079
37533
  * @example [
37080
37534
  * "ach_standard",
37535
+ * "ach_same_day",
37081
37536
  * "rtp"
37082
37537
  * ]
37083
37538
  */
@@ -39266,6 +39721,14 @@ declare class SpritzClient {
39266
39721
  path: string;
39267
39722
  body?: Request | undefined;
39268
39723
  }): Promise<Response>;
39724
+ /**
39725
+ * Whether REST requests are signed as a backend integrator.
39726
+ *
39727
+ * Mirrors the exact condition `sendRestApiRequest` stamps on, so a service
39728
+ * can tell which of the API's authentication modes its call will use when
39729
+ * the contract requires different fields for each.
39730
+ */
39731
+ get usesIntegratorAuth(): boolean;
39269
39732
  restApi<P extends RestPath, M extends RestMethod<P>>(route: RestRoute<P, M>): Promise<PathResponse<P, M>>;
39270
39733
  restApi<Response, Request = unknown>({ method, path, body, query, headers, }: {
39271
39734
  method: HttpMethod;
@@ -41177,12 +41640,27 @@ type CreateDepositOptions = {
41177
41640
  declare class DepositService {
41178
41641
  private client;
41179
41642
  constructor(client: SpritzClient);
41643
+ /**
41644
+ * Prepares a deposit authorization quote.
41645
+ *
41646
+ * Pass `clientNetwork.ipAddresses` — the public addresses your edge observed
41647
+ * for the authorizing client, at most one IPv4 and one IPv6 — to receive a
41648
+ * short-lived `submissionToken` on the response. Forward that token to the
41649
+ * authorizing client so it can submit `POST /v1/deposits/direct` itself; the
41650
+ * token is bound to this preparation and can submit nothing else. The
41651
+ * addresses are matched against that later submission.
41652
+ *
41653
+ * Omitting `clientNetwork` keeps the migration path: no `submissionToken` is
41654
+ * issued and the deposit must be created from your backend, which then has
41655
+ * to send `clientIp` (see `create`).
41656
+ */
41180
41657
  prepare(input: PrepareDepositRequest): Promise<{
41181
41658
  preparationId: string;
41182
41659
  kind: "deposit_authorization";
41183
41660
  expiresAt: string;
41184
41661
  messageVersion: "v1";
41185
41662
  message: string;
41663
+ submissionToken?: string;
41186
41664
  summary: {
41187
41665
  quoteType: "exact_input" | "exact_output";
41188
41666
  requestedAmountUsd: string;
@@ -41213,6 +41691,22 @@ declare class DepositService {
41213
41691
  destinationAddress: string;
41214
41692
  };
41215
41693
  }>;
41694
+ /**
41695
+ * Creates the prepared deposit.
41696
+ *
41697
+ * **`clientIp` is required when calling this from your backend over
41698
+ * integrator HMAC auth**, even though the generated type marks it optional —
41699
+ * see `assertClientIpForIntegratorCreate` for why the contract has to keep
41700
+ * it optional across the route's other authentication modes. Pass the public
41701
+ * address your edge observed for the authorizing client; it must be a public
41702
+ * IP and must differ from the submitting backend's own address, or the
41703
+ * create is rejected before risk evaluation. When this client is configured
41704
+ * with integrator HMAC credentials, `create` throws before sending if
41705
+ * `clientIp` is missing.
41706
+ *
41707
+ * Integrator JWT is not accepted on this route because it cannot bind the
41708
+ * claimed `clientIp`; it remains valid on `prepare` and the read methods.
41709
+ */
41216
41710
  create(input: CreateDepositRequest, options: CreateDepositOptions): Promise<{
41217
41711
  id: string;
41218
41712
  sourceId: string;