@spritz-finance/api-client 0.19.0 → 0.21.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 +43 -1
- package/dist/spritz-api-client.cjs +58 -58
- package/dist/spritz-api-client.d.ts +338 -48
- package/dist/spritz-api-client.mjs +58 -58
- package/package.json +1 -1
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import { DocumentNode } from 'graphql';
|
|
2
2
|
import { VersionedTransaction } from '@solana/web3.js';
|
|
3
3
|
|
|
4
|
+
type Headers = Record<string, string | null | undefined>;
|
|
5
|
+
|
|
4
6
|
declare enum Environment {
|
|
5
7
|
Sandbox = "staging",
|
|
6
8
|
Production = "production"
|
|
7
9
|
}
|
|
8
10
|
|
|
9
|
-
type Headers = Record<string, string | null | undefined>;
|
|
10
|
-
|
|
11
11
|
/**
|
|
12
12
|
* This file was auto-generated by openapi-typescript.
|
|
13
13
|
* Do not make direct changes to the file.
|
|
@@ -607,7 +607,7 @@ interface paths {
|
|
|
607
607
|
};
|
|
608
608
|
/**
|
|
609
609
|
* List deposits
|
|
610
|
-
* @description Returns the authenticated user's ACH debit deposits newest first. Use nextCursor to retrieve subsequent pages and reconcile asynchronous debit, release, settlement, return, and failure states.
|
|
610
|
+
* @description Returns the authenticated user's ACH debit deposits newest first. Use nextCursor to retrieve subsequent pages and reconcile asynchronous debit, release, settlement, return, and failure states. Readable whenever the integrator has ACH debit enabled, including while ACH debit is paused, halted, or not offered to this user.
|
|
611
611
|
*/
|
|
612
612
|
get: operations["getV1Deposits"];
|
|
613
613
|
put?: never;
|
|
@@ -627,7 +627,7 @@ interface paths {
|
|
|
627
627
|
};
|
|
628
628
|
/**
|
|
629
629
|
* Get a deposit
|
|
630
|
-
* @description Returns the latest ACH debit and crypto release state for a deposit owned by the authenticated user.
|
|
630
|
+
* @description Returns the latest ACH debit and crypto release state for a deposit owned by the authenticated user. Readable whenever the integrator has ACH debit enabled, including while ACH debit is paused, halted, or not offered to this user.
|
|
631
631
|
*/
|
|
632
632
|
get: operations["getV1DepositsByDepositId"];
|
|
633
633
|
put?: never;
|
|
@@ -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. 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.
|
|
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. Availability errors: 403 with code `ach_debit_temporarily_unavailable` means ACH debit is temporarily paused for this user (rollout pause) — offer another deposit method and do not retry. 409 with code `ach_debit_program_halted` means ACH debit is temporarily halted for this program (master stop, book halt, or integrator halt); 409 with code `ach_debit_new_user_paused` means new users temporarily cannot start ACH debit deposits. Both 409s are temporary: offer another method and retry later. The funding source's deposit-limits response reports the same stops as `rail_halted` / `new_user_admission_paused`, and the capability reports `not_available` while they last.
|
|
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. 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.
|
|
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. Availability errors: 403 with code `ach_debit_temporarily_unavailable` means ACH debit is temporarily paused for this user (rollout pause) — offer another deposit method and do not retry. 409 with code `ach_debit_program_halted` means ACH debit is temporarily halted for this program (master stop, book halt, or integrator halt); 409 with code `ach_debit_new_user_paused` means new users temporarily cannot start ACH debit deposits. Both 409s are temporary: offer another method and retry later. The funding source's deposit-limits response reports the same stops as `rail_halted` / `new_user_admission_paused`, and the capability reports `not_available` while they last.
|
|
673
673
|
*/
|
|
674
674
|
post: operations["postV1DepositsDirect"];
|
|
675
675
|
delete?: never;
|
|
@@ -689,7 +689,7 @@ interface paths {
|
|
|
689
689
|
put?: never;
|
|
690
690
|
/**
|
|
691
691
|
* Check ACH debit eligibility
|
|
692
|
-
* @description Once an email is eligible, it remains eligible. A false response may be transient, so re-check rather than caching it. Call this endpoint before showing a bank deposit option. Once the user exists, the capabilities returned by GET /v1/users/me remain the source of truth.
|
|
692
|
+
* @description Once an email is eligible, it remains eligible. While ACH debit is temporarily halted or paused for new users, the answer is false, even for an email that was eligible before, and nothing is recorded. A false response may be transient, so re-check rather than caching it. Call this endpoint before showing a bank deposit option. Once the user exists, the capabilities returned by GET /v1/users/me remain the source of truth.
|
|
693
693
|
*/
|
|
694
694
|
post: operations["postV1Ach-debitEligibility"];
|
|
695
695
|
delete?: never;
|
|
@@ -1250,6 +1250,26 @@ interface paths {
|
|
|
1250
1250
|
patch?: never;
|
|
1251
1251
|
trace?: never;
|
|
1252
1252
|
};
|
|
1253
|
+
"/v1/connect/sessions/{sessionId}/preview": {
|
|
1254
|
+
parameters: {
|
|
1255
|
+
query?: never;
|
|
1256
|
+
header?: never;
|
|
1257
|
+
path?: never;
|
|
1258
|
+
cookie?: never;
|
|
1259
|
+
};
|
|
1260
|
+
get?: never;
|
|
1261
|
+
put?: never;
|
|
1262
|
+
/**
|
|
1263
|
+
* Preview a connect session before sign-in
|
|
1264
|
+
* @description Returns who is asking and which account the session is for, so the hosted page can render before sign-in. Requires the scoped returnToken from the authorization URL fragment; a session ID alone grants no authority. Read-only. Invalid or expired tokens return 404.
|
|
1265
|
+
*/
|
|
1266
|
+
post: operations["postV1ConnectSessionsBySessionIdPreview"];
|
|
1267
|
+
delete?: never;
|
|
1268
|
+
options?: never;
|
|
1269
|
+
head?: never;
|
|
1270
|
+
patch?: never;
|
|
1271
|
+
trace?: never;
|
|
1272
|
+
};
|
|
1253
1273
|
"/v1/integrator/connect/sessions": {
|
|
1254
1274
|
parameters: {
|
|
1255
1275
|
query?: never;
|
|
@@ -1321,7 +1341,7 @@ interface paths {
|
|
|
1321
1341
|
put?: never;
|
|
1322
1342
|
/**
|
|
1323
1343
|
* Approve connect session
|
|
1324
|
-
* @description Approves the Spritz Connect session and returns a callback URI containing the authorization code.
|
|
1344
|
+
* @description Approves the Spritz Connect session and returns a callback URI containing the authorization code. When the session was created with an email, the signed-in account must have that email; otherwise returns 403 CONNECT_ACCOUNT_MISMATCH and the session stays pending.
|
|
1325
1345
|
*/
|
|
1326
1346
|
post: operations["postV1ConnectSessionsBySessionIdApprove"];
|
|
1327
1347
|
delete?: never;
|
|
@@ -1393,7 +1413,7 @@ interface paths {
|
|
|
1393
1413
|
*
|
|
1394
1414
|
* The response includes the user's API key (`ak_...`), which is returned only once at creation - store it securely.
|
|
1395
1415
|
*
|
|
1396
|
-
* **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.
|
|
1416
|
+
* **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`) with the same `email` to have the existing user authorize this integrator; the hosted page shows that email and only that account can approve. A concurrent request to create a user with the same email also returns `409 Conflict`; retry shortly.
|
|
1397
1417
|
*/
|
|
1398
1418
|
post: operations["postV1IntegratorUsers"];
|
|
1399
1419
|
delete?: never;
|
|
@@ -3983,7 +4003,7 @@ interface operations {
|
|
|
3983
4003
|
/**
|
|
3984
4004
|
* Format: date-time
|
|
3985
4005
|
* @description Creation timestamp
|
|
3986
|
-
* @example 2026-
|
|
4006
|
+
* @example 2026-10-06T16:12:43.523Z
|
|
3987
4007
|
*/
|
|
3988
4008
|
createdAt?: string;
|
|
3989
4009
|
}[];
|
|
@@ -4148,7 +4168,7 @@ interface operations {
|
|
|
4148
4168
|
"application/json": {
|
|
4149
4169
|
/**
|
|
4150
4170
|
* @description Destination account ID
|
|
4151
|
-
* @example
|
|
4171
|
+
* @example 6ac51dfb61ca9c031e3c0433
|
|
4152
4172
|
*/
|
|
4153
4173
|
accountId: string;
|
|
4154
4174
|
/**
|
|
@@ -4176,7 +4196,7 @@ interface operations {
|
|
|
4176
4196
|
"application/x-www-form-urlencoded": {
|
|
4177
4197
|
/**
|
|
4178
4198
|
* @description Destination account ID
|
|
4179
|
-
* @example
|
|
4199
|
+
* @example 6ac51dfb61ca9c031e3c0433
|
|
4180
4200
|
*/
|
|
4181
4201
|
accountId: string;
|
|
4182
4202
|
/**
|
|
@@ -4204,7 +4224,7 @@ interface operations {
|
|
|
4204
4224
|
"multipart/form-data": {
|
|
4205
4225
|
/**
|
|
4206
4226
|
* @description Destination account ID
|
|
4207
|
-
* @example
|
|
4227
|
+
* @example 6ac51dfb61ca9c031e3c0433
|
|
4208
4228
|
*/
|
|
4209
4229
|
accountId: string;
|
|
4210
4230
|
/**
|
|
@@ -4251,7 +4271,7 @@ interface operations {
|
|
|
4251
4271
|
/**
|
|
4252
4272
|
* Format: date-time
|
|
4253
4273
|
* @description When the quote was created
|
|
4254
|
-
* @example 2026-
|
|
4274
|
+
* @example 2026-10-06T16:12:43.457Z
|
|
4255
4275
|
*/
|
|
4256
4276
|
createdAt: string;
|
|
4257
4277
|
/** @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. */
|
|
@@ -4290,7 +4310,7 @@ interface operations {
|
|
|
4290
4310
|
rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
|
|
4291
4311
|
/**
|
|
4292
4312
|
* @description Destination account ID
|
|
4293
|
-
* @example
|
|
4313
|
+
* @example 6ac51dfb61ca9c031e3c0434
|
|
4294
4314
|
*/
|
|
4295
4315
|
accountId: string;
|
|
4296
4316
|
/** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
|
|
@@ -4547,7 +4567,7 @@ interface operations {
|
|
|
4547
4567
|
/**
|
|
4548
4568
|
* Format: date-time
|
|
4549
4569
|
* @description When the quote was created
|
|
4550
|
-
* @example 2026-
|
|
4570
|
+
* @example 2026-10-06T16:12:43.457Z
|
|
4551
4571
|
*/
|
|
4552
4572
|
createdAt: string;
|
|
4553
4573
|
/** @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. */
|
|
@@ -4586,7 +4606,7 @@ interface operations {
|
|
|
4586
4606
|
rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
|
|
4587
4607
|
/**
|
|
4588
4608
|
* @description Destination account ID
|
|
4589
|
-
* @example
|
|
4609
|
+
* @example 6ac51dfb61ca9c031e3c0434
|
|
4590
4610
|
*/
|
|
4591
4611
|
accountId: string;
|
|
4592
4612
|
/** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
|
|
@@ -5182,7 +5202,7 @@ interface operations {
|
|
|
5182
5202
|
/**
|
|
5183
5203
|
* Format: date-time
|
|
5184
5204
|
* @description When the quote was created
|
|
5185
|
-
* @example 2026-
|
|
5205
|
+
* @example 2026-10-06T16:12:43.457Z
|
|
5186
5206
|
*/
|
|
5187
5207
|
createdAt: string;
|
|
5188
5208
|
/** @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. */
|
|
@@ -5221,7 +5241,7 @@ interface operations {
|
|
|
5221
5241
|
rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
|
|
5222
5242
|
/**
|
|
5223
5243
|
* @description Destination account ID
|
|
5224
|
-
* @example
|
|
5244
|
+
* @example 6ac51dfb61ca9c031e3c0434
|
|
5225
5245
|
*/
|
|
5226
5246
|
accountId: string;
|
|
5227
5247
|
/** @description True when this quote does not lock the destination amount. EUR quotes remain estimates; actual settlement is reported by the off-ramp resource. */
|
|
@@ -5524,7 +5544,7 @@ interface operations {
|
|
|
5524
5544
|
currency: string;
|
|
5525
5545
|
/**
|
|
5526
5546
|
* @description Destination account ID
|
|
5527
|
-
* @example
|
|
5547
|
+
* @example 6ac51dfb61ca9c031e3c0435
|
|
5528
5548
|
*/
|
|
5529
5549
|
accountId: string;
|
|
5530
5550
|
/**
|
|
@@ -5815,7 +5835,7 @@ interface operations {
|
|
|
5815
5835
|
currency: string;
|
|
5816
5836
|
/**
|
|
5817
5837
|
* @description Destination account ID
|
|
5818
|
-
* @example
|
|
5838
|
+
* @example 6ac51dfb61ca9c031e3c0435
|
|
5819
5839
|
*/
|
|
5820
5840
|
accountId: string;
|
|
5821
5841
|
/**
|
|
@@ -6056,7 +6076,7 @@ interface operations {
|
|
|
6056
6076
|
method: "account";
|
|
6057
6077
|
/**
|
|
6058
6078
|
* @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
|
|
6059
|
-
* @example
|
|
6079
|
+
* @example 6ac51dfb61ca9c031e3c0436
|
|
6060
6080
|
*/
|
|
6061
6081
|
accountId?: string;
|
|
6062
6082
|
};
|
|
@@ -6074,7 +6094,7 @@ interface operations {
|
|
|
6074
6094
|
method: "account";
|
|
6075
6095
|
/**
|
|
6076
6096
|
* @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
|
|
6077
|
-
* @example
|
|
6097
|
+
* @example 6ac51dfb61ca9c031e3c0436
|
|
6078
6098
|
*/
|
|
6079
6099
|
accountId?: string;
|
|
6080
6100
|
};
|
|
@@ -6092,7 +6112,7 @@ interface operations {
|
|
|
6092
6112
|
method: "account";
|
|
6093
6113
|
/**
|
|
6094
6114
|
* @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
|
|
6095
|
-
* @example
|
|
6115
|
+
* @example 6ac51dfb61ca9c031e3c0436
|
|
6096
6116
|
*/
|
|
6097
6117
|
accountId?: string;
|
|
6098
6118
|
};
|
|
@@ -6158,7 +6178,7 @@ interface operations {
|
|
|
6158
6178
|
currency: string;
|
|
6159
6179
|
/**
|
|
6160
6180
|
* @description Destination account ID
|
|
6161
|
-
* @example
|
|
6181
|
+
* @example 6ac51dfb61ca9c031e3c0435
|
|
6162
6182
|
*/
|
|
6163
6183
|
accountId: string;
|
|
6164
6184
|
/**
|
|
@@ -17929,7 +17949,7 @@ interface operations {
|
|
|
17929
17949
|
data: {
|
|
17930
17950
|
/**
|
|
17931
17951
|
* @description Unique identifier for the debit card
|
|
17932
|
-
* @example
|
|
17952
|
+
* @example 6ac51dfb61ca9c031e3c043a
|
|
17933
17953
|
*/
|
|
17934
17954
|
id: string;
|
|
17935
17955
|
/** @enum {string} */
|
|
@@ -18377,7 +18397,7 @@ interface operations {
|
|
|
18377
18397
|
"application/json": {
|
|
18378
18398
|
/**
|
|
18379
18399
|
* @description Unique identifier for the debit card
|
|
18380
|
-
* @example
|
|
18400
|
+
* @example 6ac51dfb61ca9c031e3c043a
|
|
18381
18401
|
*/
|
|
18382
18402
|
id: string;
|
|
18383
18403
|
/** @enum {string} */
|
|
@@ -18594,7 +18614,7 @@ interface operations {
|
|
|
18594
18614
|
"application/json": {
|
|
18595
18615
|
/**
|
|
18596
18616
|
* @description Unique identifier for the debit card
|
|
18597
|
-
* @example
|
|
18617
|
+
* @example 6ac51dfb61ca9c031e3c043a
|
|
18598
18618
|
*/
|
|
18599
18619
|
id: string;
|
|
18600
18620
|
/** @enum {string} */
|
|
@@ -19115,7 +19135,7 @@ interface operations {
|
|
|
19115
19135
|
"application/json": {
|
|
19116
19136
|
/**
|
|
19117
19137
|
* @description Unique identifier for the debit card
|
|
19118
|
-
* @example
|
|
19138
|
+
* @example 6ac51dfb61ca9c031e3c043a
|
|
19119
19139
|
*/
|
|
19120
19140
|
id: string;
|
|
19121
19141
|
/** @enum {string} */
|
|
@@ -19573,6 +19593,198 @@ interface operations {
|
|
|
19573
19593
|
};
|
|
19574
19594
|
};
|
|
19575
19595
|
};
|
|
19596
|
+
postV1ConnectSessionsBySessionIdPreview: {
|
|
19597
|
+
parameters: {
|
|
19598
|
+
query?: never;
|
|
19599
|
+
header?: never;
|
|
19600
|
+
path: {
|
|
19601
|
+
sessionId: string;
|
|
19602
|
+
};
|
|
19603
|
+
cookie?: never;
|
|
19604
|
+
};
|
|
19605
|
+
requestBody: {
|
|
19606
|
+
content: {
|
|
19607
|
+
"application/json": {
|
|
19608
|
+
/** @description Scoped capability from the authorization URL fragment. */
|
|
19609
|
+
returnToken: string;
|
|
19610
|
+
};
|
|
19611
|
+
"application/x-www-form-urlencoded": {
|
|
19612
|
+
/** @description Scoped capability from the authorization URL fragment. */
|
|
19613
|
+
returnToken: string;
|
|
19614
|
+
};
|
|
19615
|
+
"multipart/form-data": {
|
|
19616
|
+
/** @description Scoped capability from the authorization URL fragment. */
|
|
19617
|
+
returnToken: string;
|
|
19618
|
+
};
|
|
19619
|
+
};
|
|
19620
|
+
};
|
|
19621
|
+
responses: {
|
|
19622
|
+
/** @description Response for status 200 */
|
|
19623
|
+
200: {
|
|
19624
|
+
headers: {
|
|
19625
|
+
[name: string]: unknown;
|
|
19626
|
+
};
|
|
19627
|
+
content: {
|
|
19628
|
+
"application/json": {
|
|
19629
|
+
sessionId: string;
|
|
19630
|
+
integratorId: string;
|
|
19631
|
+
integratorName: string | null;
|
|
19632
|
+
/** @description Account this session is bound to, or null when unbound. */
|
|
19633
|
+
email: string | null;
|
|
19634
|
+
/** @description `expired` once the 10-minute consent window has passed. */
|
|
19635
|
+
status: string;
|
|
19636
|
+
/** Format: date-time */
|
|
19637
|
+
expiresAt: string;
|
|
19638
|
+
};
|
|
19639
|
+
};
|
|
19640
|
+
};
|
|
19641
|
+
/** @description Response for status 401 */
|
|
19642
|
+
401: {
|
|
19643
|
+
headers: {
|
|
19644
|
+
[name: string]: unknown;
|
|
19645
|
+
};
|
|
19646
|
+
content: {
|
|
19647
|
+
"application/problem+json": {
|
|
19648
|
+
/**
|
|
19649
|
+
* @description A URI reference that identifies the problem type
|
|
19650
|
+
* @default about:blank
|
|
19651
|
+
* @example urn:problem-type:auth:unauthorized
|
|
19652
|
+
*/
|
|
19653
|
+
type: string;
|
|
19654
|
+
/**
|
|
19655
|
+
* @description A short, human-readable summary of the problem type
|
|
19656
|
+
* @example Unauthorized
|
|
19657
|
+
*/
|
|
19658
|
+
title: string;
|
|
19659
|
+
/**
|
|
19660
|
+
* @description The HTTP status code
|
|
19661
|
+
* @example 401
|
|
19662
|
+
*/
|
|
19663
|
+
status: number;
|
|
19664
|
+
/**
|
|
19665
|
+
* @description A human-readable explanation specific to this occurrence
|
|
19666
|
+
* @example Bearer token required
|
|
19667
|
+
*/
|
|
19668
|
+
detail?: string;
|
|
19669
|
+
/** @description A URI reference that identifies the specific occurrence */
|
|
19670
|
+
instance?: string;
|
|
19671
|
+
/**
|
|
19672
|
+
* @description The authentication realm
|
|
19673
|
+
* @example API
|
|
19674
|
+
*/
|
|
19675
|
+
realm?: string;
|
|
19676
|
+
/**
|
|
19677
|
+
* @description The required scope for this resource
|
|
19678
|
+
* @example read:users
|
|
19679
|
+
*/
|
|
19680
|
+
scope?: string;
|
|
19681
|
+
};
|
|
19682
|
+
};
|
|
19683
|
+
};
|
|
19684
|
+
/** @description Response for status 404 */
|
|
19685
|
+
404: {
|
|
19686
|
+
headers: {
|
|
19687
|
+
[name: string]: unknown;
|
|
19688
|
+
};
|
|
19689
|
+
content: {
|
|
19690
|
+
"application/problem+json": {
|
|
19691
|
+
/**
|
|
19692
|
+
* @description A URI reference that identifies the problem type
|
|
19693
|
+
* @default about:blank
|
|
19694
|
+
*/
|
|
19695
|
+
type: string;
|
|
19696
|
+
/** @description A short, human-readable summary of the problem type */
|
|
19697
|
+
title: string;
|
|
19698
|
+
/**
|
|
19699
|
+
* @description The HTTP status code
|
|
19700
|
+
* @example 404
|
|
19701
|
+
*/
|
|
19702
|
+
status: number;
|
|
19703
|
+
/** @description A human-readable explanation specific to this occurrence */
|
|
19704
|
+
detail?: string;
|
|
19705
|
+
/** @description A URI reference that identifies the specific occurrence */
|
|
19706
|
+
instance?: string;
|
|
19707
|
+
/**
|
|
19708
|
+
* @description The type of resource that was not found
|
|
19709
|
+
* @example user
|
|
19710
|
+
*/
|
|
19711
|
+
resourceType: string;
|
|
19712
|
+
/** @description The identifier of the resource that was not found */
|
|
19713
|
+
resourceId: string;
|
|
19714
|
+
};
|
|
19715
|
+
};
|
|
19716
|
+
};
|
|
19717
|
+
/** @description Response for status 500 */
|
|
19718
|
+
500: {
|
|
19719
|
+
headers: {
|
|
19720
|
+
[name: string]: unknown;
|
|
19721
|
+
};
|
|
19722
|
+
content: {
|
|
19723
|
+
"application/problem+json": {
|
|
19724
|
+
/**
|
|
19725
|
+
* @description A URI reference that identifies the problem type
|
|
19726
|
+
* @default about:blank
|
|
19727
|
+
* @example urn:problem-type:auth:unauthorized
|
|
19728
|
+
*/
|
|
19729
|
+
type: string;
|
|
19730
|
+
/**
|
|
19731
|
+
* @description A short, human-readable summary of the problem type
|
|
19732
|
+
* @example Unauthorized
|
|
19733
|
+
*/
|
|
19734
|
+
title: string;
|
|
19735
|
+
/**
|
|
19736
|
+
* @description The HTTP status code
|
|
19737
|
+
* @example 400
|
|
19738
|
+
*/
|
|
19739
|
+
status: number;
|
|
19740
|
+
/** @description A human-readable explanation specific to this occurrence */
|
|
19741
|
+
detail?: string;
|
|
19742
|
+
/**
|
|
19743
|
+
* @description A URI reference that identifies the specific occurrence
|
|
19744
|
+
* @example /errors/1234567890
|
|
19745
|
+
*/
|
|
19746
|
+
instance?: string;
|
|
19747
|
+
/**
|
|
19748
|
+
* @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.
|
|
19749
|
+
* @example transaction_limit
|
|
19750
|
+
*/
|
|
19751
|
+
code?: string;
|
|
19752
|
+
/**
|
|
19753
|
+
* @description The offending request field, present alongside `code`.
|
|
19754
|
+
* @example amountUsd
|
|
19755
|
+
*/
|
|
19756
|
+
field?: string;
|
|
19757
|
+
/**
|
|
19758
|
+
* @description Whether retrying the same request later may succeed without changing its inputs.
|
|
19759
|
+
* @example true
|
|
19760
|
+
*/
|
|
19761
|
+
retryable?: boolean;
|
|
19762
|
+
/**
|
|
19763
|
+
* @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.
|
|
19764
|
+
* @example 5
|
|
19765
|
+
*/
|
|
19766
|
+
retryAfter?: number;
|
|
19767
|
+
/** @enum {string} */
|
|
19768
|
+
suggestedAction?: "auto_ramp" | "wait_for_settlement";
|
|
19769
|
+
/**
|
|
19770
|
+
* Format: date-time
|
|
19771
|
+
* @description Earliest known time the current temporary condition may clear.
|
|
19772
|
+
*/
|
|
19773
|
+
clearsAt?: string | null;
|
|
19774
|
+
/**
|
|
19775
|
+
* Format: date-time
|
|
19776
|
+
* @description When a temporarily ineligible funding source may become available again.
|
|
19777
|
+
*/
|
|
19778
|
+
availableAt?: string | null;
|
|
19779
|
+
/** @description Whether the current funding-source restriction will not clear automatically. */
|
|
19780
|
+
permanent?: boolean;
|
|
19781
|
+
} & {
|
|
19782
|
+
[key: string]: unknown;
|
|
19783
|
+
};
|
|
19784
|
+
};
|
|
19785
|
+
};
|
|
19786
|
+
};
|
|
19787
|
+
};
|
|
19576
19788
|
postV1IntegratorConnectSessions: {
|
|
19577
19789
|
parameters: {
|
|
19578
19790
|
query?: never;
|
|
@@ -19587,18 +19799,33 @@ interface operations {
|
|
|
19587
19799
|
redirectUri: string;
|
|
19588
19800
|
/** @description Opaque integrator state returned unchanged after approval. */
|
|
19589
19801
|
state?: string;
|
|
19802
|
+
/**
|
|
19803
|
+
* Format: email
|
|
19804
|
+
* @description Email of the existing Spritz user this session is for: pass the email that `POST /v1/integrator/users` rejected with 409. The hosted page shows it and only that account can approve. Recommended; when omitted any signed-in Spritz user can approve.
|
|
19805
|
+
*/
|
|
19806
|
+
email?: string;
|
|
19590
19807
|
};
|
|
19591
19808
|
"application/x-www-form-urlencoded": {
|
|
19592
19809
|
/** @description Callback URI that receives the authorization code. */
|
|
19593
19810
|
redirectUri: string;
|
|
19594
19811
|
/** @description Opaque integrator state returned unchanged after approval. */
|
|
19595
19812
|
state?: string;
|
|
19813
|
+
/**
|
|
19814
|
+
* Format: email
|
|
19815
|
+
* @description Email of the existing Spritz user this session is for: pass the email that `POST /v1/integrator/users` rejected with 409. The hosted page shows it and only that account can approve. Recommended; when omitted any signed-in Spritz user can approve.
|
|
19816
|
+
*/
|
|
19817
|
+
email?: string;
|
|
19596
19818
|
};
|
|
19597
19819
|
"multipart/form-data": {
|
|
19598
19820
|
/** @description Callback URI that receives the authorization code. */
|
|
19599
19821
|
redirectUri: string;
|
|
19600
19822
|
/** @description Opaque integrator state returned unchanged after approval. */
|
|
19601
19823
|
state?: string;
|
|
19824
|
+
/**
|
|
19825
|
+
* Format: email
|
|
19826
|
+
* @description Email of the existing Spritz user this session is for: pass the email that `POST /v1/integrator/users` rejected with 409. The hosted page shows it and only that account can approve. Recommended; when omitted any signed-in Spritz user can approve.
|
|
19827
|
+
*/
|
|
19828
|
+
email?: string;
|
|
19602
19829
|
};
|
|
19603
19830
|
};
|
|
19604
19831
|
};
|
|
@@ -20298,7 +20525,7 @@ interface operations {
|
|
|
20298
20525
|
accessToken: string;
|
|
20299
20526
|
/**
|
|
20300
20527
|
* @description The internal ID of the authorized user
|
|
20301
|
-
* @example
|
|
20528
|
+
* @example 6ac51dfb61ca9c031e3c043e
|
|
20302
20529
|
*/
|
|
20303
20530
|
userId: string;
|
|
20304
20531
|
/**
|
|
@@ -20314,7 +20541,7 @@ interface operations {
|
|
|
20314
20541
|
/**
|
|
20315
20542
|
* Format: date-time
|
|
20316
20543
|
* @description ISO 8601 timestamp when token expires
|
|
20317
|
-
* @example 2026-
|
|
20544
|
+
* @example 2026-10-06T17:12:43.834Z
|
|
20318
20545
|
*/
|
|
20319
20546
|
expiresAt: string;
|
|
20320
20547
|
};
|
|
@@ -20513,7 +20740,7 @@ interface operations {
|
|
|
20513
20740
|
/**
|
|
20514
20741
|
* Format: date-time
|
|
20515
20742
|
* @description ISO 8601 timestamp of when the integrator was created
|
|
20516
|
-
* @example 2026-
|
|
20743
|
+
* @example 2026-10-06T16:12:43.833Z
|
|
20517
20744
|
*/
|
|
20518
20745
|
createdAt: string;
|
|
20519
20746
|
};
|
|
@@ -20726,7 +20953,7 @@ interface operations {
|
|
|
20726
20953
|
"application/json": {
|
|
20727
20954
|
/**
|
|
20728
20955
|
* @description The internal ID of the newly created user
|
|
20729
|
-
* @example
|
|
20956
|
+
* @example 6ac51dfb61ca9c031e3c0440
|
|
20730
20957
|
*/
|
|
20731
20958
|
userId: string;
|
|
20732
20959
|
/**
|
|
@@ -21070,7 +21297,7 @@ interface operations {
|
|
|
21070
21297
|
depositId: string;
|
|
21071
21298
|
/**
|
|
21072
21299
|
* @description Spritz user ID associated with the returned deposit
|
|
21073
|
-
* @example
|
|
21300
|
+
* @example 6ac51dfb61ca9c031e3c043d
|
|
21074
21301
|
*/
|
|
21075
21302
|
userId: string;
|
|
21076
21303
|
/**
|
|
@@ -21282,7 +21509,7 @@ interface operations {
|
|
|
21282
21509
|
depositId: string;
|
|
21283
21510
|
/**
|
|
21284
21511
|
* @description Spritz user ID associated with the returned deposit
|
|
21285
|
-
* @example
|
|
21512
|
+
* @example 6ac51dfb61ca9c031e3c043d
|
|
21286
21513
|
*/
|
|
21287
21514
|
userId: string;
|
|
21288
21515
|
/**
|
|
@@ -21475,7 +21702,7 @@ interface operations {
|
|
|
21475
21702
|
"application/json": {
|
|
21476
21703
|
/**
|
|
21477
21704
|
* @description Unique identifier for the webhook
|
|
21478
|
-
* @example
|
|
21705
|
+
* @example 6ac51dfb61ca9c031e3c043f
|
|
21479
21706
|
*/
|
|
21480
21707
|
id: string;
|
|
21481
21708
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -21706,7 +21933,7 @@ interface operations {
|
|
|
21706
21933
|
"application/json": {
|
|
21707
21934
|
/**
|
|
21708
21935
|
* @description Unique identifier for the webhook
|
|
21709
|
-
* @example
|
|
21936
|
+
* @example 6ac51dfb61ca9c031e3c043f
|
|
21710
21937
|
*/
|
|
21711
21938
|
id: string;
|
|
21712
21939
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -23674,7 +23901,7 @@ interface operations {
|
|
|
23674
23901
|
"application/json": {
|
|
23675
23902
|
/**
|
|
23676
23903
|
* @description Unique identifier for the webhook
|
|
23677
|
-
* @example
|
|
23904
|
+
* @example 6ac51dfb61ca9c031e3c043f
|
|
23678
23905
|
*/
|
|
23679
23906
|
id: string;
|
|
23680
23907
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -24091,7 +24318,7 @@ interface operations {
|
|
|
24091
24318
|
/**
|
|
24092
24319
|
* Format: date-time
|
|
24093
24320
|
* @description ISO 8601 timestamp when the old secret will expire. Only present if a grace period was specified.
|
|
24094
|
-
* @example 2026-
|
|
24321
|
+
* @example 2026-10-06T16:17:43.835Z
|
|
24095
24322
|
*/
|
|
24096
24323
|
oldSecretExpiresAt?: string;
|
|
24097
24324
|
};
|
|
@@ -24262,7 +24489,7 @@ interface operations {
|
|
|
24262
24489
|
"application/json": {
|
|
24263
24490
|
/**
|
|
24264
24491
|
* @description Unique identifier for the user
|
|
24265
|
-
* @example
|
|
24492
|
+
* @example 6ac51dfb61ca9c031e3c043b
|
|
24266
24493
|
*/
|
|
24267
24494
|
id: string;
|
|
24268
24495
|
/**
|
|
@@ -24279,7 +24506,7 @@ interface operations {
|
|
|
24279
24506
|
/**
|
|
24280
24507
|
* Format: date-time
|
|
24281
24508
|
* @description ISO 8601 timestamp of when the user was created
|
|
24282
|
-
* @example 2026-
|
|
24509
|
+
* @example 2026-10-06T16:12:43.824Z
|
|
24283
24510
|
*/
|
|
24284
24511
|
signedUpAt: string;
|
|
24285
24512
|
/**
|
|
@@ -24310,6 +24537,14 @@ interface operations {
|
|
|
24310
24537
|
* @enum {string|null}
|
|
24311
24538
|
*/
|
|
24312
24539
|
failureReason: "verify_sms" | "documentary_verification" | "risk_check" | "kyc_check" | "address_invalid" | "selfie_check" | "watchlist_screening" | "vpn_detected" | "duplicate_identity" | null;
|
|
24540
|
+
/** @description Set only when failureReason is duplicate_identity and the matched account belongs to the same integrator and matched the user on government ID number, full name and date of birth; null otherwise, including duplicates matched on fewer of those or only on phone or address, and matches under another integrator. */
|
|
24541
|
+
duplicateIdentity: {
|
|
24542
|
+
/**
|
|
24543
|
+
* @description Masked email of the matched account, lowercased. Before any `+` tag, shows the first two and last two characters from 8 characters, the first and last from 5, otherwise the first only, with a fixed `****` between. A `+` tag and the domain are shown in full. The raw email is never returned.
|
|
24544
|
+
* @example ja****oe@gmail.com
|
|
24545
|
+
*/
|
|
24546
|
+
maskedEmail: string;
|
|
24547
|
+
} | null;
|
|
24313
24548
|
/**
|
|
24314
24549
|
* @description ISO 3166-1 alpha-2 country code where user was verified
|
|
24315
24550
|
* @example US
|
|
@@ -24651,7 +24886,7 @@ interface operations {
|
|
|
24651
24886
|
"application/json": {
|
|
24652
24887
|
/**
|
|
24653
24888
|
* @description Unique identifier for the user
|
|
24654
|
-
* @example
|
|
24889
|
+
* @example 6ac51dfb61ca9c031e3c043b
|
|
24655
24890
|
*/
|
|
24656
24891
|
id: string;
|
|
24657
24892
|
/**
|
|
@@ -24668,7 +24903,7 @@ interface operations {
|
|
|
24668
24903
|
/**
|
|
24669
24904
|
* Format: date-time
|
|
24670
24905
|
* @description ISO 8601 timestamp of when the user was created
|
|
24671
|
-
* @example 2026-
|
|
24906
|
+
* @example 2026-10-06T16:12:43.824Z
|
|
24672
24907
|
*/
|
|
24673
24908
|
signedUpAt: string;
|
|
24674
24909
|
/**
|
|
@@ -24700,6 +24935,14 @@ interface operations {
|
|
|
24700
24935
|
* @enum {string|null}
|
|
24701
24936
|
*/
|
|
24702
24937
|
failureReason: "verify_sms" | "documentary_verification" | "risk_check" | "kyc_check" | "address_invalid" | "selfie_check" | "watchlist_screening" | "vpn_detected" | "duplicate_identity" | null;
|
|
24938
|
+
/** @description Set only when failureReason is duplicate_identity and the matched account belongs to the same integrator and matched the user on government ID number, full name and date of birth; null otherwise, including duplicates matched on fewer of those or only on phone or address, and matches under another integrator. */
|
|
24939
|
+
duplicateIdentity: {
|
|
24940
|
+
/**
|
|
24941
|
+
* @description Masked email of the matched account, lowercased. Before any `+` tag, shows the first two and last two characters from 8 characters, the first and last from 5, otherwise the first only, with a fixed `****` between. A `+` tag and the domain are shown in full. The raw email is never returned.
|
|
24942
|
+
* @example ja****oe@gmail.com
|
|
24943
|
+
*/
|
|
24944
|
+
maskedEmail: string;
|
|
24945
|
+
} | null;
|
|
24703
24946
|
/**
|
|
24704
24947
|
* @description ISO 3166-1 alpha-2 country code where user was verified
|
|
24705
24948
|
* @example US
|
|
@@ -25140,7 +25383,7 @@ interface operations {
|
|
|
25140
25383
|
"application/json": {
|
|
25141
25384
|
/**
|
|
25142
25385
|
* @description Unique identifier for the user
|
|
25143
|
-
* @example
|
|
25386
|
+
* @example 6ac51dfb61ca9c031e3c043b
|
|
25144
25387
|
*/
|
|
25145
25388
|
id: string;
|
|
25146
25389
|
/**
|
|
@@ -25157,7 +25400,7 @@ interface operations {
|
|
|
25157
25400
|
/**
|
|
25158
25401
|
* Format: date-time
|
|
25159
25402
|
* @description ISO 8601 timestamp of when the user was created
|
|
25160
|
-
* @example 2026-
|
|
25403
|
+
* @example 2026-10-06T16:12:43.824Z
|
|
25161
25404
|
*/
|
|
25162
25405
|
signedUpAt: string;
|
|
25163
25406
|
/**
|
|
@@ -25189,6 +25432,14 @@ interface operations {
|
|
|
25189
25432
|
* @enum {string|null}
|
|
25190
25433
|
*/
|
|
25191
25434
|
failureReason: "verify_sms" | "documentary_verification" | "risk_check" | "kyc_check" | "address_invalid" | "selfie_check" | "watchlist_screening" | "vpn_detected" | "duplicate_identity" | null;
|
|
25435
|
+
/** @description Set only when failureReason is duplicate_identity and the matched account belongs to the same integrator and matched the user on government ID number, full name and date of birth; null otherwise, including duplicates matched on fewer of those or only on phone or address, and matches under another integrator. */
|
|
25436
|
+
duplicateIdentity: {
|
|
25437
|
+
/**
|
|
25438
|
+
* @description Masked email of the matched account, lowercased. Before any `+` tag, shows the first two and last two characters from 8 characters, the first and last from 5, otherwise the first only, with a fixed `****` between. A `+` tag and the domain are shown in full. The raw email is never returned.
|
|
25439
|
+
* @example ja****oe@gmail.com
|
|
25440
|
+
*/
|
|
25441
|
+
maskedEmail: string;
|
|
25442
|
+
} | null;
|
|
25192
25443
|
/**
|
|
25193
25444
|
* @description ISO 3166-1 alpha-2 country code where user was verified
|
|
25194
25445
|
* @example US
|
|
@@ -40067,6 +40318,38 @@ declare class SpritzClient {
|
|
|
40067
40318
|
private makeStatusError;
|
|
40068
40319
|
}
|
|
40069
40320
|
|
|
40321
|
+
type CreateConnectSessionParams = PathRequestBody<'/v1/integrator/connect/sessions', 'post'>;
|
|
40322
|
+
type ConnectSession = PathResponse<'/v1/integrator/connect/sessions', 'post'>;
|
|
40323
|
+
type ConnectTokenExchange = PathResponse<'/v1/integrator/connect/token', 'post'>;
|
|
40324
|
+
/**
|
|
40325
|
+
* Spritz Connect: let an existing Spritz user authorize your integrator.
|
|
40326
|
+
*
|
|
40327
|
+
* Use it when `user.createUser` fails with a `ConflictError` whose
|
|
40328
|
+
* `problem.code` is `USER_ALREADY_EXISTS` (the email already has a Spritz account):
|
|
40329
|
+
*
|
|
40330
|
+
* 1. `createSession({ redirectUri, state, email })` on your backend, passing the
|
|
40331
|
+
* email that was rejected. Send the user to `authorizationUrl` unchanged
|
|
40332
|
+
* (it carries a `#return_token` fragment; never log it). On mobile open it
|
|
40333
|
+
* in the system auth session, not a WebView.
|
|
40334
|
+
* 2. Spritz redirects to `redirectUri` with `code` and your `state`, or with
|
|
40335
|
+
* `error=access_denied | server_error | session_expired`.
|
|
40336
|
+
* 3. Verify `state`, then `exchangeCode(code)` for the user's API key. Store it
|
|
40337
|
+
* server-side only.
|
|
40338
|
+
*
|
|
40339
|
+
* `redirectUri` must exactly match a callback URL Spritz has registered for your
|
|
40340
|
+
* integrator. Both calls need integrator HMAC credentials
|
|
40341
|
+
* (`integrationKey` + `integratorSecret`).
|
|
40342
|
+
*/
|
|
40343
|
+
declare class ConnectService {
|
|
40344
|
+
private client;
|
|
40345
|
+
constructor(client: SpritzClient);
|
|
40346
|
+
private requireIntegratorAuth;
|
|
40347
|
+
/** Start a Connect session. Sessions last 10 minutes. */
|
|
40348
|
+
createSession(args: CreateConnectSessionParams): Promise<ConnectSession>;
|
|
40349
|
+
/** Exchange the single-use authorization code for the user's API key. */
|
|
40350
|
+
exchangeCode(code: string): Promise<ConnectTokenExchange>;
|
|
40351
|
+
}
|
|
40352
|
+
|
|
40070
40353
|
type AchDebitEligibilityRequest = PathRequestBody<'/v1/ach-debit/eligibility', 'post'>;
|
|
40071
40354
|
type AchDebitEligibilityResponse = PathResponse<'/v1/ach-debit/eligibility', 'post'>;
|
|
40072
40355
|
declare class AchDebitService {
|
|
@@ -43353,8 +43636,11 @@ declare class UserService {
|
|
|
43353
43636
|
* Without a secret it uses the legacy `/users/integration` route, which does not
|
|
43354
43637
|
* accept Developer Console credentials.
|
|
43355
43638
|
*
|
|
43356
|
-
* On the REST route
|
|
43357
|
-
*
|
|
43639
|
+
* On the REST route a conflict is a `ConflictError` (409). Branch on `problem.code`:
|
|
43640
|
+
* `USER_ALREADY_EXISTS` means the email already has a Spritz account, so use Spritz
|
|
43641
|
+
* Connect (`client.connect.createSession` with that email) to have the existing user
|
|
43642
|
+
* authorize the integrator; `USER_CREATE_IN_PROGRESS` means another request is
|
|
43643
|
+
* creating that user, so retry shortly.
|
|
43358
43644
|
*/
|
|
43359
43645
|
createUser(args: CreateUserParams): Promise<CreateUserResponse>;
|
|
43360
43646
|
create(args: CreateUserParams): Promise<CreateUserResponse>;
|
|
@@ -43380,6 +43666,9 @@ declare class UserService {
|
|
|
43380
43666
|
verification: {
|
|
43381
43667
|
status: "not_started" | "verified" | "failed" | "disabled" | "retry" | "under_review";
|
|
43382
43668
|
failureReason: "verify_sms" | "documentary_verification" | "risk_check" | "kyc_check" | "address_invalid" | "selfie_check" | "watchlist_screening" | "vpn_detected" | "duplicate_identity" | null;
|
|
43669
|
+
duplicateIdentity: {
|
|
43670
|
+
maskedEmail: string;
|
|
43671
|
+
} | null;
|
|
43383
43672
|
country: string | null;
|
|
43384
43673
|
requirement?: {
|
|
43385
43674
|
type: "identity_verification" | "terms_acceptance" | "additional_verification" | "document_submission" | "region_restriction" | "regional_compliance";
|
|
@@ -43639,6 +43928,7 @@ declare class SpritzApiClient {
|
|
|
43639
43928
|
institution: InstitutionService;
|
|
43640
43929
|
sandbox: SandboxService;
|
|
43641
43930
|
webhook: WebhookService;
|
|
43931
|
+
connect: ConnectService;
|
|
43642
43932
|
constructor(environment: Environment, apiKey?: string, integrationKey?: string, integratorSecret?: string, dangerouslyAllowBrowser?: boolean);
|
|
43643
43933
|
static initialize({ environment, apiKey, integrationKey, integratorSecret, dangerouslyAllowBrowser, }: ClientOptions): SpritzApiClient;
|
|
43644
43934
|
private init;
|
|
@@ -43794,4 +44084,4 @@ declare function hasProblemCode<T extends string>(error: unknown, code: T): erro
|
|
|
43794
44084
|
};
|
|
43795
44085
|
|
|
43796
44086
|
export { APIConnectionError, APIConnectionTimeoutError, APIError, APIUserAbortError, AmountMode, AuthenticationError, BadRequestError, BankAccountSubType, BankAccountType, BillType, CardFeatureType, ConflictError, DebitCardNetwork, Environment, InternalServerError, NotFoundError, OfframpFeatureType, OnrampFeatureType, PayableAccountType, PaymentDeliveryMethod, PaymentNetwork, DirectPaymentStatus as PaymentRequestStatus, PaymentStatus, PermissionDeniedError, RateLimitError, RequirementType, SpritzApiClient, SpritzApiError, UnprocessableEntityError, VirtualCardType, hasProblemCode, hasProblemType, isAPIError, onrampSupportedTokens };
|
|
43797
|
-
export type { AcceptTermsRequest, AcceptTermsResponse, AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitEligibilityRequest, AchDebitEligibilityResponse, AchDebitExposureResponse, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, AutoRampAccount, AutoRampAccountEstimate, AutoRampAccountList, BankAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BankAccountList, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, ComplianceRequirementField, ComplianceRequirements, CreateAutoRampAccountRequest, CreateBankAccountInput, CreateBankAccountResponse, CreateDepositOptions, CreateDepositRequest, CreateDepositWithReturnRequest, CreateDepositWithReturnResponse, CreateDirectPaymentInput, CreateOffRampQuoteRequest, CreateOnrampPaymentInput, CreatePaymentRequestInput, CreateVirtualAccountInput, CreateWebhookParams, CurrentUser, CurrentUser_me, CurrentUser_verification, CurrentUser_verification_identity, CurrentUser_verification_identity_verificationMetadata, CurrentUser_verification_identity_verificationMetadata_details, DebitCardFragment, DebitCardInput, DeleteBankAccountResponse, DeleteFundingSourceResponse, Deposit, DepositListQuery, DepositListResponse, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkBankAccountRequest, LinkBankAccountResponse, LinkTokenResponse, OffRampQuote, OffRampQuoteTransaction, OffRampQuoteTransactionRequest, OffRampRefundRequest, OffRampRefundResponse, OnRamp, OnRampDetail, OnRampListQuery, OnRampListResponse, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PathParams, PathQuery, PathRequestBody, PathResponse, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentFragment_transaction, PaymentLimits, PaymentLimitsResponse, PaymentLimitsVariables, PaymentLimits_paymentLimits, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, PrepareDepositRequest, PrepareDepositResponse, PrepareDepositWithProgramControlRequest, PrepareDepositWithProgramControlResponse, ProblemDetails, ProblemFieldError, ProblemSuggestedAction, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, SetAchDebitExposureCapRequest, SetAchDebitExposureCapResponse, SimulateAutoRampDepositRequest, SimulateAutoRampDepositResponse, SubmitComplianceRequest, SubmitComplianceResponse, SubmitOffRampQuoteRequest, TokenBalanceFragment, UpdateWebhookParams, UpdateWebhookSecretResponse, UserAccess, UserAccessCapabilities, UserAccess_bridgeUser, UserAccess_me, UserAccess_verification, UserAccess_verification_identity, UserAccess_verification_identity_verificationMetadata, UserAccess_verification_identity_verificationMetadata_details, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, UserProfile, UserVerification, UserVerification_verification, UserVerification_verification_identity, UserVerification_verification_identity_user, UserVerification_verification_identity_verificationMetadata, UserVerification_verification_identity_verificationMetadata_details, UserVirtualDebitCard, UserVirtualDebitCard_virtualDebitCard, UserVirtualDebitCard_virtualDebitCard_billingInfo, UserVirtualDebitCard_virtualDebitCard_billingInfo_address, UserVirtualDebitCard_virtualDebitCard_paymentAddresses, VerificationFragment, VerificationFragment_identity, VerificationFragment_identity_verificationMetadata, VerificationFragment_identity_verificationMetadata_details, VerificationSession, VirtualAccountFragment, VirtualAccountFragment_depositInstructions, VirtualAccounts, VirtualAccounts_virtualAccounts, VirtualAccounts_virtualAccounts_depositInstructions, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances, WebhookEvent };
|
|
44087
|
+
export type { AcceptTermsRequest, AcceptTermsResponse, AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitEligibilityRequest, AchDebitEligibilityResponse, AchDebitExposureResponse, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, AutoRampAccount, AutoRampAccountEstimate, AutoRampAccountList, BankAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BankAccountList, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, ComplianceRequirementField, ComplianceRequirements, ConnectSession, ConnectTokenExchange, CreateAutoRampAccountRequest, CreateBankAccountInput, CreateBankAccountResponse, CreateConnectSessionParams, CreateDepositOptions, CreateDepositRequest, CreateDepositWithReturnRequest, CreateDepositWithReturnResponse, CreateDirectPaymentInput, CreateOffRampQuoteRequest, CreateOnrampPaymentInput, CreatePaymentRequestInput, CreateVirtualAccountInput, CreateWebhookParams, CurrentUser, CurrentUser_me, CurrentUser_verification, CurrentUser_verification_identity, CurrentUser_verification_identity_verificationMetadata, CurrentUser_verification_identity_verificationMetadata_details, DebitCardFragment, DebitCardInput, DeleteBankAccountResponse, DeleteFundingSourceResponse, Deposit, DepositListQuery, DepositListResponse, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkBankAccountRequest, LinkBankAccountResponse, LinkTokenResponse, OffRampQuote, OffRampQuoteTransaction, OffRampQuoteTransactionRequest, OffRampRefundRequest, OffRampRefundResponse, OnRamp, OnRampDetail, OnRampListQuery, OnRampListResponse, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PathParams, PathQuery, PathRequestBody, PathResponse, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentFragment_transaction, PaymentLimits, PaymentLimitsResponse, PaymentLimitsVariables, PaymentLimits_paymentLimits, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, PrepareDepositRequest, PrepareDepositResponse, PrepareDepositWithProgramControlRequest, PrepareDepositWithProgramControlResponse, ProblemDetails, ProblemFieldError, ProblemSuggestedAction, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, SetAchDebitExposureCapRequest, SetAchDebitExposureCapResponse, SimulateAutoRampDepositRequest, SimulateAutoRampDepositResponse, SubmitComplianceRequest, SubmitComplianceResponse, SubmitOffRampQuoteRequest, TokenBalanceFragment, UpdateWebhookParams, UpdateWebhookSecretResponse, UserAccess, UserAccessCapabilities, UserAccess_bridgeUser, UserAccess_me, UserAccess_verification, UserAccess_verification_identity, UserAccess_verification_identity_verificationMetadata, UserAccess_verification_identity_verificationMetadata_details, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, UserProfile, UserVerification, UserVerification_verification, UserVerification_verification_identity, UserVerification_verification_identity_user, UserVerification_verification_identity_verificationMetadata, UserVerification_verification_identity_verificationMetadata_details, UserVirtualDebitCard, UserVirtualDebitCard_virtualDebitCard, UserVirtualDebitCard_virtualDebitCard_billingInfo, UserVirtualDebitCard_virtualDebitCard_billingInfo_address, UserVirtualDebitCard_virtualDebitCard_paymentAddresses, VerificationFragment, VerificationFragment_identity, VerificationFragment_identity_verificationMetadata, VerificationFragment_identity_verificationMetadata_details, VerificationSession, VirtualAccountFragment, VirtualAccountFragment_depositInstructions, VirtualAccounts, VirtualAccounts_virtualAccounts, VirtualAccounts_virtualAccounts_depositInstructions, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances, WebhookEvent };
|