@spritz-finance/api-client 0.27.0 → 0.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/spritz-api-client.d.ts +120 -42
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1361,7 +1361,7 @@ ACH onramp lets users convert USD from their bank account into USDC delivered to
|
|
|
1361
1361
|
3. **Server:** complete linking with `client.bankAccount.completeLinking(...)`
|
|
1362
1362
|
4. **Server:** find an active funding source and fetch limits with `client.fundingSource.getDepositLimits(id)`
|
|
1363
1363
|
5. **Server:** prepare a quote with `client.deposit.prepare(...)`
|
|
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
|
|
1364
|
+
6. **Client:** show the quote and ACH authorization `message` to the user. If your UI lays out the amounts from `summary` itself, show `authorizationStatement` word for word instead. That's only allowed when `messageVersion` is `fomo_v2` or `fomo_v4`; for any other version, show `message` in full
|
|
1365
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
|
|
1366
1366
|
8. **Server:** track the deposit with `client.deposit.get(depositId)`, or reconcile a backlog by paging `client.deposit.list({ limit, cursor })`
|
|
1367
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))
|
|
@@ -1398,6 +1398,8 @@ To move submission onto the customer's device, pass `clientNetwork: { ipAddresse
|
|
|
1398
1398
|
|
|
1399
1399
|
If risk checks block the create step, the API returns 409 before any ACH debit is pulled. Prepare a new quote before retrying; blocked create attempts consume the original `preparationId`.
|
|
1400
1400
|
|
|
1401
|
+
When a `priority: 'high'` preparation can get no instant portion at create, the deposit goes ahead at standard timing by default. Send `instantFallback: 'confirm'` to ask the user first: `create` then throws a `ConflictError` with `problem.code === 'instant_unavailable'` and leaves the preparation usable. Once the user accepts standard timing, call `create` again with the same `preparationId`, `instantFallback: 'standard'` and a new idempotency key. See [Confirming a fallback from instant](docs/ach-onramp-guide.md#confirming-a-fallback-from-instant).
|
|
1402
|
+
|
|
1401
1403
|
For a complete walkthrough with code examples, request/response schemas, and deposit lifecycle documentation, see the **[ACH Onramp Integration Guide](docs/ach-onramp-guide.md)**.
|
|
1402
1404
|
|
|
1403
1405
|
A standalone sandbox demo is available at `scripts/sandbox/ach-onramp.html`. Run `yarn build && node scripts/sandbox/evidence-server.mjs`, then open `http://localhost:3001/ach-onramp.html` to test the SDK-backed flow and save redacted QC evidence.
|
|
@@ -4566,7 +4566,7 @@ interface operations {
|
|
|
4566
4566
|
/**
|
|
4567
4567
|
* Format: date-time
|
|
4568
4568
|
* @description Creation timestamp
|
|
4569
|
-
* @example 2026-11-
|
|
4569
|
+
* @example 2026-11-16T12:30:13.044Z
|
|
4570
4570
|
*/
|
|
4571
4571
|
createdAt?: string;
|
|
4572
4572
|
}[];
|
|
@@ -4804,7 +4804,7 @@ interface operations {
|
|
|
4804
4804
|
"application/json": {
|
|
4805
4805
|
/**
|
|
4806
4806
|
* @description Destination account ID
|
|
4807
|
-
* @example
|
|
4807
|
+
* @example 6afaf7552f86d55e4d709d24
|
|
4808
4808
|
*/
|
|
4809
4809
|
accountId: string;
|
|
4810
4810
|
/**
|
|
@@ -4832,7 +4832,7 @@ interface operations {
|
|
|
4832
4832
|
"application/x-www-form-urlencoded": {
|
|
4833
4833
|
/**
|
|
4834
4834
|
* @description Destination account ID
|
|
4835
|
-
* @example
|
|
4835
|
+
* @example 6afaf7552f86d55e4d709d24
|
|
4836
4836
|
*/
|
|
4837
4837
|
accountId: string;
|
|
4838
4838
|
/**
|
|
@@ -4860,7 +4860,7 @@ interface operations {
|
|
|
4860
4860
|
"multipart/form-data": {
|
|
4861
4861
|
/**
|
|
4862
4862
|
* @description Destination account ID
|
|
4863
|
-
* @example
|
|
4863
|
+
* @example 6afaf7552f86d55e4d709d24
|
|
4864
4864
|
*/
|
|
4865
4865
|
accountId: string;
|
|
4866
4866
|
/**
|
|
@@ -4907,7 +4907,7 @@ interface operations {
|
|
|
4907
4907
|
/**
|
|
4908
4908
|
* Format: date-time
|
|
4909
4909
|
* @description When the quote was created
|
|
4910
|
-
* @example 2026-11-
|
|
4910
|
+
* @example 2026-11-16T12:30:13.024Z
|
|
4911
4911
|
*/
|
|
4912
4912
|
createdAt: string;
|
|
4913
4913
|
/** @description Exact USD value collected by Spritz and the token route used to fund it. The exact token quantity is returned by the transaction endpoint. */
|
|
@@ -4946,7 +4946,7 @@ interface operations {
|
|
|
4946
4946
|
rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
|
|
4947
4947
|
/**
|
|
4948
4948
|
* @description Destination account ID
|
|
4949
|
-
* @example
|
|
4949
|
+
* @example 6afaf7552f86d55e4d709d25
|
|
4950
4950
|
*/
|
|
4951
4951
|
accountId: string;
|
|
4952
4952
|
/** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
|
|
@@ -5276,7 +5276,7 @@ interface operations {
|
|
|
5276
5276
|
/**
|
|
5277
5277
|
* Format: date-time
|
|
5278
5278
|
* @description When the quote was created
|
|
5279
|
-
* @example 2026-11-
|
|
5279
|
+
* @example 2026-11-16T12:30:13.024Z
|
|
5280
5280
|
*/
|
|
5281
5281
|
createdAt: string;
|
|
5282
5282
|
/** @description Exact USD value collected by Spritz and the token route used to fund it. The exact token quantity is returned by the transaction endpoint. */
|
|
@@ -5315,7 +5315,7 @@ interface operations {
|
|
|
5315
5315
|
rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
|
|
5316
5316
|
/**
|
|
5317
5317
|
* @description Destination account ID
|
|
5318
|
-
* @example
|
|
5318
|
+
* @example 6afaf7552f86d55e4d709d25
|
|
5319
5319
|
*/
|
|
5320
5320
|
accountId: string;
|
|
5321
5321
|
/** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
|
|
@@ -6270,7 +6270,7 @@ interface operations {
|
|
|
6270
6270
|
/**
|
|
6271
6271
|
* Format: date-time
|
|
6272
6272
|
* @description When the quote was created
|
|
6273
|
-
* @example 2026-11-
|
|
6273
|
+
* @example 2026-11-16T12:30:13.024Z
|
|
6274
6274
|
*/
|
|
6275
6275
|
createdAt: string;
|
|
6276
6276
|
/** @description Exact USD value collected by Spritz and the token route used to fund it. The exact token quantity is returned by the transaction endpoint. */
|
|
@@ -6309,7 +6309,7 @@ interface operations {
|
|
|
6309
6309
|
rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
|
|
6310
6310
|
/**
|
|
6311
6311
|
* @description Destination account ID
|
|
6312
|
-
* @example
|
|
6312
|
+
* @example 6afaf7552f86d55e4d709d25
|
|
6313
6313
|
*/
|
|
6314
6314
|
accountId: string;
|
|
6315
6315
|
/** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
|
|
@@ -6685,7 +6685,7 @@ interface operations {
|
|
|
6685
6685
|
currency: string;
|
|
6686
6686
|
/**
|
|
6687
6687
|
* @description Destination account ID
|
|
6688
|
-
* @example
|
|
6688
|
+
* @example 6afaf7552f86d55e4d709d26
|
|
6689
6689
|
*/
|
|
6690
6690
|
accountId: string;
|
|
6691
6691
|
/**
|
|
@@ -7049,7 +7049,7 @@ interface operations {
|
|
|
7049
7049
|
currency: string;
|
|
7050
7050
|
/**
|
|
7051
7051
|
* @description Destination account ID
|
|
7052
|
-
* @example
|
|
7052
|
+
* @example 6afaf7552f86d55e4d709d26
|
|
7053
7053
|
*/
|
|
7054
7054
|
accountId: string;
|
|
7055
7055
|
/**
|
|
@@ -7363,7 +7363,7 @@ interface operations {
|
|
|
7363
7363
|
method: "account";
|
|
7364
7364
|
/**
|
|
7365
7365
|
* @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
|
|
7366
|
-
* @example
|
|
7366
|
+
* @example 6afaf7552f86d55e4d709d27
|
|
7367
7367
|
*/
|
|
7368
7368
|
accountId?: string;
|
|
7369
7369
|
};
|
|
@@ -7381,7 +7381,7 @@ interface operations {
|
|
|
7381
7381
|
method: "account";
|
|
7382
7382
|
/**
|
|
7383
7383
|
* @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
|
|
7384
|
-
* @example
|
|
7384
|
+
* @example 6afaf7552f86d55e4d709d27
|
|
7385
7385
|
*/
|
|
7386
7386
|
accountId?: string;
|
|
7387
7387
|
};
|
|
@@ -7399,7 +7399,7 @@ interface operations {
|
|
|
7399
7399
|
method: "account";
|
|
7400
7400
|
/**
|
|
7401
7401
|
* @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
|
|
7402
|
-
* @example
|
|
7402
|
+
* @example 6afaf7552f86d55e4d709d27
|
|
7403
7403
|
*/
|
|
7404
7404
|
accountId?: string;
|
|
7405
7405
|
};
|
|
@@ -7465,7 +7465,7 @@ interface operations {
|
|
|
7465
7465
|
currency: string;
|
|
7466
7466
|
/**
|
|
7467
7467
|
* @description Destination account ID
|
|
7468
|
-
* @example
|
|
7468
|
+
* @example 6afaf7552f86d55e4d709d26
|
|
7469
7469
|
*/
|
|
7470
7470
|
accountId: string;
|
|
7471
7471
|
/**
|
|
@@ -13485,6 +13485,11 @@ interface operations {
|
|
|
13485
13485
|
payoutTxHash: string | null;
|
|
13486
13486
|
/** @description Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse. */
|
|
13487
13487
|
cancellable: boolean;
|
|
13488
|
+
/**
|
|
13489
|
+
* Format: date-time
|
|
13490
|
+
* @description Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.
|
|
13491
|
+
*/
|
|
13492
|
+
cancellableUntil: string | null;
|
|
13488
13493
|
/**
|
|
13489
13494
|
* Format: date-time
|
|
13490
13495
|
* @description When the user's cancellation was confirmed
|
|
@@ -13957,6 +13962,11 @@ interface operations {
|
|
|
13957
13962
|
payoutTxHash: string | null;
|
|
13958
13963
|
/** @description Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse. */
|
|
13959
13964
|
cancellable: boolean;
|
|
13965
|
+
/**
|
|
13966
|
+
* Format: date-time
|
|
13967
|
+
* @description Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.
|
|
13968
|
+
*/
|
|
13969
|
+
cancellableUntil: string | null;
|
|
13960
13970
|
/**
|
|
13961
13971
|
* Format: date-time
|
|
13962
13972
|
* @description When the user's cancellation was confirmed
|
|
@@ -14353,6 +14363,11 @@ interface operations {
|
|
|
14353
14363
|
payoutTxHash: string | null;
|
|
14354
14364
|
/** @description Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse. */
|
|
14355
14365
|
cancellable: boolean;
|
|
14366
|
+
/**
|
|
14367
|
+
* Format: date-time
|
|
14368
|
+
* @description Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.
|
|
14369
|
+
*/
|
|
14370
|
+
cancellableUntil: string | null;
|
|
14356
14371
|
/**
|
|
14357
14372
|
* Format: date-time
|
|
14358
14373
|
* @description When the user's cancellation was confirmed
|
|
@@ -14447,6 +14462,11 @@ interface operations {
|
|
|
14447
14462
|
payoutTxHash: string | null;
|
|
14448
14463
|
/** @description Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse. */
|
|
14449
14464
|
cancellable: boolean;
|
|
14465
|
+
/**
|
|
14466
|
+
* Format: date-time
|
|
14467
|
+
* @description Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.
|
|
14468
|
+
*/
|
|
14469
|
+
cancellableUntil: string | null;
|
|
14450
14470
|
/**
|
|
14451
14471
|
* Format: date-time
|
|
14452
14472
|
* @description When the user's cancellation was confirmed
|
|
@@ -14992,10 +15012,10 @@ interface operations {
|
|
|
14992
15012
|
* @example v1
|
|
14993
15013
|
* @enum {string}
|
|
14994
15014
|
*/
|
|
14995
|
-
messageVersion: "v1" | "fomo_v1" | "fomo_v2";
|
|
15015
|
+
messageVersion: "v1" | "fomo_v1" | "fomo_v2" | "v2" | "fomo_v3" | "fomo_v4";
|
|
14996
15016
|
/** @description Display-ready ACH authorization message */
|
|
14997
15017
|
message: string;
|
|
14998
|
-
/** @description The authorization paragraph alone, a verbatim part of `message`. When `messageVersion` is `fomo_v2` the paragraph is self-contained: clients that lay out amounts and fees in their own UI must still display it word for word on the confirmation screen. For every other version, display `message` in full. */
|
|
15018
|
+
/** @description The authorization paragraph alone, a verbatim part of `message`. When `messageVersion` is `fomo_v2` or `fomo_v4` the paragraph is self-contained: clients that lay out amounts and fees in their own UI must still display it word for word on the confirmation screen. For every other version, display `message` in full. */
|
|
14999
15019
|
authorizationStatement: string;
|
|
15000
15020
|
/**
|
|
15001
15021
|
* @description Short-lived, preparation-bound bearer capability returned for integrator preparations. Send it only to the authorizing client, which uses it to submit this preparation directly to Spritz.
|
|
@@ -15583,6 +15603,12 @@ interface operations {
|
|
|
15583
15603
|
* @example 1.1.1.1
|
|
15584
15604
|
*/
|
|
15585
15605
|
clientIp?: string;
|
|
15606
|
+
/**
|
|
15607
|
+
* @description What to do when the preparation quoted an instant portion and none of it can be granted at create. `standard` (also the behaviour when omitted) proceeds with settlement-only timing. `confirm` creates nothing and returns 409 `instant_unavailable`; after the user agrees to standard timing, submit the same preparationId again with `standard` and a new Idempotency-Key. A partly reduced instant portion always proceeds.
|
|
15608
|
+
* @default standard
|
|
15609
|
+
* @enum {string}
|
|
15610
|
+
*/
|
|
15611
|
+
instantFallback?: "standard" | "confirm";
|
|
15586
15612
|
};
|
|
15587
15613
|
"application/x-www-form-urlencoded": {
|
|
15588
15614
|
/**
|
|
@@ -15595,6 +15621,12 @@ interface operations {
|
|
|
15595
15621
|
* @example 1.1.1.1
|
|
15596
15622
|
*/
|
|
15597
15623
|
clientIp?: string;
|
|
15624
|
+
/**
|
|
15625
|
+
* @description What to do when the preparation quoted an instant portion and none of it can be granted at create. `standard` (also the behaviour when omitted) proceeds with settlement-only timing. `confirm` creates nothing and returns 409 `instant_unavailable`; after the user agrees to standard timing, submit the same preparationId again with `standard` and a new Idempotency-Key. A partly reduced instant portion always proceeds.
|
|
15626
|
+
* @default standard
|
|
15627
|
+
* @enum {string}
|
|
15628
|
+
*/
|
|
15629
|
+
instantFallback?: "standard" | "confirm";
|
|
15598
15630
|
};
|
|
15599
15631
|
"multipart/form-data": {
|
|
15600
15632
|
/**
|
|
@@ -15607,6 +15639,12 @@ interface operations {
|
|
|
15607
15639
|
* @example 1.1.1.1
|
|
15608
15640
|
*/
|
|
15609
15641
|
clientIp?: string;
|
|
15642
|
+
/**
|
|
15643
|
+
* @description What to do when the preparation quoted an instant portion and none of it can be granted at create. `standard` (also the behaviour when omitted) proceeds with settlement-only timing. `confirm` creates nothing and returns 409 `instant_unavailable`; after the user agrees to standard timing, submit the same preparationId again with `standard` and a new Idempotency-Key. A partly reduced instant portion always proceeds.
|
|
15644
|
+
* @default standard
|
|
15645
|
+
* @enum {string}
|
|
15646
|
+
*/
|
|
15647
|
+
instantFallback?: "standard" | "confirm";
|
|
15610
15648
|
};
|
|
15611
15649
|
};
|
|
15612
15650
|
};
|
|
@@ -15697,6 +15735,11 @@ interface operations {
|
|
|
15697
15735
|
payoutTxHash: string | null;
|
|
15698
15736
|
/** @description Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse. */
|
|
15699
15737
|
cancellable: boolean;
|
|
15738
|
+
/**
|
|
15739
|
+
* Format: date-time
|
|
15740
|
+
* @description Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.
|
|
15741
|
+
*/
|
|
15742
|
+
cancellableUntil: string | null;
|
|
15700
15743
|
/**
|
|
15701
15744
|
* Format: date-time
|
|
15702
15745
|
* @description When the user's cancellation was confirmed
|
|
@@ -22826,7 +22869,7 @@ interface operations {
|
|
|
22826
22869
|
data: {
|
|
22827
22870
|
/**
|
|
22828
22871
|
* @description Unique identifier for the debit card
|
|
22829
|
-
* @example
|
|
22872
|
+
* @example 6afaf7552f86d55e4d709d2b
|
|
22830
22873
|
*/
|
|
22831
22874
|
id: string;
|
|
22832
22875
|
/** @enum {string} */
|
|
@@ -23347,7 +23390,7 @@ interface operations {
|
|
|
23347
23390
|
"application/json": {
|
|
23348
23391
|
/**
|
|
23349
23392
|
* @description Unique identifier for the debit card
|
|
23350
|
-
* @example
|
|
23393
|
+
* @example 6afaf7552f86d55e4d709d2b
|
|
23351
23394
|
*/
|
|
23352
23395
|
id: string;
|
|
23353
23396
|
/** @enum {string} */
|
|
@@ -23637,7 +23680,7 @@ interface operations {
|
|
|
23637
23680
|
"application/json": {
|
|
23638
23681
|
/**
|
|
23639
23682
|
* @description Unique identifier for the debit card
|
|
23640
|
-
* @example
|
|
23683
|
+
* @example 6afaf7552f86d55e4d709d2b
|
|
23641
23684
|
*/
|
|
23642
23685
|
id: string;
|
|
23643
23686
|
/** @enum {string} */
|
|
@@ -24304,7 +24347,7 @@ interface operations {
|
|
|
24304
24347
|
"application/json": {
|
|
24305
24348
|
/**
|
|
24306
24349
|
* @description Unique identifier for the debit card
|
|
24307
|
-
* @example
|
|
24350
|
+
* @example 6afaf7552f86d55e4d709d2b
|
|
24308
24351
|
*/
|
|
24309
24352
|
id: string;
|
|
24310
24353
|
/** @enum {string} */
|
|
@@ -24639,7 +24682,7 @@ interface operations {
|
|
|
24639
24682
|
accessToken: string;
|
|
24640
24683
|
/**
|
|
24641
24684
|
* @description The internal ID of the authorized user
|
|
24642
|
-
* @example
|
|
24685
|
+
* @example 6afaf7552f86d55e4d709d2f
|
|
24643
24686
|
*/
|
|
24644
24687
|
userId: string;
|
|
24645
24688
|
/**
|
|
@@ -24655,7 +24698,7 @@ interface operations {
|
|
|
24655
24698
|
/**
|
|
24656
24699
|
* Format: date-time
|
|
24657
24700
|
* @description ISO 8601 timestamp when token expires
|
|
24658
|
-
* @example 2026-11-
|
|
24701
|
+
* @example 2026-11-16T13:30:13.407Z
|
|
24659
24702
|
*/
|
|
24660
24703
|
expiresAt: string;
|
|
24661
24704
|
};
|
|
@@ -24927,7 +24970,7 @@ interface operations {
|
|
|
24927
24970
|
/**
|
|
24928
24971
|
* Format: date-time
|
|
24929
24972
|
* @description ISO 8601 timestamp of when the integrator was created
|
|
24930
|
-
* @example 2026-11-
|
|
24973
|
+
* @example 2026-11-16T12:30:13.406Z
|
|
24931
24974
|
*/
|
|
24932
24975
|
createdAt: string;
|
|
24933
24976
|
};
|
|
@@ -25213,7 +25256,7 @@ interface operations {
|
|
|
25213
25256
|
"application/json": {
|
|
25214
25257
|
/**
|
|
25215
25258
|
* @description ID of the account this request resolved to: the account it created or, where account reuse is enabled, the existing account this email resolves to for you (your own, or one you are currently authorized for through an existing authorization). With reuse enabled, a repeat for the same email returns the same ID.
|
|
25216
|
-
* @example
|
|
25259
|
+
* @example 6afaf7552f86d55e4d709d31
|
|
25217
25260
|
*/
|
|
25218
25261
|
userId: string;
|
|
25219
25262
|
/**
|
|
@@ -25705,7 +25748,7 @@ interface operations {
|
|
|
25705
25748
|
depositId: string;
|
|
25706
25749
|
/**
|
|
25707
25750
|
* @description Spritz user ID associated with the returned deposit
|
|
25708
|
-
* @example
|
|
25751
|
+
* @example 6afaf7552f86d55e4d709d2e
|
|
25709
25752
|
*/
|
|
25710
25753
|
userId: string;
|
|
25711
25754
|
/**
|
|
@@ -25990,7 +26033,7 @@ interface operations {
|
|
|
25990
26033
|
depositId: string;
|
|
25991
26034
|
/**
|
|
25992
26035
|
* @description Spritz user ID associated with the returned deposit
|
|
25993
|
-
* @example
|
|
26036
|
+
* @example 6afaf7552f86d55e4d709d2e
|
|
25994
26037
|
*/
|
|
25995
26038
|
userId: string;
|
|
25996
26039
|
/**
|
|
@@ -26256,7 +26299,7 @@ interface operations {
|
|
|
26256
26299
|
"application/json": {
|
|
26257
26300
|
/**
|
|
26258
26301
|
* @description Unique identifier for the webhook
|
|
26259
|
-
* @example
|
|
26302
|
+
* @example 6afaf7552f86d55e4d709d30
|
|
26260
26303
|
*/
|
|
26261
26304
|
id: string;
|
|
26262
26305
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -26560,7 +26603,7 @@ interface operations {
|
|
|
26560
26603
|
"application/json": {
|
|
26561
26604
|
/**
|
|
26562
26605
|
* @description Unique identifier for the webhook
|
|
26563
|
-
* @example
|
|
26606
|
+
* @example 6afaf7552f86d55e4d709d30
|
|
26564
26607
|
*/
|
|
26565
26608
|
id: string;
|
|
26566
26609
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -30417,7 +30460,7 @@ interface operations {
|
|
|
30417
30460
|
"application/json": {
|
|
30418
30461
|
/**
|
|
30419
30462
|
* @description Unique identifier for the webhook
|
|
30420
|
-
* @example
|
|
30463
|
+
* @example 6afaf7552f86d55e4d709d30
|
|
30421
30464
|
*/
|
|
30422
30465
|
id: string;
|
|
30423
30466
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -31057,7 +31100,7 @@ interface operations {
|
|
|
31057
31100
|
/**
|
|
31058
31101
|
* Format: date-time
|
|
31059
31102
|
* @description ISO 8601 timestamp when the old secret will expire. Only present if a grace period was specified.
|
|
31060
|
-
* @example 2026-11-
|
|
31103
|
+
* @example 2026-11-16T12:35:13.407Z
|
|
31061
31104
|
*/
|
|
31062
31105
|
oldSecretExpiresAt?: string;
|
|
31063
31106
|
};
|
|
@@ -31301,7 +31344,7 @@ interface operations {
|
|
|
31301
31344
|
"application/json": {
|
|
31302
31345
|
/**
|
|
31303
31346
|
* @description Unique identifier for the user
|
|
31304
|
-
* @example
|
|
31347
|
+
* @example 6afaf7552f86d55e4d709d2c
|
|
31305
31348
|
*/
|
|
31306
31349
|
id: string;
|
|
31307
31350
|
/**
|
|
@@ -31318,7 +31361,7 @@ interface operations {
|
|
|
31318
31361
|
/**
|
|
31319
31362
|
* Format: date-time
|
|
31320
31363
|
* @description ISO 8601 timestamp of when the user was created
|
|
31321
|
-
* @example 2026-11-
|
|
31364
|
+
* @example 2026-11-16T12:30:13.330Z
|
|
31322
31365
|
*/
|
|
31323
31366
|
signedUpAt: string;
|
|
31324
31367
|
/**
|
|
@@ -31797,7 +31840,7 @@ interface operations {
|
|
|
31797
31840
|
"application/json": {
|
|
31798
31841
|
/**
|
|
31799
31842
|
* @description Unique identifier for the user
|
|
31800
|
-
* @example
|
|
31843
|
+
* @example 6afaf7552f86d55e4d709d2c
|
|
31801
31844
|
*/
|
|
31802
31845
|
id: string;
|
|
31803
31846
|
/**
|
|
@@ -31814,7 +31857,7 @@ interface operations {
|
|
|
31814
31857
|
/**
|
|
31815
31858
|
* Format: date-time
|
|
31816
31859
|
* @description ISO 8601 timestamp of when the user was created
|
|
31817
|
-
* @example 2026-11-
|
|
31860
|
+
* @example 2026-11-16T12:30:13.330Z
|
|
31818
31861
|
*/
|
|
31819
31862
|
signedUpAt: string;
|
|
31820
31863
|
/**
|
|
@@ -32657,7 +32700,7 @@ interface operations {
|
|
|
32657
32700
|
"application/json": {
|
|
32658
32701
|
/**
|
|
32659
32702
|
* @description Unique identifier for the user
|
|
32660
|
-
* @example
|
|
32703
|
+
* @example 6afaf7552f86d55e4d709d2c
|
|
32661
32704
|
*/
|
|
32662
32705
|
id: string;
|
|
32663
32706
|
/**
|
|
@@ -32674,7 +32717,7 @@ interface operations {
|
|
|
32674
32717
|
/**
|
|
32675
32718
|
* Format: date-time
|
|
32676
32719
|
* @description ISO 8601 timestamp of when the user was created
|
|
32677
|
-
* @example 2026-11-
|
|
32720
|
+
* @example 2026-11-16T12:30:13.330Z
|
|
32678
32721
|
*/
|
|
32679
32722
|
signedUpAt: string;
|
|
32680
32723
|
/**
|
|
@@ -47365,10 +47408,10 @@ interface operations {
|
|
|
47365
47408
|
* @example v1
|
|
47366
47409
|
* @enum {string}
|
|
47367
47410
|
*/
|
|
47368
|
-
messageVersion: "v1" | "fomo_v1" | "fomo_v2";
|
|
47411
|
+
messageVersion: "v1" | "fomo_v1" | "fomo_v2" | "v2" | "fomo_v3" | "fomo_v4";
|
|
47369
47412
|
/** @description Display-ready ACH authorization message */
|
|
47370
47413
|
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. */
|
|
47414
|
+
/** @description The authorization paragraph alone, a verbatim part of `message`. When `messageVersion` is `fomo_v2` or `fomo_v4` the paragraph is self-contained: clients that lay out amounts and fees in their own UI must still display it word for word on the confirmation screen. For every other version, display `message` in full. */
|
|
47372
47415
|
authorizationStatement: string;
|
|
47373
47416
|
/**
|
|
47374
47417
|
* @description Short-lived, preparation-bound bearer capability returned for integrator preparations. Send it only to the authorizing client, which uses it to submit this preparation directly to Spritz.
|
|
@@ -47973,6 +48016,12 @@ interface operations {
|
|
|
47973
48016
|
*/
|
|
47974
48017
|
profile: "refunded" | "release_failed" | "release_stalled" | "full_delivery" | "partial_then_full_delivery";
|
|
47975
48018
|
};
|
|
48019
|
+
/**
|
|
48020
|
+
* @description What to do when the preparation quoted an instant portion and none of it can be granted at create. `standard` (also the behaviour when omitted) proceeds with settlement-only timing. `confirm` creates nothing and returns 409 `instant_unavailable`; after the user agrees to standard timing, submit the same preparationId again with `standard` and a new Idempotency-Key. A partly reduced instant portion always proceeds.
|
|
48021
|
+
* @default standard
|
|
48022
|
+
* @enum {string}
|
|
48023
|
+
*/
|
|
48024
|
+
instantFallback?: "standard" | "confirm";
|
|
47976
48025
|
};
|
|
47977
48026
|
"application/x-www-form-urlencoded": {
|
|
47978
48027
|
/**
|
|
@@ -48002,6 +48051,12 @@ interface operations {
|
|
|
48002
48051
|
*/
|
|
48003
48052
|
profile: "refunded" | "release_failed" | "release_stalled" | "full_delivery" | "partial_then_full_delivery";
|
|
48004
48053
|
};
|
|
48054
|
+
/**
|
|
48055
|
+
* @description What to do when the preparation quoted an instant portion and none of it can be granted at create. `standard` (also the behaviour when omitted) proceeds with settlement-only timing. `confirm` creates nothing and returns 409 `instant_unavailable`; after the user agrees to standard timing, submit the same preparationId again with `standard` and a new Idempotency-Key. A partly reduced instant portion always proceeds.
|
|
48056
|
+
* @default standard
|
|
48057
|
+
* @enum {string}
|
|
48058
|
+
*/
|
|
48059
|
+
instantFallback?: "standard" | "confirm";
|
|
48005
48060
|
};
|
|
48006
48061
|
"multipart/form-data": {
|
|
48007
48062
|
/**
|
|
@@ -48031,6 +48086,12 @@ interface operations {
|
|
|
48031
48086
|
*/
|
|
48032
48087
|
profile: "refunded" | "release_failed" | "release_stalled" | "full_delivery" | "partial_then_full_delivery";
|
|
48033
48088
|
};
|
|
48089
|
+
/**
|
|
48090
|
+
* @description What to do when the preparation quoted an instant portion and none of it can be granted at create. `standard` (also the behaviour when omitted) proceeds with settlement-only timing. `confirm` creates nothing and returns 409 `instant_unavailable`; after the user agrees to standard timing, submit the same preparationId again with `standard` and a new Idempotency-Key. A partly reduced instant portion always proceeds.
|
|
48091
|
+
* @default standard
|
|
48092
|
+
* @enum {string}
|
|
48093
|
+
*/
|
|
48094
|
+
instantFallback?: "standard" | "confirm";
|
|
48034
48095
|
};
|
|
48035
48096
|
};
|
|
48036
48097
|
};
|
|
@@ -48121,6 +48182,11 @@ interface operations {
|
|
|
48121
48182
|
payoutTxHash: string | null;
|
|
48122
48183
|
/** @description Whether the user can cancel this deposit now via POST /v1/deposits/{depositId}/cancel. True only before the bank debit is transmitted and before any crypto is released. Advisory: the cancel call re-checks and may still refuse. */
|
|
48123
48184
|
cancellable: boolean;
|
|
48185
|
+
/**
|
|
48186
|
+
* Format: date-time
|
|
48187
|
+
* @description Protected cancellation deadline. A cancellation durably recorded before this time prevents bank submission. The window starts after server acceptance: one hour in production, one minute in staging. Null for deposits without a protected window. Cancellation may remain possible afterward; consult cancellable.
|
|
48188
|
+
*/
|
|
48189
|
+
cancellableUntil: string | null;
|
|
48124
48190
|
/**
|
|
48125
48191
|
* Format: date-time
|
|
48126
48192
|
* @description When the user's cancellation was confirmed
|
|
@@ -54772,7 +54838,7 @@ declare class DepositService {
|
|
|
54772
54838
|
preparationId: string;
|
|
54773
54839
|
kind: "deposit_authorization";
|
|
54774
54840
|
expiresAt: string;
|
|
54775
|
-
messageVersion: "v1" | "fomo_v1" | "fomo_v2";
|
|
54841
|
+
messageVersion: "v1" | "fomo_v1" | "fomo_v2" | "v2" | "fomo_v3" | "fomo_v4";
|
|
54776
54842
|
message: string;
|
|
54777
54843
|
authorizationStatement: string;
|
|
54778
54844
|
submissionToken?: string;
|
|
@@ -54821,6 +54887,13 @@ declare class DepositService {
|
|
|
54821
54887
|
*
|
|
54822
54888
|
* Integrator JWT is not accepted on this route because it cannot bind the
|
|
54823
54889
|
* claimed `clientIp`; it remains valid on `prepare` and the read methods.
|
|
54890
|
+
*
|
|
54891
|
+
* With `instantFallback: 'confirm'`, a high-priority preparation that can
|
|
54892
|
+
* get no instant portion throws a `ConflictError` with
|
|
54893
|
+
* `problem.code === 'instant_unavailable'` instead of proceeding at
|
|
54894
|
+
* standard timing. Nothing is created and the preparation stays usable:
|
|
54895
|
+
* once the user accepts standard timing, call `create` again with the same
|
|
54896
|
+
* `preparationId`, `instantFallback: 'standard'` and a new idempotency key.
|
|
54824
54897
|
*/
|
|
54825
54898
|
create(input: CreateDepositRequest, options: CreateDepositOptions): Promise<{
|
|
54826
54899
|
id: string;
|
|
@@ -54870,6 +54943,7 @@ declare class DepositService {
|
|
|
54870
54943
|
releaseFailureReason: string | null;
|
|
54871
54944
|
payoutTxHash: string | null;
|
|
54872
54945
|
cancellable: boolean;
|
|
54946
|
+
cancellableUntil: string | null;
|
|
54873
54947
|
cancelledAt: string | null;
|
|
54874
54948
|
}>;
|
|
54875
54949
|
/**
|
|
@@ -54928,6 +55002,7 @@ declare class DepositService {
|
|
|
54928
55002
|
releaseFailureReason: string | null;
|
|
54929
55003
|
payoutTxHash: string | null;
|
|
54930
55004
|
cancellable: boolean;
|
|
55005
|
+
cancellableUntil: string | null;
|
|
54931
55006
|
cancelledAt: string | null;
|
|
54932
55007
|
}[];
|
|
54933
55008
|
hasMore: boolean;
|
|
@@ -54981,6 +55056,7 @@ declare class DepositService {
|
|
|
54981
55056
|
releaseFailureReason: string | null;
|
|
54982
55057
|
payoutTxHash: string | null;
|
|
54983
55058
|
cancellable: boolean;
|
|
55059
|
+
cancellableUntil: string | null;
|
|
54984
55060
|
cancelledAt: string | null;
|
|
54985
55061
|
}>;
|
|
54986
55062
|
/**
|
|
@@ -55047,6 +55123,7 @@ declare class DepositService {
|
|
|
55047
55123
|
releaseFailureReason: string | null;
|
|
55048
55124
|
payoutTxHash: string | null;
|
|
55049
55125
|
cancellable: boolean;
|
|
55126
|
+
cancellableUntil: string | null;
|
|
55050
55127
|
cancelledAt: string | null;
|
|
55051
55128
|
}>;
|
|
55052
55129
|
}
|
|
@@ -55205,6 +55282,7 @@ declare class SandboxService {
|
|
|
55205
55282
|
releaseFailureReason: string | null;
|
|
55206
55283
|
payoutTxHash: string | null;
|
|
55207
55284
|
cancellable: boolean;
|
|
55285
|
+
cancellableUntil: string | null;
|
|
55208
55286
|
cancelledAt: string | null;
|
|
55209
55287
|
}>;
|
|
55210
55288
|
/**
|
|
@@ -55217,7 +55295,7 @@ declare class SandboxService {
|
|
|
55217
55295
|
preparationId: string;
|
|
55218
55296
|
kind: "deposit_authorization";
|
|
55219
55297
|
expiresAt: string;
|
|
55220
|
-
messageVersion: "v1" | "fomo_v1" | "fomo_v2";
|
|
55298
|
+
messageVersion: "v1" | "fomo_v1" | "fomo_v2" | "v2" | "fomo_v3" | "fomo_v4";
|
|
55221
55299
|
message: string;
|
|
55222
55300
|
authorizationStatement: string;
|
|
55223
55301
|
submissionToken?: string;
|