@spritz-finance/api-client 0.25.0 → 0.26.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 +8 -3
- package/dist/spritz-api-client.d.ts +118 -41
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1350,7 +1350,7 @@ ACH onramp lets users convert USD from their bank account into USDC delivered to
|
|
|
1350
1350
|
3. **Server:** complete linking with `client.bankAccount.completeLinking(...)`
|
|
1351
1351
|
4. **Server:** find an active funding source and fetch limits with `client.fundingSource.getDepositLimits(id)`
|
|
1352
1352
|
5. **Server:** prepare a quote with `client.deposit.prepare(...)`
|
|
1353
|
-
6. **Client:** show the quote and ACH authorization message to the user
|
|
1353
|
+
6. **Client:** show the quote and ACH authorization `message` to the user. If your UI lays out the amounts from `summary` itself, show `authorizationStatement` word for word instead. That's only allowed when `messageVersion` is `fomo_v2`; for any other version, show `message` in full
|
|
1354
1354
|
7. **Server:** create the deposit with `client.deposit.create(input, { idempotencyKey })`; Spritz runs risk checks before initiating the ACH pull. Persist one unique key per deposit intent and reuse it verbatim on retries so a timed-out request replays the original response instead of authorizing a second debit
|
|
1355
1355
|
8. **Server:** track the deposit with `client.deposit.get(depositId)`, or reconcile a backlog by paging `client.deposit.list({ limit, cursor })`
|
|
1356
1356
|
9. **Server (optional):** while `deposit.cancellable` is true, let the user call it off with `client.deposit.cancel(depositId)` (see [Cancelling a Deposit](docs/ach-onramp-guide.md#cancelling-a-deposit))
|
|
@@ -1396,7 +1396,9 @@ A standalone sandbox demo is available at `scripts/sandbox/ach-onramp.html`. Run
|
|
|
1396
1396
|
Before you show a bank deposit option to someone who is not yet a Spritz user, ask whether it is available for their email address:
|
|
1397
1397
|
|
|
1398
1398
|
```typescript
|
|
1399
|
-
const { eligible } = await client.achDebit.checkEligibility({
|
|
1399
|
+
const { eligible } = await client.achDebit.checkEligibility({
|
|
1400
|
+
email: 'user@example.com',
|
|
1401
|
+
})
|
|
1400
1402
|
|
|
1401
1403
|
if (eligible) {
|
|
1402
1404
|
// Offer the bank deposit option
|
|
@@ -1517,7 +1519,10 @@ const { onRampId, depositId, status } = await client.sandbox.simulateAutoRampDep
|
|
|
1517
1519
|
})
|
|
1518
1520
|
|
|
1519
1521
|
// Advance the same on-ramp
|
|
1520
|
-
await client.sandbox.simulateAutoRampDeposit(accountId, {
|
|
1522
|
+
await client.sandbox.simulateAutoRampDeposit(accountId, {
|
|
1523
|
+
amount: '2525.00',
|
|
1524
|
+
depositId,
|
|
1525
|
+
})
|
|
1521
1526
|
|
|
1522
1527
|
const onRamp = await client.onrampPayment.get(onRampId)
|
|
1523
1528
|
```
|
|
@@ -2073,7 +2073,7 @@ interface paths {
|
|
|
2073
2073
|
put?: never;
|
|
2074
2074
|
/**
|
|
2075
2075
|
* Prepare Solana transaction
|
|
2076
|
-
* @description Prepares an unsigned Solana v0 message for the authenticated user's embedded wallet to sign. Supports `transfer`, `payment`, `yield.deposit`, and `yield.withdraw` intents. Kamino is the only yield protocol supported today. The response `messageBytes` are base64-encoded Solana message bytes, not a serialized transaction; the wallet must sign the decoded bytes exactly and submit only the detached signature.
|
|
2076
|
+
* @description Prepares an unsigned Solana v0 message for the authenticated user's embedded wallet to sign. Supports `transfer`, `payment`, `yield.deposit`, and `yield.withdraw` intents. Kamino is the only yield protocol supported today. `intent.from` must be one of the caller's embedded wallet Solana addresses, or the request is refused with 403 `SOURCE_WALLET_NOT_OWNED`. The response `messageBytes` are base64-encoded Solana message bytes, not a serialized transaction; the wallet must sign the decoded bytes exactly and submit only the detached signature.
|
|
2077
2077
|
*/
|
|
2078
2078
|
post: operations["postV1Wallet-kitSolanaTransactionsPrepare"];
|
|
2079
2079
|
delete?: never;
|
|
@@ -4566,7 +4566,7 @@ interface operations {
|
|
|
4566
4566
|
/**
|
|
4567
4567
|
* Format: date-time
|
|
4568
4568
|
* @description Creation timestamp
|
|
4569
|
-
* @example 2026-11-
|
|
4569
|
+
* @example 2026-11-12T14:22:22.182Z
|
|
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 6af5cb9e79eb018a8628fb10
|
|
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 6af5cb9e79eb018a8628fb10
|
|
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 6af5cb9e79eb018a8628fb10
|
|
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-12T14:22:22.164Z
|
|
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 6af5cb9e79eb018a8628fb11
|
|
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-12T14:22:22.164Z
|
|
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 6af5cb9e79eb018a8628fb11
|
|
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-12T14:22:22.164Z
|
|
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 6af5cb9e79eb018a8628fb11
|
|
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 6af5cb9e79eb018a8628fb12
|
|
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 6af5cb9e79eb018a8628fb12
|
|
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 6af5cb9e79eb018a8628fb13
|
|
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 6af5cb9e79eb018a8628fb13
|
|
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 6af5cb9e79eb018a8628fb13
|
|
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 6af5cb9e79eb018a8628fb12
|
|
7469
7469
|
*/
|
|
7470
7470
|
accountId: string;
|
|
7471
7471
|
/**
|
|
@@ -14992,9 +14992,11 @@ interface operations {
|
|
|
14992
14992
|
* @example v1
|
|
14993
14993
|
* @enum {string}
|
|
14994
14994
|
*/
|
|
14995
|
-
messageVersion: "v1" | "fomo_v1";
|
|
14995
|
+
messageVersion: "v1" | "fomo_v1" | "fomo_v2";
|
|
14996
14996
|
/** @description Display-ready ACH authorization message */
|
|
14997
14997
|
message: string;
|
|
14998
|
+
/** @description The authorization paragraph alone, a verbatim part of `message`. When `messageVersion` is `fomo_v2` the paragraph is self-contained: clients that lay out amounts and fees in their own UI must still display it word for word on the confirmation screen. For every other version, display `message` in full. */
|
|
14999
|
+
authorizationStatement: string;
|
|
14998
15000
|
/**
|
|
14999
15001
|
* @description Short-lived, preparation-bound bearer capability returned for integrator preparations. Send it only to the authorizing client, which uses it to submit this preparation directly to Spritz.
|
|
15000
15002
|
* @example ach_submit_eyJhbGciOiJIUzI1NiJ9...
|
|
@@ -22824,7 +22826,7 @@ interface operations {
|
|
|
22824
22826
|
data: {
|
|
22825
22827
|
/**
|
|
22826
22828
|
* @description Unique identifier for the debit card
|
|
22827
|
-
* @example
|
|
22829
|
+
* @example 6af5cb9e79eb018a8628fb17
|
|
22828
22830
|
*/
|
|
22829
22831
|
id: string;
|
|
22830
22832
|
/** @enum {string} */
|
|
@@ -23345,7 +23347,7 @@ interface operations {
|
|
|
23345
23347
|
"application/json": {
|
|
23346
23348
|
/**
|
|
23347
23349
|
* @description Unique identifier for the debit card
|
|
23348
|
-
* @example
|
|
23350
|
+
* @example 6af5cb9e79eb018a8628fb17
|
|
23349
23351
|
*/
|
|
23350
23352
|
id: string;
|
|
23351
23353
|
/** @enum {string} */
|
|
@@ -23635,7 +23637,7 @@ interface operations {
|
|
|
23635
23637
|
"application/json": {
|
|
23636
23638
|
/**
|
|
23637
23639
|
* @description Unique identifier for the debit card
|
|
23638
|
-
* @example
|
|
23640
|
+
* @example 6af5cb9e79eb018a8628fb17
|
|
23639
23641
|
*/
|
|
23640
23642
|
id: string;
|
|
23641
23643
|
/** @enum {string} */
|
|
@@ -24302,7 +24304,7 @@ interface operations {
|
|
|
24302
24304
|
"application/json": {
|
|
24303
24305
|
/**
|
|
24304
24306
|
* @description Unique identifier for the debit card
|
|
24305
|
-
* @example
|
|
24307
|
+
* @example 6af5cb9e79eb018a8628fb17
|
|
24306
24308
|
*/
|
|
24307
24309
|
id: string;
|
|
24308
24310
|
/** @enum {string} */
|
|
@@ -24637,7 +24639,7 @@ interface operations {
|
|
|
24637
24639
|
accessToken: string;
|
|
24638
24640
|
/**
|
|
24639
24641
|
* @description The internal ID of the authorized user
|
|
24640
|
-
* @example
|
|
24642
|
+
* @example 6af5cb9e79eb018a8628fb1b
|
|
24641
24643
|
*/
|
|
24642
24644
|
userId: string;
|
|
24643
24645
|
/**
|
|
@@ -24653,7 +24655,7 @@ interface operations {
|
|
|
24653
24655
|
/**
|
|
24654
24656
|
* Format: date-time
|
|
24655
24657
|
* @description ISO 8601 timestamp when token expires
|
|
24656
|
-
* @example 2026-11-
|
|
24658
|
+
* @example 2026-11-12T15:22:22.542Z
|
|
24657
24659
|
*/
|
|
24658
24660
|
expiresAt: string;
|
|
24659
24661
|
};
|
|
@@ -24925,7 +24927,7 @@ interface operations {
|
|
|
24925
24927
|
/**
|
|
24926
24928
|
* Format: date-time
|
|
24927
24929
|
* @description ISO 8601 timestamp of when the integrator was created
|
|
24928
|
-
* @example 2026-11-
|
|
24930
|
+
* @example 2026-11-12T14:22:22.541Z
|
|
24929
24931
|
*/
|
|
24930
24932
|
createdAt: string;
|
|
24931
24933
|
};
|
|
@@ -25211,7 +25213,7 @@ interface operations {
|
|
|
25211
25213
|
"application/json": {
|
|
25212
25214
|
/**
|
|
25213
25215
|
* @description ID of the account this request resolved to: the account it created or, where account reuse is enabled, the existing account this email resolves to for you (your own, or one you are currently authorized for through an existing authorization). With reuse enabled, a repeat for the same email returns the same ID.
|
|
25214
|
-
* @example
|
|
25216
|
+
* @example 6af5cb9e79eb018a8628fb1d
|
|
25215
25217
|
*/
|
|
25216
25218
|
userId: string;
|
|
25217
25219
|
/**
|
|
@@ -25703,7 +25705,7 @@ interface operations {
|
|
|
25703
25705
|
depositId: string;
|
|
25704
25706
|
/**
|
|
25705
25707
|
* @description Spritz user ID associated with the returned deposit
|
|
25706
|
-
* @example
|
|
25708
|
+
* @example 6af5cb9e79eb018a8628fb1a
|
|
25707
25709
|
*/
|
|
25708
25710
|
userId: string;
|
|
25709
25711
|
/**
|
|
@@ -25988,7 +25990,7 @@ interface operations {
|
|
|
25988
25990
|
depositId: string;
|
|
25989
25991
|
/**
|
|
25990
25992
|
* @description Spritz user ID associated with the returned deposit
|
|
25991
|
-
* @example
|
|
25993
|
+
* @example 6af5cb9e79eb018a8628fb1a
|
|
25992
25994
|
*/
|
|
25993
25995
|
userId: string;
|
|
25994
25996
|
/**
|
|
@@ -26254,7 +26256,7 @@ interface operations {
|
|
|
26254
26256
|
"application/json": {
|
|
26255
26257
|
/**
|
|
26256
26258
|
* @description Unique identifier for the webhook
|
|
26257
|
-
* @example
|
|
26259
|
+
* @example 6af5cb9e79eb018a8628fb1c
|
|
26258
26260
|
*/
|
|
26259
26261
|
id: string;
|
|
26260
26262
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -26558,7 +26560,7 @@ interface operations {
|
|
|
26558
26560
|
"application/json": {
|
|
26559
26561
|
/**
|
|
26560
26562
|
* @description Unique identifier for the webhook
|
|
26561
|
-
* @example
|
|
26563
|
+
* @example 6af5cb9e79eb018a8628fb1c
|
|
26562
26564
|
*/
|
|
26563
26565
|
id: string;
|
|
26564
26566
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -30415,7 +30417,7 @@ interface operations {
|
|
|
30415
30417
|
"application/json": {
|
|
30416
30418
|
/**
|
|
30417
30419
|
* @description Unique identifier for the webhook
|
|
30418
|
-
* @example
|
|
30420
|
+
* @example 6af5cb9e79eb018a8628fb1c
|
|
30419
30421
|
*/
|
|
30420
30422
|
id: string;
|
|
30421
30423
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -31055,7 +31057,7 @@ interface operations {
|
|
|
31055
31057
|
/**
|
|
31056
31058
|
* Format: date-time
|
|
31057
31059
|
* @description ISO 8601 timestamp when the old secret will expire. Only present if a grace period was specified.
|
|
31058
|
-
* @example 2026-11-
|
|
31060
|
+
* @example 2026-11-12T14:27:22.542Z
|
|
31059
31061
|
*/
|
|
31060
31062
|
oldSecretExpiresAt?: string;
|
|
31061
31063
|
};
|
|
@@ -31299,7 +31301,7 @@ interface operations {
|
|
|
31299
31301
|
"application/json": {
|
|
31300
31302
|
/**
|
|
31301
31303
|
* @description Unique identifier for the user
|
|
31302
|
-
* @example
|
|
31304
|
+
* @example 6af5cb9e79eb018a8628fb18
|
|
31303
31305
|
*/
|
|
31304
31306
|
id: string;
|
|
31305
31307
|
/**
|
|
@@ -31316,7 +31318,7 @@ interface operations {
|
|
|
31316
31318
|
/**
|
|
31317
31319
|
* Format: date-time
|
|
31318
31320
|
* @description ISO 8601 timestamp of when the user was created
|
|
31319
|
-
* @example 2026-11-
|
|
31321
|
+
* @example 2026-11-12T14:22:22.466Z
|
|
31320
31322
|
*/
|
|
31321
31323
|
signedUpAt: string;
|
|
31322
31324
|
/**
|
|
@@ -31795,7 +31797,7 @@ interface operations {
|
|
|
31795
31797
|
"application/json": {
|
|
31796
31798
|
/**
|
|
31797
31799
|
* @description Unique identifier for the user
|
|
31798
|
-
* @example
|
|
31800
|
+
* @example 6af5cb9e79eb018a8628fb18
|
|
31799
31801
|
*/
|
|
31800
31802
|
id: string;
|
|
31801
31803
|
/**
|
|
@@ -31812,7 +31814,7 @@ interface operations {
|
|
|
31812
31814
|
/**
|
|
31813
31815
|
* Format: date-time
|
|
31814
31816
|
* @description ISO 8601 timestamp of when the user was created
|
|
31815
|
-
* @example 2026-11-
|
|
31817
|
+
* @example 2026-11-12T14:22:22.466Z
|
|
31816
31818
|
*/
|
|
31817
31819
|
signedUpAt: string;
|
|
31818
31820
|
/**
|
|
@@ -32655,7 +32657,7 @@ interface operations {
|
|
|
32655
32657
|
"application/json": {
|
|
32656
32658
|
/**
|
|
32657
32659
|
* @description Unique identifier for the user
|
|
32658
|
-
* @example
|
|
32660
|
+
* @example 6af5cb9e79eb018a8628fb18
|
|
32659
32661
|
*/
|
|
32660
32662
|
id: string;
|
|
32661
32663
|
/**
|
|
@@ -32672,7 +32674,7 @@ interface operations {
|
|
|
32672
32674
|
/**
|
|
32673
32675
|
* Format: date-time
|
|
32674
32676
|
* @description ISO 8601 timestamp of when the user was created
|
|
32675
|
-
* @example 2026-11-
|
|
32677
|
+
* @example 2026-11-12T14:22:22.466Z
|
|
32676
32678
|
*/
|
|
32677
32679
|
signedUpAt: string;
|
|
32678
32680
|
/**
|
|
@@ -38954,6 +38956,77 @@ interface operations {
|
|
|
38954
38956
|
};
|
|
38955
38957
|
};
|
|
38956
38958
|
};
|
|
38959
|
+
/** @description Response for status 403 */
|
|
38960
|
+
403: {
|
|
38961
|
+
headers: {
|
|
38962
|
+
[name: string]: unknown;
|
|
38963
|
+
};
|
|
38964
|
+
content: {
|
|
38965
|
+
"application/problem+json": {
|
|
38966
|
+
/**
|
|
38967
|
+
* @description A URI reference that identifies the problem type
|
|
38968
|
+
* @default about:blank
|
|
38969
|
+
* @example urn:problem-type:auth:unauthorized
|
|
38970
|
+
*/
|
|
38971
|
+
type: string;
|
|
38972
|
+
/**
|
|
38973
|
+
* @description A short, human-readable summary of the problem type
|
|
38974
|
+
* @example Unauthorized
|
|
38975
|
+
*/
|
|
38976
|
+
title: string;
|
|
38977
|
+
/**
|
|
38978
|
+
* @description The HTTP status code
|
|
38979
|
+
* @example 400
|
|
38980
|
+
*/
|
|
38981
|
+
status: number;
|
|
38982
|
+
/** @description A human-readable explanation specific to this occurrence */
|
|
38983
|
+
detail?: string;
|
|
38984
|
+
/**
|
|
38985
|
+
* @description A URI reference that identifies the specific occurrence
|
|
38986
|
+
* @example /errors/1234567890
|
|
38987
|
+
*/
|
|
38988
|
+
instance?: string;
|
|
38989
|
+
/**
|
|
38990
|
+
* @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.
|
|
38991
|
+
* @example transaction_limit
|
|
38992
|
+
*/
|
|
38993
|
+
code?: string;
|
|
38994
|
+
/**
|
|
38995
|
+
* @description The offending request field, present alongside `code`.
|
|
38996
|
+
* @example amountUsd
|
|
38997
|
+
*/
|
|
38998
|
+
field?: string;
|
|
38999
|
+
/**
|
|
39000
|
+
* @description Whether retrying the same request later may succeed without changing its inputs.
|
|
39001
|
+
* @example true
|
|
39002
|
+
*/
|
|
39003
|
+
retryable?: boolean;
|
|
39004
|
+
/**
|
|
39005
|
+
* @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.
|
|
39006
|
+
* @example 5
|
|
39007
|
+
*/
|
|
39008
|
+
retryAfter?: number;
|
|
39009
|
+
/** @enum {string} */
|
|
39010
|
+
suggestedAction?: "auto_ramp" | "wait_for_settlement";
|
|
39011
|
+
/**
|
|
39012
|
+
* Format: date-time
|
|
39013
|
+
* @description Earliest known time the current temporary condition may clear.
|
|
39014
|
+
*/
|
|
39015
|
+
clearsAt?: string | null;
|
|
39016
|
+
/**
|
|
39017
|
+
* Format: date-time
|
|
39018
|
+
* @description When a temporary block lifts: a temporarily ineligible funding source, or new deposits paused after repeated cancellations (`ach_debit_cancel_cooldown`).
|
|
39019
|
+
*/
|
|
39020
|
+
availableAt?: string | null;
|
|
39021
|
+
/** @description Whether the current funding-source restriction will not clear automatically. */
|
|
39022
|
+
permanent?: boolean;
|
|
39023
|
+
/** @enum {string} */
|
|
39024
|
+
reason?: "crypto_released" | "debit_in_progress" | "deposit_closed";
|
|
39025
|
+
} & {
|
|
39026
|
+
[key: string]: unknown;
|
|
39027
|
+
};
|
|
39028
|
+
};
|
|
39029
|
+
};
|
|
38957
39030
|
/** @description Response for status 409 */
|
|
38958
39031
|
409: {
|
|
38959
39032
|
headers: {
|
|
@@ -47267,9 +47340,11 @@ interface operations {
|
|
|
47267
47340
|
* @example v1
|
|
47268
47341
|
* @enum {string}
|
|
47269
47342
|
*/
|
|
47270
|
-
messageVersion: "v1" | "fomo_v1";
|
|
47343
|
+
messageVersion: "v1" | "fomo_v1" | "fomo_v2";
|
|
47271
47344
|
/** @description Display-ready ACH authorization message */
|
|
47272
47345
|
message: string;
|
|
47346
|
+
/** @description The authorization paragraph alone, a verbatim part of `message`. When `messageVersion` is `fomo_v2` the paragraph is self-contained: clients that lay out amounts and fees in their own UI must still display it word for word on the confirmation screen. For every other version, display `message` in full. */
|
|
47347
|
+
authorizationStatement: string;
|
|
47273
47348
|
/**
|
|
47274
47349
|
* @description Short-lived, preparation-bound bearer capability returned for integrator preparations. Send it only to the authorizing client, which uses it to submit this preparation directly to Spritz.
|
|
47275
47350
|
* @example ach_submit_eyJhbGciOiJIUzI1NiJ9...
|
|
@@ -54665,8 +54740,9 @@ declare class DepositService {
|
|
|
54665
54740
|
preparationId: string;
|
|
54666
54741
|
kind: "deposit_authorization";
|
|
54667
54742
|
expiresAt: string;
|
|
54668
|
-
messageVersion: "v1" | "fomo_v1";
|
|
54743
|
+
messageVersion: "v1" | "fomo_v1" | "fomo_v2";
|
|
54669
54744
|
message: string;
|
|
54745
|
+
authorizationStatement: string;
|
|
54670
54746
|
submissionToken?: string;
|
|
54671
54747
|
summary: {
|
|
54672
54748
|
quoteType: "exact_input" | "exact_output";
|
|
@@ -55109,8 +55185,9 @@ declare class SandboxService {
|
|
|
55109
55185
|
preparationId: string;
|
|
55110
55186
|
kind: "deposit_authorization";
|
|
55111
55187
|
expiresAt: string;
|
|
55112
|
-
messageVersion: "v1" | "fomo_v1";
|
|
55188
|
+
messageVersion: "v1" | "fomo_v1" | "fomo_v2";
|
|
55113
55189
|
message: string;
|
|
55190
|
+
authorizationStatement: string;
|
|
55114
55191
|
submissionToken?: string;
|
|
55115
55192
|
summary: {
|
|
55116
55193
|
quoteType: "exact_input" | "exact_output";
|