@spritz-finance/api-client 0.9.0 → 0.10.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 +127 -0
- package/dist/spritz-api-client.cjs +35 -35
- package/dist/spritz-api-client.d.ts +987 -122
- package/dist/spritz-api-client.mjs +35 -35
- package/package.json +1 -1
|
@@ -197,6 +197,33 @@ interface paths {
|
|
|
197
197
|
patch?: never;
|
|
198
198
|
trace?: never;
|
|
199
199
|
};
|
|
200
|
+
"/v1/off-ramps/{offRampId}/refund": {
|
|
201
|
+
parameters: {
|
|
202
|
+
query?: never;
|
|
203
|
+
header?: never;
|
|
204
|
+
path?: never;
|
|
205
|
+
cookie?: never;
|
|
206
|
+
};
|
|
207
|
+
get?: never;
|
|
208
|
+
put?: never;
|
|
209
|
+
/**
|
|
210
|
+
* Refund an off-ramp
|
|
211
|
+
* @description Refunds a **failed** off-ramp payment. Choose how the funds are returned:
|
|
212
|
+
*
|
|
213
|
+
* - `credit`: Return the funds to the user's Spritz balance.
|
|
214
|
+
* - `account`: Reissue the payout to a bank account — pass `accountId`, or omit it to reuse the original destination account.
|
|
215
|
+
*
|
|
216
|
+
* Only failed Modern Treasury and Checkbook off-ramps can be refunded.
|
|
217
|
+
*
|
|
218
|
+
* **Recommended:** send an `Idempotency-Key` header (a unique key per refund, reused verbatim on retries) so a timed-out request that is retried replays the original response instead of returning a stale "not refundable" error.
|
|
219
|
+
*/
|
|
220
|
+
post: operations["postV1Off-rampsByOffRampIdRefund"];
|
|
221
|
+
delete?: never;
|
|
222
|
+
options?: never;
|
|
223
|
+
head?: never;
|
|
224
|
+
patch?: never;
|
|
225
|
+
trace?: never;
|
|
226
|
+
};
|
|
200
227
|
"/v1/on-ramps/": {
|
|
201
228
|
parameters: {
|
|
202
229
|
query?: never;
|
|
@@ -964,6 +991,26 @@ interface paths {
|
|
|
964
991
|
patch?: never;
|
|
965
992
|
trace?: never;
|
|
966
993
|
};
|
|
994
|
+
"/v1/debit-cards/{cardId}/cardholder-info": {
|
|
995
|
+
parameters: {
|
|
996
|
+
query?: never;
|
|
997
|
+
header?: never;
|
|
998
|
+
path?: never;
|
|
999
|
+
cookie?: never;
|
|
1000
|
+
};
|
|
1001
|
+
get?: never;
|
|
1002
|
+
put?: never;
|
|
1003
|
+
post?: never;
|
|
1004
|
+
delete?: never;
|
|
1005
|
+
options?: never;
|
|
1006
|
+
head?: never;
|
|
1007
|
+
/**
|
|
1008
|
+
* Complete debit card details
|
|
1009
|
+
* @description Supplies the cardholder name and billing address for an existing debit card that is missing them (recapture). Clears the card's action_required requirement.
|
|
1010
|
+
*/
|
|
1011
|
+
patch: operations["patchV1Debit-cardsByCardIdCardholder-info"];
|
|
1012
|
+
trace?: never;
|
|
1013
|
+
};
|
|
967
1014
|
"/v1/integrator/connect/sessions": {
|
|
968
1015
|
parameters: {
|
|
969
1016
|
query?: never;
|
|
@@ -2875,7 +2922,7 @@ interface operations {
|
|
|
2875
2922
|
/**
|
|
2876
2923
|
* Format: date-time
|
|
2877
2924
|
* @description Creation timestamp
|
|
2878
|
-
* @example 2026-07-
|
|
2925
|
+
* @example 2026-07-21T13:34:16.847Z
|
|
2879
2926
|
*/
|
|
2880
2927
|
createdAt?: string;
|
|
2881
2928
|
}[];
|
|
@@ -3004,7 +3051,7 @@ interface operations {
|
|
|
3004
3051
|
"application/json": {
|
|
3005
3052
|
/**
|
|
3006
3053
|
* @description Destination account ID
|
|
3007
|
-
* @example
|
|
3054
|
+
* @example 6a5f75585a936eb477232f02
|
|
3008
3055
|
*/
|
|
3009
3056
|
accountId: string;
|
|
3010
3057
|
/**
|
|
@@ -3032,7 +3079,7 @@ interface operations {
|
|
|
3032
3079
|
"application/x-www-form-urlencoded": {
|
|
3033
3080
|
/**
|
|
3034
3081
|
* @description Destination account ID
|
|
3035
|
-
* @example
|
|
3082
|
+
* @example 6a5f75585a936eb477232f02
|
|
3036
3083
|
*/
|
|
3037
3084
|
accountId: string;
|
|
3038
3085
|
/**
|
|
@@ -3060,7 +3107,7 @@ interface operations {
|
|
|
3060
3107
|
"multipart/form-data": {
|
|
3061
3108
|
/**
|
|
3062
3109
|
* @description Destination account ID
|
|
3063
|
-
* @example
|
|
3110
|
+
* @example 6a5f75585a936eb477232f02
|
|
3064
3111
|
*/
|
|
3065
3112
|
accountId: string;
|
|
3066
3113
|
/**
|
|
@@ -3107,7 +3154,7 @@ interface operations {
|
|
|
3107
3154
|
/**
|
|
3108
3155
|
* Format: date-time
|
|
3109
3156
|
* @description When the quote was created
|
|
3110
|
-
* @example 2026-07-
|
|
3157
|
+
* @example 2026-07-21T13:34:16.781Z
|
|
3111
3158
|
*/
|
|
3112
3159
|
createdAt: string;
|
|
3113
3160
|
/** @description What the user pays — total USD cost and token used. */
|
|
@@ -3146,7 +3193,7 @@ interface operations {
|
|
|
3146
3193
|
rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
|
|
3147
3194
|
/**
|
|
3148
3195
|
* @description Destination account ID
|
|
3149
|
-
* @example
|
|
3196
|
+
* @example 6a5f75585a936eb477232f03
|
|
3150
3197
|
*/
|
|
3151
3198
|
accountId: string;
|
|
3152
3199
|
};
|
|
@@ -3343,7 +3390,7 @@ interface operations {
|
|
|
3343
3390
|
/**
|
|
3344
3391
|
* Format: date-time
|
|
3345
3392
|
* @description When the quote was created
|
|
3346
|
-
* @example 2026-07-
|
|
3393
|
+
* @example 2026-07-21T13:34:16.781Z
|
|
3347
3394
|
*/
|
|
3348
3395
|
createdAt: string;
|
|
3349
3396
|
/** @description What the user pays — total USD cost and token used. */
|
|
@@ -3382,7 +3429,7 @@ interface operations {
|
|
|
3382
3429
|
rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
|
|
3383
3430
|
/**
|
|
3384
3431
|
* @description Destination account ID
|
|
3385
|
-
* @example
|
|
3432
|
+
* @example 6a5f75585a936eb477232f03
|
|
3386
3433
|
*/
|
|
3387
3434
|
accountId: string;
|
|
3388
3435
|
};
|
|
@@ -3798,7 +3845,7 @@ interface operations {
|
|
|
3798
3845
|
"getV1Off-ramps": {
|
|
3799
3846
|
parameters: {
|
|
3800
3847
|
query?: {
|
|
3801
|
-
limit?:
|
|
3848
|
+
limit?: number;
|
|
3802
3849
|
cursor?: string;
|
|
3803
3850
|
status?: "awaiting_funding" | "queued" | "in_flight" | "completed" | "canceled" | "failed" | "reversed" | "refunded";
|
|
3804
3851
|
chain?: "ethereum" | "polygon" | "arbitrum" | "base" | "optimism" | "avalanche" | "binance-smart-chain" | "solana" | "bitcoin" | "dash" | "tron" | "sui" | "hyperevm" | "monad" | "sonic" | "unichain";
|
|
@@ -3865,7 +3912,7 @@ interface operations {
|
|
|
3865
3912
|
currency: string;
|
|
3866
3913
|
/**
|
|
3867
3914
|
* @description Destination account ID
|
|
3868
|
-
* @example
|
|
3915
|
+
* @example 6a5f75585a936eb477232f04
|
|
3869
3916
|
*/
|
|
3870
3917
|
accountId: string;
|
|
3871
3918
|
/**
|
|
@@ -4048,7 +4095,243 @@ interface operations {
|
|
|
4048
4095
|
};
|
|
4049
4096
|
};
|
|
4050
4097
|
};
|
|
4051
|
-
"getV1Off-rampsByOffRampId": {
|
|
4098
|
+
"getV1Off-rampsByOffRampId": {
|
|
4099
|
+
parameters: {
|
|
4100
|
+
query?: never;
|
|
4101
|
+
header?: never;
|
|
4102
|
+
path: {
|
|
4103
|
+
offRampId: string;
|
|
4104
|
+
};
|
|
4105
|
+
cookie?: never;
|
|
4106
|
+
};
|
|
4107
|
+
requestBody?: never;
|
|
4108
|
+
responses: {
|
|
4109
|
+
/** @description Response for status 200 */
|
|
4110
|
+
200: {
|
|
4111
|
+
headers: {
|
|
4112
|
+
[name: string]: unknown;
|
|
4113
|
+
};
|
|
4114
|
+
content: {
|
|
4115
|
+
"application/json": {
|
|
4116
|
+
/**
|
|
4117
|
+
* @description Unique off-ramp identifier
|
|
4118
|
+
* @example offramp_xyz789
|
|
4119
|
+
*/
|
|
4120
|
+
id: string;
|
|
4121
|
+
/** @enum {string} */
|
|
4122
|
+
status: "awaiting_funding" | "queued" | "in_flight" | "completed" | "canceled" | "failed" | "reversed" | "refunded";
|
|
4123
|
+
/** Format: date-time */
|
|
4124
|
+
createdAt: string;
|
|
4125
|
+
/**
|
|
4126
|
+
* Format: date-time
|
|
4127
|
+
* @description When the off-ramp was completed. Null until status is completed.
|
|
4128
|
+
*/
|
|
4129
|
+
completedAt: string | null;
|
|
4130
|
+
/** @description What the user paid — crypto asset and chain. */
|
|
4131
|
+
input: {
|
|
4132
|
+
/**
|
|
4133
|
+
* @description Crypto amount sent
|
|
4134
|
+
* @example 0.25
|
|
4135
|
+
*/
|
|
4136
|
+
amount: string;
|
|
4137
|
+
/**
|
|
4138
|
+
* @description Token symbol
|
|
4139
|
+
* @example USDC
|
|
4140
|
+
*/
|
|
4141
|
+
token: string;
|
|
4142
|
+
/**
|
|
4143
|
+
* @description Blockchain network the crypto transaction occurs on
|
|
4144
|
+
* @example ethereum
|
|
4145
|
+
*/
|
|
4146
|
+
chain: "ethereum" | "polygon" | "arbitrum" | "base" | "optimism" | "avalanche" | "binance-smart-chain" | "solana" | "bitcoin" | "dash" | "tron" | "sui" | "hyperevm" | "monad" | "sonic" | "unichain";
|
|
4147
|
+
} | null;
|
|
4148
|
+
/** @description What the destination receives — fiat delivery details. */
|
|
4149
|
+
output: {
|
|
4150
|
+
/**
|
|
4151
|
+
* @description Fiat amount delivered
|
|
4152
|
+
* @example 100.00
|
|
4153
|
+
*/
|
|
4154
|
+
amount: string;
|
|
4155
|
+
/**
|
|
4156
|
+
* @description Fiat currency code
|
|
4157
|
+
* @example USD
|
|
4158
|
+
*/
|
|
4159
|
+
currency: string;
|
|
4160
|
+
/**
|
|
4161
|
+
* @description Destination account ID
|
|
4162
|
+
* @example 6a5f75585a936eb477232f04
|
|
4163
|
+
*/
|
|
4164
|
+
accountId: string;
|
|
4165
|
+
/**
|
|
4166
|
+
* @description Display name of the destination account
|
|
4167
|
+
* @example Chase Checking ••4567
|
|
4168
|
+
*/
|
|
4169
|
+
accountName: string | null;
|
|
4170
|
+
/**
|
|
4171
|
+
* @description Fiat delivery rail.
|
|
4172
|
+
*
|
|
4173
|
+
* - `ach_standard`: ACH bank transfer, next business day.
|
|
4174
|
+
* - `ach_same_day`: ACH same-day transfer, delivered same business day.
|
|
4175
|
+
* - `rtp`: Real-time payment, seconds, 24/7.
|
|
4176
|
+
* - `wire`: Wire transfer, same/next day.
|
|
4177
|
+
* - `eft`: Electronic funds transfer, 1-2 business days.
|
|
4178
|
+
* - `sepa`: SEPA transfer (EU), 1-2 business days.
|
|
4179
|
+
* - `faster_payments`: UK Faster Payments, near-instant.
|
|
4180
|
+
* - `push_to_card`: Push to debit card, minutes.
|
|
4181
|
+
* - `bill_pay`: Bill payment rail.
|
|
4182
|
+
* - `card_deposit`: Deposit to crypto card.
|
|
4183
|
+
* @example ach_standard
|
|
4184
|
+
*/
|
|
4185
|
+
rail: ("ach_standard" | null) | ("ach_same_day" | null) | ("rtp" | null) | ("wire" | null) | ("eft" | null) | ("sepa" | null) | ("faster_payments" | null) | ("push_to_card" | null) | ("bill_pay" | null) | ("card_deposit" | null);
|
|
4186
|
+
};
|
|
4187
|
+
/**
|
|
4188
|
+
* @description Type of fiat destination.
|
|
4189
|
+
*
|
|
4190
|
+
* - `bank_account`: Bank account (includes debit card destinations).
|
|
4191
|
+
* - `bill`: Bill payment.
|
|
4192
|
+
* - `crypto_card`: Crypto card deposit.
|
|
4193
|
+
* @example bank_account
|
|
4194
|
+
*/
|
|
4195
|
+
fiatDestination: ("bank_account" | null) | ("bill" | null) | ("crypto_card" | null);
|
|
4196
|
+
fees: {
|
|
4197
|
+
/**
|
|
4198
|
+
* @description Fee amount
|
|
4199
|
+
* @example 1.25
|
|
4200
|
+
*/
|
|
4201
|
+
amount: string;
|
|
4202
|
+
/**
|
|
4203
|
+
* @description Fee currency code
|
|
4204
|
+
* @example USD
|
|
4205
|
+
*/
|
|
4206
|
+
currency: string;
|
|
4207
|
+
} | null;
|
|
4208
|
+
transaction: {
|
|
4209
|
+
/**
|
|
4210
|
+
* @description Blockchain transaction hash
|
|
4211
|
+
* @example 0xabc123...
|
|
4212
|
+
*/
|
|
4213
|
+
hash: string | null;
|
|
4214
|
+
/**
|
|
4215
|
+
* @description Block explorer transaction URL
|
|
4216
|
+
* @example https://etherscan.io/tx/0xabc123...
|
|
4217
|
+
*/
|
|
4218
|
+
explorerUrl: string | null;
|
|
4219
|
+
} | null;
|
|
4220
|
+
};
|
|
4221
|
+
};
|
|
4222
|
+
};
|
|
4223
|
+
/** @description Response for status 401 */
|
|
4224
|
+
401: {
|
|
4225
|
+
headers: {
|
|
4226
|
+
[name: string]: unknown;
|
|
4227
|
+
};
|
|
4228
|
+
content: {
|
|
4229
|
+
"application/json": {
|
|
4230
|
+
/**
|
|
4231
|
+
* @description A URI reference that identifies the problem type
|
|
4232
|
+
* @default about:blank
|
|
4233
|
+
* @example urn:problem-type:auth:unauthorized
|
|
4234
|
+
*/
|
|
4235
|
+
type: string;
|
|
4236
|
+
/**
|
|
4237
|
+
* @description A short, human-readable summary of the problem type
|
|
4238
|
+
* @example Unauthorized
|
|
4239
|
+
*/
|
|
4240
|
+
title: string;
|
|
4241
|
+
/**
|
|
4242
|
+
* @description The HTTP status code
|
|
4243
|
+
* @example 401
|
|
4244
|
+
*/
|
|
4245
|
+
status: number;
|
|
4246
|
+
/**
|
|
4247
|
+
* @description A human-readable explanation specific to this occurrence
|
|
4248
|
+
* @example Bearer token required
|
|
4249
|
+
*/
|
|
4250
|
+
detail?: string;
|
|
4251
|
+
/** @description A URI reference that identifies the specific occurrence */
|
|
4252
|
+
instance?: string;
|
|
4253
|
+
/**
|
|
4254
|
+
* @description The authentication realm
|
|
4255
|
+
* @example API
|
|
4256
|
+
*/
|
|
4257
|
+
realm?: string;
|
|
4258
|
+
/**
|
|
4259
|
+
* @description The required scope for this resource
|
|
4260
|
+
* @example read:users
|
|
4261
|
+
*/
|
|
4262
|
+
scope?: string;
|
|
4263
|
+
};
|
|
4264
|
+
};
|
|
4265
|
+
};
|
|
4266
|
+
/** @description Response for status 404 */
|
|
4267
|
+
404: {
|
|
4268
|
+
headers: {
|
|
4269
|
+
[name: string]: unknown;
|
|
4270
|
+
};
|
|
4271
|
+
content: {
|
|
4272
|
+
"application/json": {
|
|
4273
|
+
/**
|
|
4274
|
+
* @description A URI reference that identifies the problem type
|
|
4275
|
+
* @default about:blank
|
|
4276
|
+
*/
|
|
4277
|
+
type: string;
|
|
4278
|
+
/** @description A short, human-readable summary of the problem type */
|
|
4279
|
+
title: string;
|
|
4280
|
+
/**
|
|
4281
|
+
* @description The HTTP status code
|
|
4282
|
+
* @example 404
|
|
4283
|
+
*/
|
|
4284
|
+
status: number;
|
|
4285
|
+
/** @description A human-readable explanation specific to this occurrence */
|
|
4286
|
+
detail?: string;
|
|
4287
|
+
/** @description A URI reference that identifies the specific occurrence */
|
|
4288
|
+
instance?: string;
|
|
4289
|
+
/**
|
|
4290
|
+
* @description The type of resource that was not found
|
|
4291
|
+
* @example user
|
|
4292
|
+
*/
|
|
4293
|
+
resourceType: string;
|
|
4294
|
+
/** @description The identifier of the resource that was not found */
|
|
4295
|
+
resourceId: string;
|
|
4296
|
+
};
|
|
4297
|
+
};
|
|
4298
|
+
};
|
|
4299
|
+
/** @description Response for status 500 */
|
|
4300
|
+
500: {
|
|
4301
|
+
headers: {
|
|
4302
|
+
[name: string]: unknown;
|
|
4303
|
+
};
|
|
4304
|
+
content: {
|
|
4305
|
+
"application/json": {
|
|
4306
|
+
/**
|
|
4307
|
+
* @description A URI reference that identifies the problem type
|
|
4308
|
+
* @default about:blank
|
|
4309
|
+
* @example urn:problem-type:auth:unauthorized
|
|
4310
|
+
*/
|
|
4311
|
+
type: string;
|
|
4312
|
+
/**
|
|
4313
|
+
* @description A short, human-readable summary of the problem type
|
|
4314
|
+
* @example Unauthorized
|
|
4315
|
+
*/
|
|
4316
|
+
title: string;
|
|
4317
|
+
/**
|
|
4318
|
+
* @description The HTTP status code
|
|
4319
|
+
* @example 400
|
|
4320
|
+
*/
|
|
4321
|
+
status: number;
|
|
4322
|
+
/** @description A human-readable explanation specific to this occurrence */
|
|
4323
|
+
detail?: string;
|
|
4324
|
+
/**
|
|
4325
|
+
* @description A URI reference that identifies the specific occurrence
|
|
4326
|
+
* @example /errors/1234567890
|
|
4327
|
+
*/
|
|
4328
|
+
instance?: string;
|
|
4329
|
+
};
|
|
4330
|
+
};
|
|
4331
|
+
};
|
|
4332
|
+
};
|
|
4333
|
+
};
|
|
4334
|
+
"postV1Off-rampsByOffRampIdRefund": {
|
|
4052
4335
|
parameters: {
|
|
4053
4336
|
query?: never;
|
|
4054
4337
|
header?: never;
|
|
@@ -4057,7 +4340,70 @@ interface operations {
|
|
|
4057
4340
|
};
|
|
4058
4341
|
cookie?: never;
|
|
4059
4342
|
};
|
|
4060
|
-
|
|
4343
|
+
/**
|
|
4344
|
+
* @description How to refund the off-ramp.
|
|
4345
|
+
*
|
|
4346
|
+
* - `credit`: Return the funds to the user's Spritz balance.
|
|
4347
|
+
* - `account`: Reissue the payout to a bank account (`accountId`, or the original account if omitted).
|
|
4348
|
+
*/
|
|
4349
|
+
requestBody: {
|
|
4350
|
+
content: {
|
|
4351
|
+
"application/json": {
|
|
4352
|
+
/**
|
|
4353
|
+
* @description Return the funds to the user's Spritz balance as credit.
|
|
4354
|
+
* @enum {string}
|
|
4355
|
+
*/
|
|
4356
|
+
method: "credit";
|
|
4357
|
+
} | {
|
|
4358
|
+
/**
|
|
4359
|
+
* @description Reissue the payout to a bank account.
|
|
4360
|
+
* @enum {string}
|
|
4361
|
+
*/
|
|
4362
|
+
method: "account";
|
|
4363
|
+
/**
|
|
4364
|
+
* @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
|
|
4365
|
+
* @example 6a5f75585a936eb477232f05
|
|
4366
|
+
*/
|
|
4367
|
+
accountId?: string;
|
|
4368
|
+
};
|
|
4369
|
+
"application/x-www-form-urlencoded": {
|
|
4370
|
+
/**
|
|
4371
|
+
* @description Return the funds to the user's Spritz balance as credit.
|
|
4372
|
+
* @enum {string}
|
|
4373
|
+
*/
|
|
4374
|
+
method: "credit";
|
|
4375
|
+
} | {
|
|
4376
|
+
/**
|
|
4377
|
+
* @description Reissue the payout to a bank account.
|
|
4378
|
+
* @enum {string}
|
|
4379
|
+
*/
|
|
4380
|
+
method: "account";
|
|
4381
|
+
/**
|
|
4382
|
+
* @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
|
|
4383
|
+
* @example 6a5f75585a936eb477232f05
|
|
4384
|
+
*/
|
|
4385
|
+
accountId?: string;
|
|
4386
|
+
};
|
|
4387
|
+
"multipart/form-data": {
|
|
4388
|
+
/**
|
|
4389
|
+
* @description Return the funds to the user's Spritz balance as credit.
|
|
4390
|
+
* @enum {string}
|
|
4391
|
+
*/
|
|
4392
|
+
method: "credit";
|
|
4393
|
+
} | {
|
|
4394
|
+
/**
|
|
4395
|
+
* @description Reissue the payout to a bank account.
|
|
4396
|
+
* @enum {string}
|
|
4397
|
+
*/
|
|
4398
|
+
method: "account";
|
|
4399
|
+
/**
|
|
4400
|
+
* @description Destination account to reissue the payout to. Omit to reuse the off-ramp's original destination account.
|
|
4401
|
+
* @example 6a5f75585a936eb477232f05
|
|
4402
|
+
*/
|
|
4403
|
+
accountId?: string;
|
|
4404
|
+
};
|
|
4405
|
+
};
|
|
4406
|
+
};
|
|
4061
4407
|
responses: {
|
|
4062
4408
|
/** @description Response for status 200 */
|
|
4063
4409
|
200: {
|
|
@@ -4112,7 +4458,7 @@ interface operations {
|
|
|
4112
4458
|
currency: string;
|
|
4113
4459
|
/**
|
|
4114
4460
|
* @description Destination account ID
|
|
4115
|
-
* @example
|
|
4461
|
+
* @example 6a5f75585a936eb477232f04
|
|
4116
4462
|
*/
|
|
4117
4463
|
accountId: string;
|
|
4118
4464
|
/**
|
|
@@ -4287,7 +4633,7 @@ interface operations {
|
|
|
4287
4633
|
"getV1On-ramps": {
|
|
4288
4634
|
parameters: {
|
|
4289
4635
|
query?: {
|
|
4290
|
-
limit?:
|
|
4636
|
+
limit?: number;
|
|
4291
4637
|
cursor?: string;
|
|
4292
4638
|
network?: "ethereum" | "polygon" | "base" | "arbitrum" | "avalanche" | "optimism" | "solana" | "tron" | "bitcoin";
|
|
4293
4639
|
token?: string;
|
|
@@ -5107,6 +5453,11 @@ interface operations {
|
|
|
5107
5453
|
* @example active
|
|
5108
5454
|
*/
|
|
5109
5455
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
5456
|
+
/**
|
|
5457
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
5458
|
+
* @example account_invalid
|
|
5459
|
+
*/
|
|
5460
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
5110
5461
|
/**
|
|
5111
5462
|
* @description Name of the account holder
|
|
5112
5463
|
* @example John Doe
|
|
@@ -5175,6 +5526,11 @@ interface operations {
|
|
|
5175
5526
|
* @example active
|
|
5176
5527
|
*/
|
|
5177
5528
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
5529
|
+
/**
|
|
5530
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
5531
|
+
* @example account_invalid
|
|
5532
|
+
*/
|
|
5533
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
5178
5534
|
/**
|
|
5179
5535
|
* @description Name of the account holder
|
|
5180
5536
|
* @example John Doe
|
|
@@ -5248,6 +5604,11 @@ interface operations {
|
|
|
5248
5604
|
* @example active
|
|
5249
5605
|
*/
|
|
5250
5606
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
5607
|
+
/**
|
|
5608
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
5609
|
+
* @example account_invalid
|
|
5610
|
+
*/
|
|
5611
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
5251
5612
|
/**
|
|
5252
5613
|
* @description Name of the account holder
|
|
5253
5614
|
* @example John Doe
|
|
@@ -5311,6 +5672,11 @@ interface operations {
|
|
|
5311
5672
|
* @example active
|
|
5312
5673
|
*/
|
|
5313
5674
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
5675
|
+
/**
|
|
5676
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
5677
|
+
* @example account_invalid
|
|
5678
|
+
*/
|
|
5679
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
5314
5680
|
/**
|
|
5315
5681
|
* @description Name of the account holder
|
|
5316
5682
|
* @example John Doe
|
|
@@ -6206,6 +6572,11 @@ interface operations {
|
|
|
6206
6572
|
* @example active
|
|
6207
6573
|
*/
|
|
6208
6574
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
6575
|
+
/**
|
|
6576
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
6577
|
+
* @example account_invalid
|
|
6578
|
+
*/
|
|
6579
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
6209
6580
|
/**
|
|
6210
6581
|
* @description Name of the account holder
|
|
6211
6582
|
* @example John Doe
|
|
@@ -6274,6 +6645,11 @@ interface operations {
|
|
|
6274
6645
|
* @example active
|
|
6275
6646
|
*/
|
|
6276
6647
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
6648
|
+
/**
|
|
6649
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
6650
|
+
* @example account_invalid
|
|
6651
|
+
*/
|
|
6652
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
6277
6653
|
/**
|
|
6278
6654
|
* @description Name of the account holder
|
|
6279
6655
|
* @example John Doe
|
|
@@ -6347,6 +6723,11 @@ interface operations {
|
|
|
6347
6723
|
* @example active
|
|
6348
6724
|
*/
|
|
6349
6725
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
6726
|
+
/**
|
|
6727
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
6728
|
+
* @example account_invalid
|
|
6729
|
+
*/
|
|
6730
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
6350
6731
|
/**
|
|
6351
6732
|
* @description Name of the account holder
|
|
6352
6733
|
* @example John Doe
|
|
@@ -6410,6 +6791,11 @@ interface operations {
|
|
|
6410
6791
|
* @example active
|
|
6411
6792
|
*/
|
|
6412
6793
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
6794
|
+
/**
|
|
6795
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
6796
|
+
* @example account_invalid
|
|
6797
|
+
*/
|
|
6798
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
6413
6799
|
/**
|
|
6414
6800
|
* @description Name of the account holder
|
|
6415
6801
|
* @example John Doe
|
|
@@ -6607,6 +6993,11 @@ interface operations {
|
|
|
6607
6993
|
* @example active
|
|
6608
6994
|
*/
|
|
6609
6995
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
6996
|
+
/**
|
|
6997
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
6998
|
+
* @example account_invalid
|
|
6999
|
+
*/
|
|
7000
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
6610
7001
|
/**
|
|
6611
7002
|
* @description Name of the account holder
|
|
6612
7003
|
* @example John Doe
|
|
@@ -6675,6 +7066,11 @@ interface operations {
|
|
|
6675
7066
|
* @example active
|
|
6676
7067
|
*/
|
|
6677
7068
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
7069
|
+
/**
|
|
7070
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
7071
|
+
* @example account_invalid
|
|
7072
|
+
*/
|
|
7073
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
6678
7074
|
/**
|
|
6679
7075
|
* @description Name of the account holder
|
|
6680
7076
|
* @example John Doe
|
|
@@ -6748,6 +7144,11 @@ interface operations {
|
|
|
6748
7144
|
* @example active
|
|
6749
7145
|
*/
|
|
6750
7146
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
7147
|
+
/**
|
|
7148
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
7149
|
+
* @example account_invalid
|
|
7150
|
+
*/
|
|
7151
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
6751
7152
|
/**
|
|
6752
7153
|
* @description Name of the account holder
|
|
6753
7154
|
* @example John Doe
|
|
@@ -6811,6 +7212,11 @@ interface operations {
|
|
|
6811
7212
|
* @example active
|
|
6812
7213
|
*/
|
|
6813
7214
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
7215
|
+
/**
|
|
7216
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
7217
|
+
* @example account_invalid
|
|
7218
|
+
*/
|
|
7219
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
6814
7220
|
/**
|
|
6815
7221
|
* @description Name of the account holder
|
|
6816
7222
|
* @example John Doe
|
|
@@ -7289,7 +7695,7 @@ interface operations {
|
|
|
7289
7695
|
* @description Why the funding source is not active, or null when no reason applies.
|
|
7290
7696
|
* @example ownership_mismatch
|
|
7291
7697
|
*/
|
|
7292
|
-
statusReason: ("ownership_mismatch" | null) | ("ownership_review_required" | null) | ("user_not_verified" | null) | ("duplicate_bank_account" | null) | ("returned" | null) | ("risk_blocked" | null) | ("manually_disabled" | null);
|
|
7698
|
+
statusReason: ("ownership_mismatch" | null) | ("ownership_review_required" | null) | ("user_not_verified" | null) | ("duplicate_bank_account" | null) | ("returned" | null) | ("risk_blocked" | null) | ("rerouted" | null) | ("manually_disabled" | null);
|
|
7293
7699
|
/**
|
|
7294
7700
|
* @description Ownership match result for the linked bank account, or null when unavailable.
|
|
7295
7701
|
* @example matched
|
|
@@ -7656,7 +8062,7 @@ interface operations {
|
|
|
7656
8062
|
* @description Why the funding source is not active, or null when no reason applies.
|
|
7657
8063
|
* @example ownership_mismatch
|
|
7658
8064
|
*/
|
|
7659
|
-
statusReason: ("ownership_mismatch" | null) | ("ownership_review_required" | null) | ("user_not_verified" | null) | ("duplicate_bank_account" | null) | ("returned" | null) | ("risk_blocked" | null) | ("manually_disabled" | null);
|
|
8065
|
+
statusReason: ("ownership_mismatch" | null) | ("ownership_review_required" | null) | ("user_not_verified" | null) | ("duplicate_bank_account" | null) | ("returned" | null) | ("risk_blocked" | null) | ("rerouted" | null) | ("manually_disabled" | null);
|
|
7660
8066
|
/**
|
|
7661
8067
|
* @description Ownership match result for the linked bank account, or null when unavailable.
|
|
7662
8068
|
* @example matched
|
|
@@ -8517,6 +8923,11 @@ interface operations {
|
|
|
8517
8923
|
* @example active
|
|
8518
8924
|
*/
|
|
8519
8925
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
8926
|
+
/**
|
|
8927
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
8928
|
+
* @example account_invalid
|
|
8929
|
+
*/
|
|
8930
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
8520
8931
|
/**
|
|
8521
8932
|
* @description Name of the account holder
|
|
8522
8933
|
* @example John Doe
|
|
@@ -8585,6 +8996,11 @@ interface operations {
|
|
|
8585
8996
|
* @example active
|
|
8586
8997
|
*/
|
|
8587
8998
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
8999
|
+
/**
|
|
9000
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
9001
|
+
* @example account_invalid
|
|
9002
|
+
*/
|
|
9003
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
8588
9004
|
/**
|
|
8589
9005
|
* @description Name of the account holder
|
|
8590
9006
|
* @example John Doe
|
|
@@ -8658,6 +9074,11 @@ interface operations {
|
|
|
8658
9074
|
* @example active
|
|
8659
9075
|
*/
|
|
8660
9076
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
9077
|
+
/**
|
|
9078
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
9079
|
+
* @example account_invalid
|
|
9080
|
+
*/
|
|
9081
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
8661
9082
|
/**
|
|
8662
9083
|
* @description Name of the account holder
|
|
8663
9084
|
* @example John Doe
|
|
@@ -8721,6 +9142,11 @@ interface operations {
|
|
|
8721
9142
|
* @example active
|
|
8722
9143
|
*/
|
|
8723
9144
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
9145
|
+
/**
|
|
9146
|
+
* @description Why the account is not usable, or null when no reason applies.
|
|
9147
|
+
* @example account_invalid
|
|
9148
|
+
*/
|
|
9149
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
8724
9150
|
/**
|
|
8725
9151
|
* @description Name of the account holder
|
|
8726
9152
|
* @example John Doe
|
|
@@ -9301,7 +9727,7 @@ interface operations {
|
|
|
9301
9727
|
status: "information_required" | "challenge_required";
|
|
9302
9728
|
challenge?: {
|
|
9303
9729
|
questions: {
|
|
9304
|
-
id: string
|
|
9730
|
+
id: string;
|
|
9305
9731
|
prompt: string | null;
|
|
9306
9732
|
options: {
|
|
9307
9733
|
id: string;
|
|
@@ -9433,7 +9859,7 @@ interface operations {
|
|
|
9433
9859
|
status: "information_required" | "challenge_required";
|
|
9434
9860
|
challenge?: {
|
|
9435
9861
|
questions: {
|
|
9436
|
-
id: string
|
|
9862
|
+
id: string;
|
|
9437
9863
|
prompt: string | null;
|
|
9438
9864
|
options: {
|
|
9439
9865
|
id: string;
|
|
@@ -9576,7 +10002,7 @@ interface operations {
|
|
|
9576
10002
|
status: "information_required" | "challenge_required";
|
|
9577
10003
|
challenge?: {
|
|
9578
10004
|
questions: {
|
|
9579
|
-
id: string
|
|
10005
|
+
id: string;
|
|
9580
10006
|
prompt: string | null;
|
|
9581
10007
|
options: {
|
|
9582
10008
|
id: string;
|
|
@@ -10493,7 +10919,7 @@ interface operations {
|
|
|
10493
10919
|
getV1CardsByCardIdTransactions: {
|
|
10494
10920
|
parameters: {
|
|
10495
10921
|
query?: {
|
|
10496
|
-
limit?:
|
|
10922
|
+
limit?: number;
|
|
10497
10923
|
cursor?: string;
|
|
10498
10924
|
sort?: "desc" | "asc";
|
|
10499
10925
|
status?: "pending" | "posted" | "declined" | "reversed" | "expired";
|
|
@@ -11382,11 +11808,11 @@ interface operations {
|
|
|
11382
11808
|
data: {
|
|
11383
11809
|
/**
|
|
11384
11810
|
* @description Unique identifier for the debit card
|
|
11385
|
-
* @example
|
|
11811
|
+
* @example 6a5f75585a936eb477232f09
|
|
11386
11812
|
*/
|
|
11387
11813
|
id: string;
|
|
11388
11814
|
/** @enum {string} */
|
|
11389
|
-
status: "active" | "pending" | "inactive" | "rejected";
|
|
11815
|
+
status: "active" | "pending" | "inactive" | "rejected" | "action_required";
|
|
11390
11816
|
/** @enum {string} */
|
|
11391
11817
|
network: "visa" | "mastercard";
|
|
11392
11818
|
/**
|
|
@@ -11406,6 +11832,27 @@ interface operations {
|
|
|
11406
11832
|
* @example true
|
|
11407
11833
|
*/
|
|
11408
11834
|
isTokenized: boolean;
|
|
11835
|
+
/** @description Actions the user must complete before the card can be used for payouts. Present (non-empty) when status is action_required. */
|
|
11836
|
+
requirements?: {
|
|
11837
|
+
/**
|
|
11838
|
+
* @description The action the user must complete to enable payouts
|
|
11839
|
+
* @example card_details
|
|
11840
|
+
*/
|
|
11841
|
+
type: string;
|
|
11842
|
+
/**
|
|
11843
|
+
* @description Fields the user must supply to satisfy the requirement
|
|
11844
|
+
* @example [
|
|
11845
|
+
* "cardholder_name",
|
|
11846
|
+
* "billing_address"
|
|
11847
|
+
* ]
|
|
11848
|
+
*/
|
|
11849
|
+
fields?: string[];
|
|
11850
|
+
/**
|
|
11851
|
+
* @description Human-readable explanation of the requirement
|
|
11852
|
+
* @example Cardholder name and billing address are required to enable payouts.
|
|
11853
|
+
*/
|
|
11854
|
+
reason?: string;
|
|
11855
|
+
}[];
|
|
11409
11856
|
/** Format: date-time */
|
|
11410
11857
|
createdAt: string;
|
|
11411
11858
|
}[];
|
|
@@ -11773,11 +12220,192 @@ interface operations {
|
|
|
11773
12220
|
"application/json": {
|
|
11774
12221
|
/**
|
|
11775
12222
|
* @description Unique identifier for the debit card
|
|
11776
|
-
* @example
|
|
12223
|
+
* @example 6a5f75585a936eb477232f09
|
|
12224
|
+
*/
|
|
12225
|
+
id: string;
|
|
12226
|
+
/** @enum {string} */
|
|
12227
|
+
status: "active" | "pending" | "inactive" | "rejected" | "action_required";
|
|
12228
|
+
/** @enum {string} */
|
|
12229
|
+
network: "visa" | "mastercard";
|
|
12230
|
+
/**
|
|
12231
|
+
* @description Last 4 digits of card number
|
|
12232
|
+
* @example 1111
|
|
12233
|
+
*/
|
|
12234
|
+
cardNumberLast4: string;
|
|
12235
|
+
/** @example 12 */
|
|
12236
|
+
expiryMonth: number;
|
|
12237
|
+
/** @example 2027 */
|
|
12238
|
+
expiryYear: number;
|
|
12239
|
+
label?: string;
|
|
12240
|
+
/** @enum {string} */
|
|
12241
|
+
currency: "USD" | "CAD" | "EUR" | "GBP";
|
|
12242
|
+
/**
|
|
12243
|
+
* @description Whether this card has been tokenized via Evervault for secure storage
|
|
12244
|
+
* @example true
|
|
12245
|
+
*/
|
|
12246
|
+
isTokenized: boolean;
|
|
12247
|
+
/** @description Actions the user must complete before the card can be used for payouts. Present (non-empty) when status is action_required. */
|
|
12248
|
+
requirements?: {
|
|
12249
|
+
/**
|
|
12250
|
+
* @description The action the user must complete to enable payouts
|
|
12251
|
+
* @example card_details
|
|
12252
|
+
*/
|
|
12253
|
+
type: string;
|
|
12254
|
+
/**
|
|
12255
|
+
* @description Fields the user must supply to satisfy the requirement
|
|
12256
|
+
* @example [
|
|
12257
|
+
* "cardholder_name",
|
|
12258
|
+
* "billing_address"
|
|
12259
|
+
* ]
|
|
12260
|
+
*/
|
|
12261
|
+
fields?: string[];
|
|
12262
|
+
/**
|
|
12263
|
+
* @description Human-readable explanation of the requirement
|
|
12264
|
+
* @example Cardholder name and billing address are required to enable payouts.
|
|
12265
|
+
*/
|
|
12266
|
+
reason?: string;
|
|
12267
|
+
}[];
|
|
12268
|
+
/** Format: date-time */
|
|
12269
|
+
createdAt: string;
|
|
12270
|
+
};
|
|
12271
|
+
};
|
|
12272
|
+
};
|
|
12273
|
+
/** @description Response for status 401 */
|
|
12274
|
+
401: {
|
|
12275
|
+
headers: {
|
|
12276
|
+
[name: string]: unknown;
|
|
12277
|
+
};
|
|
12278
|
+
content: {
|
|
12279
|
+
"application/json": {
|
|
12280
|
+
/**
|
|
12281
|
+
* @description A URI reference that identifies the problem type
|
|
12282
|
+
* @default about:blank
|
|
12283
|
+
* @example urn:problem-type:auth:unauthorized
|
|
12284
|
+
*/
|
|
12285
|
+
type: string;
|
|
12286
|
+
/**
|
|
12287
|
+
* @description A short, human-readable summary of the problem type
|
|
12288
|
+
* @example Unauthorized
|
|
12289
|
+
*/
|
|
12290
|
+
title: string;
|
|
12291
|
+
/**
|
|
12292
|
+
* @description The HTTP status code
|
|
12293
|
+
* @example 401
|
|
12294
|
+
*/
|
|
12295
|
+
status: number;
|
|
12296
|
+
/**
|
|
12297
|
+
* @description A human-readable explanation specific to this occurrence
|
|
12298
|
+
* @example Bearer token required
|
|
12299
|
+
*/
|
|
12300
|
+
detail?: string;
|
|
12301
|
+
/** @description A URI reference that identifies the specific occurrence */
|
|
12302
|
+
instance?: string;
|
|
12303
|
+
/**
|
|
12304
|
+
* @description The authentication realm
|
|
12305
|
+
* @example API
|
|
12306
|
+
*/
|
|
12307
|
+
realm?: string;
|
|
12308
|
+
/**
|
|
12309
|
+
* @description The required scope for this resource
|
|
12310
|
+
* @example read:users
|
|
12311
|
+
*/
|
|
12312
|
+
scope?: string;
|
|
12313
|
+
};
|
|
12314
|
+
};
|
|
12315
|
+
};
|
|
12316
|
+
/** @description Response for status 404 */
|
|
12317
|
+
404: {
|
|
12318
|
+
headers: {
|
|
12319
|
+
[name: string]: unknown;
|
|
12320
|
+
};
|
|
12321
|
+
content: {
|
|
12322
|
+
"application/json": {
|
|
12323
|
+
/**
|
|
12324
|
+
* @description A URI reference that identifies the problem type
|
|
12325
|
+
* @default about:blank
|
|
12326
|
+
*/
|
|
12327
|
+
type: string;
|
|
12328
|
+
/** @description A short, human-readable summary of the problem type */
|
|
12329
|
+
title: string;
|
|
12330
|
+
/**
|
|
12331
|
+
* @description The HTTP status code
|
|
12332
|
+
* @example 404
|
|
12333
|
+
*/
|
|
12334
|
+
status: number;
|
|
12335
|
+
/** @description A human-readable explanation specific to this occurrence */
|
|
12336
|
+
detail?: string;
|
|
12337
|
+
/** @description A URI reference that identifies the specific occurrence */
|
|
12338
|
+
instance?: string;
|
|
12339
|
+
/**
|
|
12340
|
+
* @description The type of resource that was not found
|
|
12341
|
+
* @example user
|
|
12342
|
+
*/
|
|
12343
|
+
resourceType: string;
|
|
12344
|
+
/** @description The identifier of the resource that was not found */
|
|
12345
|
+
resourceId: string;
|
|
12346
|
+
};
|
|
12347
|
+
};
|
|
12348
|
+
};
|
|
12349
|
+
/** @description Response for status 500 */
|
|
12350
|
+
500: {
|
|
12351
|
+
headers: {
|
|
12352
|
+
[name: string]: unknown;
|
|
12353
|
+
};
|
|
12354
|
+
content: {
|
|
12355
|
+
"application/json": {
|
|
12356
|
+
/**
|
|
12357
|
+
* @description A URI reference that identifies the problem type
|
|
12358
|
+
* @default about:blank
|
|
12359
|
+
* @example urn:problem-type:auth:unauthorized
|
|
12360
|
+
*/
|
|
12361
|
+
type: string;
|
|
12362
|
+
/**
|
|
12363
|
+
* @description A short, human-readable summary of the problem type
|
|
12364
|
+
* @example Unauthorized
|
|
12365
|
+
*/
|
|
12366
|
+
title: string;
|
|
12367
|
+
/**
|
|
12368
|
+
* @description The HTTP status code
|
|
12369
|
+
* @example 400
|
|
12370
|
+
*/
|
|
12371
|
+
status: number;
|
|
12372
|
+
/** @description A human-readable explanation specific to this occurrence */
|
|
12373
|
+
detail?: string;
|
|
12374
|
+
/**
|
|
12375
|
+
* @description A URI reference that identifies the specific occurrence
|
|
12376
|
+
* @example /errors/1234567890
|
|
12377
|
+
*/
|
|
12378
|
+
instance?: string;
|
|
12379
|
+
};
|
|
12380
|
+
};
|
|
12381
|
+
};
|
|
12382
|
+
};
|
|
12383
|
+
};
|
|
12384
|
+
"getV1Debit-cardsByCardId": {
|
|
12385
|
+
parameters: {
|
|
12386
|
+
query?: never;
|
|
12387
|
+
header?: never;
|
|
12388
|
+
path: {
|
|
12389
|
+
cardId: string;
|
|
12390
|
+
};
|
|
12391
|
+
cookie?: never;
|
|
12392
|
+
};
|
|
12393
|
+
requestBody?: never;
|
|
12394
|
+
responses: {
|
|
12395
|
+
/** @description Response for status 200 */
|
|
12396
|
+
200: {
|
|
12397
|
+
headers: {
|
|
12398
|
+
[name: string]: unknown;
|
|
12399
|
+
};
|
|
12400
|
+
content: {
|
|
12401
|
+
"application/json": {
|
|
12402
|
+
/**
|
|
12403
|
+
* @description Unique identifier for the debit card
|
|
12404
|
+
* @example 6a5f75585a936eb477232f09
|
|
11777
12405
|
*/
|
|
11778
12406
|
id: string;
|
|
11779
12407
|
/** @enum {string} */
|
|
11780
|
-
status: "active" | "pending" | "inactive" | "rejected";
|
|
12408
|
+
status: "active" | "pending" | "inactive" | "rejected" | "action_required";
|
|
11781
12409
|
/** @enum {string} */
|
|
11782
12410
|
network: "visa" | "mastercard";
|
|
11783
12411
|
/**
|
|
@@ -11797,6 +12425,27 @@ interface operations {
|
|
|
11797
12425
|
* @example true
|
|
11798
12426
|
*/
|
|
11799
12427
|
isTokenized: boolean;
|
|
12428
|
+
/** @description Actions the user must complete before the card can be used for payouts. Present (non-empty) when status is action_required. */
|
|
12429
|
+
requirements?: {
|
|
12430
|
+
/**
|
|
12431
|
+
* @description The action the user must complete to enable payouts
|
|
12432
|
+
* @example card_details
|
|
12433
|
+
*/
|
|
12434
|
+
type: string;
|
|
12435
|
+
/**
|
|
12436
|
+
* @description Fields the user must supply to satisfy the requirement
|
|
12437
|
+
* @example [
|
|
12438
|
+
* "cardholder_name",
|
|
12439
|
+
* "billing_address"
|
|
12440
|
+
* ]
|
|
12441
|
+
*/
|
|
12442
|
+
fields?: string[];
|
|
12443
|
+
/**
|
|
12444
|
+
* @description Human-readable explanation of the requirement
|
|
12445
|
+
* @example Cardholder name and billing address are required to enable payouts.
|
|
12446
|
+
*/
|
|
12447
|
+
reason?: string;
|
|
12448
|
+
}[];
|
|
11800
12449
|
/** Format: date-time */
|
|
11801
12450
|
createdAt: string;
|
|
11802
12451
|
};
|
|
@@ -11913,7 +12562,7 @@ interface operations {
|
|
|
11913
12562
|
};
|
|
11914
12563
|
};
|
|
11915
12564
|
};
|
|
11916
|
-
"
|
|
12565
|
+
"deleteV1Debit-cardsByCardId": {
|
|
11917
12566
|
parameters: {
|
|
11918
12567
|
query?: never;
|
|
11919
12568
|
header?: never;
|
|
@@ -11931,34 +12580,7 @@ interface operations {
|
|
|
11931
12580
|
};
|
|
11932
12581
|
content: {
|
|
11933
12582
|
"application/json": {
|
|
11934
|
-
|
|
11935
|
-
* @description Unique identifier for the debit card
|
|
11936
|
-
* @example 6a4b441ca9931c9d1ac48c86
|
|
11937
|
-
*/
|
|
11938
|
-
id: string;
|
|
11939
|
-
/** @enum {string} */
|
|
11940
|
-
status: "active" | "pending" | "inactive" | "rejected";
|
|
11941
|
-
/** @enum {string} */
|
|
11942
|
-
network: "visa" | "mastercard";
|
|
11943
|
-
/**
|
|
11944
|
-
* @description Last 4 digits of card number
|
|
11945
|
-
* @example 1111
|
|
11946
|
-
*/
|
|
11947
|
-
cardNumberLast4: string;
|
|
11948
|
-
/** @example 12 */
|
|
11949
|
-
expiryMonth: number;
|
|
11950
|
-
/** @example 2027 */
|
|
11951
|
-
expiryYear: number;
|
|
11952
|
-
label?: string;
|
|
11953
|
-
/** @enum {string} */
|
|
11954
|
-
currency: "USD" | "CAD" | "EUR" | "GBP";
|
|
11955
|
-
/**
|
|
11956
|
-
* @description Whether this card has been tokenized via Evervault for secure storage
|
|
11957
|
-
* @example true
|
|
11958
|
-
*/
|
|
11959
|
-
isTokenized: boolean;
|
|
11960
|
-
/** Format: date-time */
|
|
11961
|
-
createdAt: string;
|
|
12583
|
+
success: boolean;
|
|
11962
12584
|
};
|
|
11963
12585
|
};
|
|
11964
12586
|
};
|
|
@@ -12073,7 +12695,7 @@ interface operations {
|
|
|
12073
12695
|
};
|
|
12074
12696
|
};
|
|
12075
12697
|
};
|
|
12076
|
-
"
|
|
12698
|
+
"patchV1Debit-cardsByCardIdCardholder-info": {
|
|
12077
12699
|
parameters: {
|
|
12078
12700
|
query?: never;
|
|
12079
12701
|
header?: never;
|
|
@@ -12082,7 +12704,142 @@ interface operations {
|
|
|
12082
12704
|
};
|
|
12083
12705
|
cookie?: never;
|
|
12084
12706
|
};
|
|
12085
|
-
requestBody
|
|
12707
|
+
requestBody: {
|
|
12708
|
+
content: {
|
|
12709
|
+
"application/json": {
|
|
12710
|
+
/**
|
|
12711
|
+
* @description Cardholder's first name
|
|
12712
|
+
* @example John
|
|
12713
|
+
*/
|
|
12714
|
+
cardholderFirstName: string;
|
|
12715
|
+
/**
|
|
12716
|
+
* @description Cardholder's last name
|
|
12717
|
+
* @example Doe
|
|
12718
|
+
*/
|
|
12719
|
+
cardholderLastName: string;
|
|
12720
|
+
billingAddress: {
|
|
12721
|
+
/**
|
|
12722
|
+
* @description Street address line 1
|
|
12723
|
+
* @example 123 Main St
|
|
12724
|
+
*/
|
|
12725
|
+
line1: string;
|
|
12726
|
+
/**
|
|
12727
|
+
* @description Street address line 2
|
|
12728
|
+
* @example Apt 4
|
|
12729
|
+
*/
|
|
12730
|
+
line2?: string;
|
|
12731
|
+
/**
|
|
12732
|
+
* @description City
|
|
12733
|
+
* @example New York
|
|
12734
|
+
*/
|
|
12735
|
+
city: string;
|
|
12736
|
+
/**
|
|
12737
|
+
* @description State / province code
|
|
12738
|
+
* @example NY
|
|
12739
|
+
*/
|
|
12740
|
+
state: string;
|
|
12741
|
+
/**
|
|
12742
|
+
* @description Postal / ZIP code
|
|
12743
|
+
* @example 10001
|
|
12744
|
+
*/
|
|
12745
|
+
postalCode: string;
|
|
12746
|
+
/**
|
|
12747
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
12748
|
+
* @example US
|
|
12749
|
+
*/
|
|
12750
|
+
country: string;
|
|
12751
|
+
};
|
|
12752
|
+
};
|
|
12753
|
+
"application/x-www-form-urlencoded": {
|
|
12754
|
+
/**
|
|
12755
|
+
* @description Cardholder's first name
|
|
12756
|
+
* @example John
|
|
12757
|
+
*/
|
|
12758
|
+
cardholderFirstName: string;
|
|
12759
|
+
/**
|
|
12760
|
+
* @description Cardholder's last name
|
|
12761
|
+
* @example Doe
|
|
12762
|
+
*/
|
|
12763
|
+
cardholderLastName: string;
|
|
12764
|
+
billingAddress: {
|
|
12765
|
+
/**
|
|
12766
|
+
* @description Street address line 1
|
|
12767
|
+
* @example 123 Main St
|
|
12768
|
+
*/
|
|
12769
|
+
line1: string;
|
|
12770
|
+
/**
|
|
12771
|
+
* @description Street address line 2
|
|
12772
|
+
* @example Apt 4
|
|
12773
|
+
*/
|
|
12774
|
+
line2?: string;
|
|
12775
|
+
/**
|
|
12776
|
+
* @description City
|
|
12777
|
+
* @example New York
|
|
12778
|
+
*/
|
|
12779
|
+
city: string;
|
|
12780
|
+
/**
|
|
12781
|
+
* @description State / province code
|
|
12782
|
+
* @example NY
|
|
12783
|
+
*/
|
|
12784
|
+
state: string;
|
|
12785
|
+
/**
|
|
12786
|
+
* @description Postal / ZIP code
|
|
12787
|
+
* @example 10001
|
|
12788
|
+
*/
|
|
12789
|
+
postalCode: string;
|
|
12790
|
+
/**
|
|
12791
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
12792
|
+
* @example US
|
|
12793
|
+
*/
|
|
12794
|
+
country: string;
|
|
12795
|
+
};
|
|
12796
|
+
};
|
|
12797
|
+
"multipart/form-data": {
|
|
12798
|
+
/**
|
|
12799
|
+
* @description Cardholder's first name
|
|
12800
|
+
* @example John
|
|
12801
|
+
*/
|
|
12802
|
+
cardholderFirstName: string;
|
|
12803
|
+
/**
|
|
12804
|
+
* @description Cardholder's last name
|
|
12805
|
+
* @example Doe
|
|
12806
|
+
*/
|
|
12807
|
+
cardholderLastName: string;
|
|
12808
|
+
billingAddress: {
|
|
12809
|
+
/**
|
|
12810
|
+
* @description Street address line 1
|
|
12811
|
+
* @example 123 Main St
|
|
12812
|
+
*/
|
|
12813
|
+
line1: string;
|
|
12814
|
+
/**
|
|
12815
|
+
* @description Street address line 2
|
|
12816
|
+
* @example Apt 4
|
|
12817
|
+
*/
|
|
12818
|
+
line2?: string;
|
|
12819
|
+
/**
|
|
12820
|
+
* @description City
|
|
12821
|
+
* @example New York
|
|
12822
|
+
*/
|
|
12823
|
+
city: string;
|
|
12824
|
+
/**
|
|
12825
|
+
* @description State / province code
|
|
12826
|
+
* @example NY
|
|
12827
|
+
*/
|
|
12828
|
+
state: string;
|
|
12829
|
+
/**
|
|
12830
|
+
* @description Postal / ZIP code
|
|
12831
|
+
* @example 10001
|
|
12832
|
+
*/
|
|
12833
|
+
postalCode: string;
|
|
12834
|
+
/**
|
|
12835
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
12836
|
+
* @example US
|
|
12837
|
+
*/
|
|
12838
|
+
country: string;
|
|
12839
|
+
};
|
|
12840
|
+
};
|
|
12841
|
+
};
|
|
12842
|
+
};
|
|
12086
12843
|
responses: {
|
|
12087
12844
|
/** @description Response for status 200 */
|
|
12088
12845
|
200: {
|
|
@@ -12091,7 +12848,55 @@ interface operations {
|
|
|
12091
12848
|
};
|
|
12092
12849
|
content: {
|
|
12093
12850
|
"application/json": {
|
|
12094
|
-
|
|
12851
|
+
/**
|
|
12852
|
+
* @description Unique identifier for the debit card
|
|
12853
|
+
* @example 6a5f75585a936eb477232f09
|
|
12854
|
+
*/
|
|
12855
|
+
id: string;
|
|
12856
|
+
/** @enum {string} */
|
|
12857
|
+
status: "active" | "pending" | "inactive" | "rejected" | "action_required";
|
|
12858
|
+
/** @enum {string} */
|
|
12859
|
+
network: "visa" | "mastercard";
|
|
12860
|
+
/**
|
|
12861
|
+
* @description Last 4 digits of card number
|
|
12862
|
+
* @example 1111
|
|
12863
|
+
*/
|
|
12864
|
+
cardNumberLast4: string;
|
|
12865
|
+
/** @example 12 */
|
|
12866
|
+
expiryMonth: number;
|
|
12867
|
+
/** @example 2027 */
|
|
12868
|
+
expiryYear: number;
|
|
12869
|
+
label?: string;
|
|
12870
|
+
/** @enum {string} */
|
|
12871
|
+
currency: "USD" | "CAD" | "EUR" | "GBP";
|
|
12872
|
+
/**
|
|
12873
|
+
* @description Whether this card has been tokenized via Evervault for secure storage
|
|
12874
|
+
* @example true
|
|
12875
|
+
*/
|
|
12876
|
+
isTokenized: boolean;
|
|
12877
|
+
/** @description Actions the user must complete before the card can be used for payouts. Present (non-empty) when status is action_required. */
|
|
12878
|
+
requirements?: {
|
|
12879
|
+
/**
|
|
12880
|
+
* @description The action the user must complete to enable payouts
|
|
12881
|
+
* @example card_details
|
|
12882
|
+
*/
|
|
12883
|
+
type: string;
|
|
12884
|
+
/**
|
|
12885
|
+
* @description Fields the user must supply to satisfy the requirement
|
|
12886
|
+
* @example [
|
|
12887
|
+
* "cardholder_name",
|
|
12888
|
+
* "billing_address"
|
|
12889
|
+
* ]
|
|
12890
|
+
*/
|
|
12891
|
+
fields?: string[];
|
|
12892
|
+
/**
|
|
12893
|
+
* @description Human-readable explanation of the requirement
|
|
12894
|
+
* @example Cardholder name and billing address are required to enable payouts.
|
|
12895
|
+
*/
|
|
12896
|
+
reason?: string;
|
|
12897
|
+
}[];
|
|
12898
|
+
/** Format: date-time */
|
|
12899
|
+
createdAt: string;
|
|
12095
12900
|
};
|
|
12096
12901
|
};
|
|
12097
12902
|
};
|
|
@@ -12787,7 +13592,7 @@ interface operations {
|
|
|
12787
13592
|
accessToken: string;
|
|
12788
13593
|
/**
|
|
12789
13594
|
* @description The internal ID of the authorized user
|
|
12790
|
-
* @example
|
|
13595
|
+
* @example 6a5f75595a936eb477232f0d
|
|
12791
13596
|
*/
|
|
12792
13597
|
userId: string;
|
|
12793
13598
|
/**
|
|
@@ -12803,7 +13608,7 @@ interface operations {
|
|
|
12803
13608
|
/**
|
|
12804
13609
|
* Format: date-time
|
|
12805
13610
|
* @description ISO 8601 timestamp when token expires
|
|
12806
|
-
* @example 2026-07-
|
|
13611
|
+
* @example 2026-07-21T14:34:17.046Z
|
|
12807
13612
|
*/
|
|
12808
13613
|
expiresAt: string;
|
|
12809
13614
|
};
|
|
@@ -12966,7 +13771,7 @@ interface operations {
|
|
|
12966
13771
|
/**
|
|
12967
13772
|
* Format: date-time
|
|
12968
13773
|
* @description ISO 8601 timestamp of when the integrator was created
|
|
12969
|
-
* @example 2026-07-
|
|
13774
|
+
* @example 2026-07-21T13:34:17.045Z
|
|
12970
13775
|
*/
|
|
12971
13776
|
createdAt: string;
|
|
12972
13777
|
};
|
|
@@ -13143,7 +13948,7 @@ interface operations {
|
|
|
13143
13948
|
"application/json": {
|
|
13144
13949
|
/**
|
|
13145
13950
|
* @description The internal ID of the newly created user
|
|
13146
|
-
* @example
|
|
13951
|
+
* @example 6a5f75595a936eb477232f0f
|
|
13147
13952
|
*/
|
|
13148
13953
|
userId: string;
|
|
13149
13954
|
/**
|
|
@@ -13307,7 +14112,7 @@ interface operations {
|
|
|
13307
14112
|
"getV1IntegratorAch-debitReturns": {
|
|
13308
14113
|
parameters: {
|
|
13309
14114
|
query?: {
|
|
13310
|
-
limit?:
|
|
14115
|
+
limit?: number;
|
|
13311
14116
|
cursor?: string;
|
|
13312
14117
|
userId?: string;
|
|
13313
14118
|
userIds?: string;
|
|
@@ -13346,7 +14151,7 @@ interface operations {
|
|
|
13346
14151
|
depositId: string;
|
|
13347
14152
|
/**
|
|
13348
14153
|
* @description Spritz user ID associated with the returned deposit
|
|
13349
|
-
* @example
|
|
14154
|
+
* @example 6a5f75595a936eb477232f0c
|
|
13350
14155
|
*/
|
|
13351
14156
|
userId: string;
|
|
13352
14157
|
/**
|
|
@@ -13522,7 +14327,7 @@ interface operations {
|
|
|
13522
14327
|
depositId: string;
|
|
13523
14328
|
/**
|
|
13524
14329
|
* @description Spritz user ID associated with the returned deposit
|
|
13525
|
-
* @example
|
|
14330
|
+
* @example 6a5f75595a936eb477232f0c
|
|
13526
14331
|
*/
|
|
13527
14332
|
userId: string;
|
|
13528
14333
|
/**
|
|
@@ -13679,7 +14484,7 @@ interface operations {
|
|
|
13679
14484
|
"application/json": {
|
|
13680
14485
|
/**
|
|
13681
14486
|
* @description Unique identifier for the webhook
|
|
13682
|
-
* @example
|
|
14487
|
+
* @example 6a5f75595a936eb477232f0e
|
|
13683
14488
|
*/
|
|
13684
14489
|
id: string;
|
|
13685
14490
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -13874,7 +14679,7 @@ interface operations {
|
|
|
13874
14679
|
"application/json": {
|
|
13875
14680
|
/**
|
|
13876
14681
|
* @description Unique identifier for the webhook
|
|
13877
|
-
* @example
|
|
14682
|
+
* @example 6a5f75595a936eb477232f0e
|
|
13878
14683
|
*/
|
|
13879
14684
|
id: string;
|
|
13880
14685
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -14186,7 +14991,7 @@ interface operations {
|
|
|
14186
14991
|
"application/json": {
|
|
14187
14992
|
/**
|
|
14188
14993
|
* @description Unique identifier for the webhook
|
|
14189
|
-
* @example
|
|
14994
|
+
* @example 6a5f75595a936eb477232f0e
|
|
14190
14995
|
*/
|
|
14191
14996
|
id: string;
|
|
14192
14997
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -14531,7 +15336,7 @@ interface operations {
|
|
|
14531
15336
|
/**
|
|
14532
15337
|
* Format: date-time
|
|
14533
15338
|
* @description ISO 8601 timestamp when the old secret will expire. Only present if a grace period was specified.
|
|
14534
|
-
* @example 2026-07-
|
|
15339
|
+
* @example 2026-07-21T13:39:17.046Z
|
|
14535
15340
|
*/
|
|
14536
15341
|
oldSecretExpiresAt?: string;
|
|
14537
15342
|
};
|
|
@@ -14666,7 +15471,7 @@ interface operations {
|
|
|
14666
15471
|
"application/json": {
|
|
14667
15472
|
/**
|
|
14668
15473
|
* @description Unique identifier for the user
|
|
14669
|
-
* @example
|
|
15474
|
+
* @example 6a5f75585a936eb477232f0a
|
|
14670
15475
|
*/
|
|
14671
15476
|
id: string;
|
|
14672
15477
|
/**
|
|
@@ -14683,7 +15488,7 @@ interface operations {
|
|
|
14683
15488
|
/**
|
|
14684
15489
|
* Format: date-time
|
|
14685
15490
|
* @description ISO 8601 timestamp of when the user was created
|
|
14686
|
-
* @example 2026-07-
|
|
15491
|
+
* @example 2026-07-21T13:34:16.966Z
|
|
14687
15492
|
*/
|
|
14688
15493
|
signedUpAt: string;
|
|
14689
15494
|
/**
|
|
@@ -15013,7 +15818,7 @@ interface operations {
|
|
|
15013
15818
|
"application/json": {
|
|
15014
15819
|
/**
|
|
15015
15820
|
* @description Unique identifier for the user
|
|
15016
|
-
* @example
|
|
15821
|
+
* @example 6a5f75585a936eb477232f0a
|
|
15017
15822
|
*/
|
|
15018
15823
|
id: string;
|
|
15019
15824
|
/**
|
|
@@ -15030,7 +15835,7 @@ interface operations {
|
|
|
15030
15835
|
/**
|
|
15031
15836
|
* Format: date-time
|
|
15032
15837
|
* @description ISO 8601 timestamp of when the user was created
|
|
15033
|
-
* @example 2026-07-
|
|
15838
|
+
* @example 2026-07-21T13:34:16.966Z
|
|
15034
15839
|
*/
|
|
15035
15840
|
signedUpAt: string;
|
|
15036
15841
|
/**
|
|
@@ -15425,7 +16230,7 @@ interface operations {
|
|
|
15425
16230
|
"application/json": {
|
|
15426
16231
|
/**
|
|
15427
16232
|
* @description Unique identifier for the user
|
|
15428
|
-
* @example
|
|
16233
|
+
* @example 6a5f75585a936eb477232f0a
|
|
15429
16234
|
*/
|
|
15430
16235
|
id: string;
|
|
15431
16236
|
/**
|
|
@@ -15442,7 +16247,7 @@ interface operations {
|
|
|
15442
16247
|
/**
|
|
15443
16248
|
* Format: date-time
|
|
15444
16249
|
* @description ISO 8601 timestamp of when the user was created
|
|
15445
|
-
* @example 2026-07-
|
|
16250
|
+
* @example 2026-07-21T13:34:16.966Z
|
|
15446
16251
|
*/
|
|
15447
16252
|
signedUpAt: string;
|
|
15448
16253
|
/**
|
|
@@ -15859,7 +16664,7 @@ interface operations {
|
|
|
15859
16664
|
requestBody: {
|
|
15860
16665
|
content: {
|
|
15861
16666
|
"application/json": {
|
|
15862
|
-
permissions: ("bank-accounts:read" | "bank-accounts:write" | "bank-accounts:delete" | "bills:read" | "bills:delete" | "off-ramp-quotes:write")[];
|
|
16667
|
+
permissions: ("bank-accounts:read" | "bank-accounts:write" | "bank-accounts:delete" | "bills:read" | "bills:delete" | "off-ramp-quotes:read" | "off-ramp-quotes:write" | "off-ramps:refund")[];
|
|
15863
16668
|
/**
|
|
15864
16669
|
* Format: date-time
|
|
15865
16670
|
* @description ISO 8601 expiration timestamp
|
|
@@ -15868,7 +16673,7 @@ interface operations {
|
|
|
15868
16673
|
name?: string;
|
|
15869
16674
|
};
|
|
15870
16675
|
"application/x-www-form-urlencoded": {
|
|
15871
|
-
permissions: ("bank-accounts:read" | "bank-accounts:write" | "bank-accounts:delete" | "bills:read" | "bills:delete" | "off-ramp-quotes:write")[];
|
|
16676
|
+
permissions: ("bank-accounts:read" | "bank-accounts:write" | "bank-accounts:delete" | "bills:read" | "bills:delete" | "off-ramp-quotes:read" | "off-ramp-quotes:write" | "off-ramps:refund")[];
|
|
15872
16677
|
/**
|
|
15873
16678
|
* Format: date-time
|
|
15874
16679
|
* @description ISO 8601 expiration timestamp
|
|
@@ -15877,7 +16682,7 @@ interface operations {
|
|
|
15877
16682
|
name?: string;
|
|
15878
16683
|
};
|
|
15879
16684
|
"multipart/form-data": {
|
|
15880
|
-
permissions: ("bank-accounts:read" | "bank-accounts:write" | "bank-accounts:delete" | "bills:read" | "bills:delete" | "off-ramp-quotes:write")[];
|
|
16685
|
+
permissions: ("bank-accounts:read" | "bank-accounts:write" | "bank-accounts:delete" | "bills:read" | "bills:delete" | "off-ramp-quotes:read" | "off-ramp-quotes:write" | "off-ramps:refund")[];
|
|
15881
16686
|
/**
|
|
15882
16687
|
* Format: date-time
|
|
15883
16688
|
* @description ISO 8601 expiration timestamp
|
|
@@ -16313,7 +17118,7 @@ interface operations {
|
|
|
16313
17118
|
content: {
|
|
16314
17119
|
"application/json": {
|
|
16315
17120
|
userCode: string;
|
|
16316
|
-
permissions: ("bank-accounts:read" | "bank-accounts:write" | "bank-accounts:delete" | "bills:read" | "bills:delete" | "off-ramp-quotes:write")[];
|
|
17121
|
+
permissions: ("bank-accounts:read" | "bank-accounts:write" | "bank-accounts:delete" | "bills:read" | "bills:delete" | "off-ramp-quotes:read" | "off-ramp-quotes:write" | "off-ramps:refund")[];
|
|
16317
17122
|
/**
|
|
16318
17123
|
* Format: date-time
|
|
16319
17124
|
* @description ISO 8601 expiration timestamp
|
|
@@ -16323,7 +17128,7 @@ interface operations {
|
|
|
16323
17128
|
};
|
|
16324
17129
|
"application/x-www-form-urlencoded": {
|
|
16325
17130
|
userCode: string;
|
|
16326
|
-
permissions: ("bank-accounts:read" | "bank-accounts:write" | "bank-accounts:delete" | "bills:read" | "bills:delete" | "off-ramp-quotes:write")[];
|
|
17131
|
+
permissions: ("bank-accounts:read" | "bank-accounts:write" | "bank-accounts:delete" | "bills:read" | "bills:delete" | "off-ramp-quotes:read" | "off-ramp-quotes:write" | "off-ramps:refund")[];
|
|
16327
17132
|
/**
|
|
16328
17133
|
* Format: date-time
|
|
16329
17134
|
* @description ISO 8601 expiration timestamp
|
|
@@ -16333,7 +17138,7 @@ interface operations {
|
|
|
16333
17138
|
};
|
|
16334
17139
|
"multipart/form-data": {
|
|
16335
17140
|
userCode: string;
|
|
16336
|
-
permissions: ("bank-accounts:read" | "bank-accounts:write" | "bank-accounts:delete" | "bills:read" | "bills:delete" | "off-ramp-quotes:write")[];
|
|
17141
|
+
permissions: ("bank-accounts:read" | "bank-accounts:write" | "bank-accounts:delete" | "bills:read" | "bills:delete" | "off-ramp-quotes:read" | "off-ramp-quotes:write" | "off-ramps:refund")[];
|
|
16337
17142
|
/**
|
|
16338
17143
|
* Format: date-time
|
|
16339
17144
|
* @description ISO 8601 expiration timestamp
|
|
@@ -16910,7 +17715,7 @@ interface operations {
|
|
|
16910
17715
|
* @description Token decimals
|
|
16911
17716
|
* @example 6
|
|
16912
17717
|
*/
|
|
16913
|
-
decimals:
|
|
17718
|
+
decimals: number;
|
|
16914
17719
|
/**
|
|
16915
17720
|
* @description Decimal-formatted token balance
|
|
16916
17721
|
* @example 100.5
|
|
@@ -17067,17 +17872,17 @@ interface operations {
|
|
|
17067
17872
|
*/
|
|
17068
17873
|
totalBalanceUsd: string;
|
|
17069
17874
|
/** @description Distinct asset count at this point. */
|
|
17070
|
-
assetCount:
|
|
17875
|
+
assetCount: number;
|
|
17071
17876
|
/** @description Distinct chain count at this point. */
|
|
17072
|
-
chainCount:
|
|
17877
|
+
chainCount: number;
|
|
17073
17878
|
/** @description Total wallet count considered for this point. */
|
|
17074
|
-
walletCount:
|
|
17879
|
+
walletCount: number;
|
|
17075
17880
|
/** @description Number of wallets that were captured successfully. */
|
|
17076
|
-
capturedWalletCount:
|
|
17881
|
+
capturedWalletCount: number;
|
|
17077
17882
|
/** @description Number of wallets skipped because their chain is not yet supported. */
|
|
17078
|
-
unsupportedWalletCount:
|
|
17883
|
+
unsupportedWalletCount: number;
|
|
17079
17884
|
/** @description Number of wallets that failed to capture. */
|
|
17080
|
-
failedWalletCount:
|
|
17885
|
+
failedWalletCount: number;
|
|
17081
17886
|
} | null;
|
|
17082
17887
|
/** @description Oldest snapshot inside the requested range, or null when no snapshots exist. */
|
|
17083
17888
|
baseline: {
|
|
@@ -17101,17 +17906,17 @@ interface operations {
|
|
|
17101
17906
|
*/
|
|
17102
17907
|
totalBalanceUsd: string;
|
|
17103
17908
|
/** @description Distinct asset count at this point. */
|
|
17104
|
-
assetCount:
|
|
17909
|
+
assetCount: number;
|
|
17105
17910
|
/** @description Distinct chain count at this point. */
|
|
17106
|
-
chainCount:
|
|
17911
|
+
chainCount: number;
|
|
17107
17912
|
/** @description Total wallet count considered for this point. */
|
|
17108
|
-
walletCount:
|
|
17913
|
+
walletCount: number;
|
|
17109
17914
|
/** @description Number of wallets that were captured successfully. */
|
|
17110
|
-
capturedWalletCount:
|
|
17915
|
+
capturedWalletCount: number;
|
|
17111
17916
|
/** @description Number of wallets skipped because their chain is not yet supported. */
|
|
17112
|
-
unsupportedWalletCount:
|
|
17917
|
+
unsupportedWalletCount: number;
|
|
17113
17918
|
/** @description Number of wallets that failed to capture. */
|
|
17114
|
-
failedWalletCount:
|
|
17919
|
+
failedWalletCount: number;
|
|
17115
17920
|
} | null;
|
|
17116
17921
|
/**
|
|
17117
17922
|
* @description Simple USD balance delta between baseline and latest, formatted to two decimal places. Not P&L. Null when history is empty.
|
|
@@ -17145,17 +17950,17 @@ interface operations {
|
|
|
17145
17950
|
*/
|
|
17146
17951
|
totalBalanceUsd: string;
|
|
17147
17952
|
/** @description Distinct asset count at this point. */
|
|
17148
|
-
assetCount:
|
|
17953
|
+
assetCount: number;
|
|
17149
17954
|
/** @description Distinct chain count at this point. */
|
|
17150
|
-
chainCount:
|
|
17955
|
+
chainCount: number;
|
|
17151
17956
|
/** @description Total wallet count considered for this point. */
|
|
17152
|
-
walletCount:
|
|
17957
|
+
walletCount: number;
|
|
17153
17958
|
/** @description Number of wallets that were captured successfully. */
|
|
17154
|
-
capturedWalletCount:
|
|
17959
|
+
capturedWalletCount: number;
|
|
17155
17960
|
/** @description Number of wallets skipped because their chain is not yet supported. */
|
|
17156
|
-
unsupportedWalletCount:
|
|
17961
|
+
unsupportedWalletCount: number;
|
|
17157
17962
|
/** @description Number of wallets that failed to capture. */
|
|
17158
|
-
failedWalletCount:
|
|
17963
|
+
failedWalletCount: number;
|
|
17159
17964
|
}[];
|
|
17160
17965
|
};
|
|
17161
17966
|
};
|
|
@@ -17242,7 +18047,7 @@ interface operations {
|
|
|
17242
18047
|
parameters: {
|
|
17243
18048
|
query: {
|
|
17244
18049
|
address: string;
|
|
17245
|
-
limit?:
|
|
18050
|
+
limit?: number;
|
|
17246
18051
|
cursor?: string;
|
|
17247
18052
|
};
|
|
17248
18053
|
header?: never;
|
|
@@ -17282,7 +18087,7 @@ interface operations {
|
|
|
17282
18087
|
* @description Token decimals.
|
|
17283
18088
|
* @example 9
|
|
17284
18089
|
*/
|
|
17285
|
-
decimals:
|
|
18090
|
+
decimals: number;
|
|
17286
18091
|
/**
|
|
17287
18092
|
* @description Decimal-formatted token amount in display units (not USD). Precision matches the token's decimals.
|
|
17288
18093
|
* @example 1.5
|
|
@@ -17782,13 +18587,13 @@ interface operations {
|
|
|
17782
18587
|
* @description Estimated Solana network fee in lamports for the prepared message.
|
|
17783
18588
|
* @example 5000
|
|
17784
18589
|
*/
|
|
17785
|
-
estimatedFeeLamports:
|
|
18590
|
+
estimatedFeeLamports: number;
|
|
17786
18591
|
/** @description Address lookup table accounts used by the v0 message. Empty when the message does not use lookup tables. */
|
|
17787
18592
|
addressLookupTableAddresses: string[];
|
|
17788
18593
|
/** @description Recent blockhash embedded in the prepared message. This blockhash is what makes the prepared message expire. */
|
|
17789
18594
|
blockhash: string;
|
|
17790
18595
|
/** @description Last Solana block height at which the prepared message can still be submitted. */
|
|
17791
|
-
lastValidBlockHeight:
|
|
18596
|
+
lastValidBlockHeight: number;
|
|
17792
18597
|
/**
|
|
17793
18598
|
* Format: date-time
|
|
17794
18599
|
* @description ISO 8601 timestamp at which this prepared transaction expires. Solana blockhashes expire quickly; if submit fails with `TX_EXPIRED`, call prepare again and sign the new `messageBytes`.
|
|
@@ -19846,11 +20651,11 @@ interface operations {
|
|
|
19846
20651
|
/** @enum {string} */
|
|
19847
20652
|
symbol: "USDC" | "UNKNOWN";
|
|
19848
20653
|
mint: string;
|
|
19849
|
-
decimals:
|
|
20654
|
+
decimals: number;
|
|
19850
20655
|
};
|
|
19851
20656
|
receiptToken: {
|
|
19852
20657
|
mint: string;
|
|
19853
|
-
decimals:
|
|
20658
|
+
decimals: number;
|
|
19854
20659
|
};
|
|
19855
20660
|
apy: {
|
|
19856
20661
|
current: string | null;
|
|
@@ -19876,11 +20681,11 @@ interface operations {
|
|
|
19876
20681
|
};
|
|
19877
20682
|
sharePrice: string | null;
|
|
19878
20683
|
tokensPerShare: string | null;
|
|
19879
|
-
numberOfHolders:
|
|
20684
|
+
numberOfHolders: number | null;
|
|
19880
20685
|
fees: {
|
|
19881
|
-
performanceFeeBps:
|
|
19882
|
-
managementFeeBps:
|
|
19883
|
-
withdrawalPenaltyBps:
|
|
20686
|
+
performanceFeeBps: number;
|
|
20687
|
+
managementFeeBps: number;
|
|
20688
|
+
withdrawalPenaltyBps: number;
|
|
19884
20689
|
};
|
|
19885
20690
|
limits: {
|
|
19886
20691
|
minDepositAmount: string;
|
|
@@ -20090,11 +20895,11 @@ interface operations {
|
|
|
20090
20895
|
/** @enum {string} */
|
|
20091
20896
|
symbol: "USDC" | "UNKNOWN";
|
|
20092
20897
|
mint: string;
|
|
20093
|
-
decimals:
|
|
20898
|
+
decimals: number;
|
|
20094
20899
|
};
|
|
20095
20900
|
receiptToken: {
|
|
20096
20901
|
mint: string;
|
|
20097
|
-
decimals:
|
|
20902
|
+
decimals: number;
|
|
20098
20903
|
};
|
|
20099
20904
|
apy: {
|
|
20100
20905
|
current: string | null;
|
|
@@ -20120,11 +20925,11 @@ interface operations {
|
|
|
20120
20925
|
};
|
|
20121
20926
|
sharePrice: string | null;
|
|
20122
20927
|
tokensPerShare: string | null;
|
|
20123
|
-
numberOfHolders:
|
|
20928
|
+
numberOfHolders: number | null;
|
|
20124
20929
|
fees: {
|
|
20125
|
-
performanceFeeBps:
|
|
20126
|
-
managementFeeBps:
|
|
20127
|
-
withdrawalPenaltyBps:
|
|
20930
|
+
performanceFeeBps: number;
|
|
20931
|
+
managementFeeBps: number;
|
|
20932
|
+
withdrawalPenaltyBps: number;
|
|
20128
20933
|
};
|
|
20129
20934
|
limits: {
|
|
20130
20935
|
minDepositAmount: string;
|
|
@@ -20577,7 +21382,7 @@ interface operations {
|
|
|
20577
21382
|
/** @enum {string} */
|
|
20578
21383
|
symbol: "USDC" | "UNKNOWN";
|
|
20579
21384
|
mint: string | null;
|
|
20580
|
-
decimals:
|
|
21385
|
+
decimals: number | null;
|
|
20581
21386
|
};
|
|
20582
21387
|
shares: {
|
|
20583
21388
|
staked: string;
|
|
@@ -20781,7 +21586,7 @@ interface operations {
|
|
|
20781
21586
|
depositToken: {
|
|
20782
21587
|
symbol: "USDC" | "UNKNOWN";
|
|
20783
21588
|
mint: string | null;
|
|
20784
|
-
decimals:
|
|
21589
|
+
decimals: number | null;
|
|
20785
21590
|
};
|
|
20786
21591
|
shares: {
|
|
20787
21592
|
staked: string;
|
|
@@ -22134,7 +22939,7 @@ interface operations {
|
|
|
22134
22939
|
status: "information_required" | "challenge_required";
|
|
22135
22940
|
challenge?: {
|
|
22136
22941
|
questions: {
|
|
22137
|
-
id: string
|
|
22942
|
+
id: string;
|
|
22138
22943
|
prompt: string | null;
|
|
22139
22944
|
options: {
|
|
22140
22945
|
id: string;
|
|
@@ -22299,7 +23104,7 @@ interface operations {
|
|
|
22299
23104
|
status: "information_required" | "challenge_required";
|
|
22300
23105
|
challenge?: {
|
|
22301
23106
|
questions: {
|
|
22302
|
-
id: string
|
|
23107
|
+
id: string;
|
|
22303
23108
|
prompt: string | null;
|
|
22304
23109
|
options: {
|
|
22305
23110
|
id: string;
|
|
@@ -22475,7 +23280,7 @@ interface operations {
|
|
|
22475
23280
|
status: "information_required" | "challenge_required";
|
|
22476
23281
|
challenge?: {
|
|
22477
23282
|
questions: {
|
|
22478
|
-
id: string
|
|
23283
|
+
id: string;
|
|
22479
23284
|
prompt: string | null;
|
|
22480
23285
|
options: {
|
|
22481
23286
|
id: string;
|
|
@@ -23109,6 +23914,7 @@ declare class BankAccountService {
|
|
|
23109
23914
|
list(): Promise<({
|
|
23110
23915
|
id: string;
|
|
23111
23916
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
23917
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23112
23918
|
accountHolderName: string;
|
|
23113
23919
|
institution?: {
|
|
23114
23920
|
name: string;
|
|
@@ -23126,6 +23932,7 @@ declare class BankAccountService {
|
|
|
23126
23932
|
} | {
|
|
23127
23933
|
id: string;
|
|
23128
23934
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
23935
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23129
23936
|
accountHolderName: string;
|
|
23130
23937
|
institution?: {
|
|
23131
23938
|
name: string;
|
|
@@ -23144,6 +23951,7 @@ declare class BankAccountService {
|
|
|
23144
23951
|
} | {
|
|
23145
23952
|
id: string;
|
|
23146
23953
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
23954
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23147
23955
|
accountHolderName: string;
|
|
23148
23956
|
institution?: {
|
|
23149
23957
|
name: string;
|
|
@@ -23160,6 +23968,7 @@ declare class BankAccountService {
|
|
|
23160
23968
|
} | {
|
|
23161
23969
|
id: string;
|
|
23162
23970
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
23971
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23163
23972
|
accountHolderName: string;
|
|
23164
23973
|
institution?: {
|
|
23165
23974
|
name: string;
|
|
@@ -23177,6 +23986,7 @@ declare class BankAccountService {
|
|
|
23177
23986
|
get(accountId: string): Promise<{
|
|
23178
23987
|
id: string;
|
|
23179
23988
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
23989
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23180
23990
|
accountHolderName: string;
|
|
23181
23991
|
institution?: {
|
|
23182
23992
|
name: string;
|
|
@@ -23194,6 +24004,7 @@ declare class BankAccountService {
|
|
|
23194
24004
|
} | {
|
|
23195
24005
|
id: string;
|
|
23196
24006
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
24007
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23197
24008
|
accountHolderName: string;
|
|
23198
24009
|
institution?: {
|
|
23199
24010
|
name: string;
|
|
@@ -23212,6 +24023,7 @@ declare class BankAccountService {
|
|
|
23212
24023
|
} | {
|
|
23213
24024
|
id: string;
|
|
23214
24025
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
24026
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23215
24027
|
accountHolderName: string;
|
|
23216
24028
|
institution?: {
|
|
23217
24029
|
name: string;
|
|
@@ -23228,6 +24040,7 @@ declare class BankAccountService {
|
|
|
23228
24040
|
} | {
|
|
23229
24041
|
id: string;
|
|
23230
24042
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
24043
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23231
24044
|
accountHolderName: string;
|
|
23232
24045
|
institution?: {
|
|
23233
24046
|
name: string;
|
|
@@ -23245,6 +24058,7 @@ declare class BankAccountService {
|
|
|
23245
24058
|
create(input: CreateBankAccountInput): Promise<{
|
|
23246
24059
|
id: string;
|
|
23247
24060
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
24061
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23248
24062
|
accountHolderName: string;
|
|
23249
24063
|
institution?: {
|
|
23250
24064
|
name: string;
|
|
@@ -23262,6 +24076,7 @@ declare class BankAccountService {
|
|
|
23262
24076
|
} | {
|
|
23263
24077
|
id: string;
|
|
23264
24078
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
24079
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23265
24080
|
accountHolderName: string;
|
|
23266
24081
|
institution?: {
|
|
23267
24082
|
name: string;
|
|
@@ -23280,6 +24095,7 @@ declare class BankAccountService {
|
|
|
23280
24095
|
} | {
|
|
23281
24096
|
id: string;
|
|
23282
24097
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
24098
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23283
24099
|
accountHolderName: string;
|
|
23284
24100
|
institution?: {
|
|
23285
24101
|
name: string;
|
|
@@ -23296,6 +24112,7 @@ declare class BankAccountService {
|
|
|
23296
24112
|
} | {
|
|
23297
24113
|
id: string;
|
|
23298
24114
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
24115
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23299
24116
|
accountHolderName: string;
|
|
23300
24117
|
institution?: {
|
|
23301
24118
|
name: string;
|
|
@@ -23324,6 +24141,7 @@ declare class BankAccountService {
|
|
|
23324
24141
|
bankAccounts: ({
|
|
23325
24142
|
id: string;
|
|
23326
24143
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
24144
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23327
24145
|
accountHolderName: string;
|
|
23328
24146
|
institution?: {
|
|
23329
24147
|
name: string;
|
|
@@ -23341,6 +24159,7 @@ declare class BankAccountService {
|
|
|
23341
24159
|
} | {
|
|
23342
24160
|
id: string;
|
|
23343
24161
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
24162
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23344
24163
|
accountHolderName: string;
|
|
23345
24164
|
institution?: {
|
|
23346
24165
|
name: string;
|
|
@@ -23359,6 +24178,7 @@ declare class BankAccountService {
|
|
|
23359
24178
|
} | {
|
|
23360
24179
|
id: string;
|
|
23361
24180
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
24181
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23362
24182
|
accountHolderName: string;
|
|
23363
24183
|
institution?: {
|
|
23364
24184
|
name: string;
|
|
@@ -23375,6 +24195,7 @@ declare class BankAccountService {
|
|
|
23375
24195
|
} | {
|
|
23376
24196
|
id: string;
|
|
23377
24197
|
status: "active" | "pending" | "inactive" | "rejected";
|
|
24198
|
+
statusReason: ("account_invalid" | null) | ("account_closed" | null) | ("account_blocked" | null);
|
|
23378
24199
|
accountHolderName: string;
|
|
23379
24200
|
institution?: {
|
|
23380
24201
|
name: string;
|
|
@@ -24968,7 +25789,7 @@ declare class FundingSourceService {
|
|
|
24968
25789
|
accountNumberLast4: string | null;
|
|
24969
25790
|
accountType: "checking" | "savings" | "business" | "unknown";
|
|
24970
25791
|
status: "pending" | "active" | "review_required" | "ineligible" | "disabled" | "deleted";
|
|
24971
|
-
statusReason: ("ownership_mismatch" | null) | ("ownership_review_required" | null) | ("user_not_verified" | null) | ("duplicate_bank_account" | null) | ("returned" | null) | ("risk_blocked" | null) | ("manually_disabled" | null);
|
|
25792
|
+
statusReason: ("ownership_mismatch" | null) | ("ownership_review_required" | null) | ("user_not_verified" | null) | ("duplicate_bank_account" | null) | ("returned" | null) | ("risk_blocked" | null) | ("rerouted" | null) | ("manually_disabled" | null);
|
|
24972
25793
|
ownershipMatchStatus: ("matched" | null) | ("mismatch" | null) | ("review_required" | null);
|
|
24973
25794
|
deletedAt: string | null;
|
|
24974
25795
|
createdAt: string;
|
|
@@ -24985,7 +25806,7 @@ declare class FundingSourceService {
|
|
|
24985
25806
|
accountNumberLast4: string | null;
|
|
24986
25807
|
accountType: "checking" | "savings" | "business" | "unknown";
|
|
24987
25808
|
status: "pending" | "active" | "review_required" | "ineligible" | "disabled" | "deleted";
|
|
24988
|
-
statusReason: ("ownership_mismatch" | null) | ("ownership_review_required" | null) | ("user_not_verified" | null) | ("duplicate_bank_account" | null) | ("returned" | null) | ("risk_blocked" | null) | ("manually_disabled" | null);
|
|
25809
|
+
statusReason: ("ownership_mismatch" | null) | ("ownership_review_required" | null) | ("user_not_verified" | null) | ("duplicate_bank_account" | null) | ("returned" | null) | ("risk_blocked" | null) | ("rerouted" | null) | ("manually_disabled" | null);
|
|
24989
25810
|
ownershipMatchStatus: ("matched" | null) | ("mismatch" | null) | ("review_required" | null);
|
|
24990
25811
|
deletedAt: string | null;
|
|
24991
25812
|
createdAt: string;
|
|
@@ -25083,6 +25904,49 @@ declare class SandboxService {
|
|
|
25083
25904
|
}>;
|
|
25084
25905
|
}
|
|
25085
25906
|
|
|
25907
|
+
type OffRampRefundRequest = PathRequestBody<'/v1/off-ramps/{offRampId}/refund', 'post'>;
|
|
25908
|
+
type OffRampRefundResponse = PathResponse<'/v1/off-ramps/{offRampId}/refund', 'post'>;
|
|
25909
|
+
declare class OfframpService {
|
|
25910
|
+
private client;
|
|
25911
|
+
constructor(client: SpritzClient);
|
|
25912
|
+
/**
|
|
25913
|
+
* Refund a failed off-ramp payment.
|
|
25914
|
+
*
|
|
25915
|
+
* Pass `{ method: 'credit' }` to return the funds to the user's Spritz balance, or
|
|
25916
|
+
* `{ method: 'account', accountId }` to reissue the payout to a different bank account.
|
|
25917
|
+
* Omit `accountId` to reuse the off-ramp's original destination account.
|
|
25918
|
+
*
|
|
25919
|
+
* Only failed Modern Treasury and Checkbook off-ramps can be refunded.
|
|
25920
|
+
*/
|
|
25921
|
+
refund(offRampId: string, input: OffRampRefundRequest): Promise<{
|
|
25922
|
+
id: string;
|
|
25923
|
+
status: "awaiting_funding" | "queued" | "in_flight" | "completed" | "canceled" | "failed" | "reversed" | "refunded";
|
|
25924
|
+
createdAt: string;
|
|
25925
|
+
completedAt: string | null;
|
|
25926
|
+
input: {
|
|
25927
|
+
amount: string;
|
|
25928
|
+
token: string;
|
|
25929
|
+
chain: "ethereum" | "polygon" | "arbitrum" | "base" | "optimism" | "avalanche" | "binance-smart-chain" | "solana" | "bitcoin" | "dash" | "tron" | "sui" | "hyperevm" | "monad" | "sonic" | "unichain";
|
|
25930
|
+
} | null;
|
|
25931
|
+
output: {
|
|
25932
|
+
amount: string;
|
|
25933
|
+
currency: string;
|
|
25934
|
+
accountId: string;
|
|
25935
|
+
accountName: string | null;
|
|
25936
|
+
rail: ("ach_standard" | null) | ("ach_same_day" | null) | ("rtp" | null) | ("wire" | null) | ("eft" | null) | ("sepa" | null) | ("faster_payments" | null) | ("push_to_card" | null) | ("bill_pay" | null) | ("card_deposit" | null);
|
|
25937
|
+
};
|
|
25938
|
+
fiatDestination: ("bank_account" | null) | ("bill" | null) | ("crypto_card" | null);
|
|
25939
|
+
fees: {
|
|
25940
|
+
amount: string;
|
|
25941
|
+
currency: string;
|
|
25942
|
+
} | null;
|
|
25943
|
+
transaction: {
|
|
25944
|
+
hash: string | null;
|
|
25945
|
+
explorerUrl: string | null;
|
|
25946
|
+
} | null;
|
|
25947
|
+
}>;
|
|
25948
|
+
}
|
|
25949
|
+
|
|
25086
25950
|
interface CreateOnrampPayment_createOnrampPayment_depositInstructions {
|
|
25087
25951
|
__typename: 'OnrampPaymentDepositInstructions';
|
|
25088
25952
|
amount: number;
|
|
@@ -25638,6 +26502,7 @@ declare class SpritzApiClient {
|
|
|
25638
26502
|
payment: PaymentService;
|
|
25639
26503
|
onrampPayment: OnrampPaymentService;
|
|
25640
26504
|
onramp: OnrampService;
|
|
26505
|
+
offramp: OfframpService;
|
|
25641
26506
|
virtualAccounts: VirtualAccountsService;
|
|
25642
26507
|
virtualCard: VirtualCardService;
|
|
25643
26508
|
bill: BillService;
|
|
@@ -25714,4 +26579,4 @@ declare class InternalServerError extends APIError {
|
|
|
25714
26579
|
}
|
|
25715
26580
|
|
|
25716
26581
|
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, onrampSupportedTokens };
|
|
25717
|
-
export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, BankAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BankAccountList, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, CreateBankAccountInput, CreateBankAccountResponse, CreateDepositRequest, CreateDepositWithReturnRequest, CreateDepositWithReturnResponse, CreateDirectPaymentInput, CreateOnrampPaymentInput, CreatePaymentRequestInput, CreateVirtualAccountInput, CreateWebhookParams, CurrentUser, CurrentUser_me, CurrentUser_verification, CurrentUser_verification_identity, CurrentUser_verification_identity_verificationMetadata, CurrentUser_verification_identity_verificationMetadata_details, DebitCardFragment, DebitCardInput, DeleteBankAccountResponse, DeleteFundingSourceResponse, Deposit, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkTokenResponse, 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, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, TokenBalanceFragment, UpdateWebhookParams, UpdateWebhookSecretResponse, UserAccess, UserAccessCapabilities, UserAccess_bridgeUser, UserAccess_me, UserAccess_verification, UserAccess_verification_identity, UserAccess_verification_identity_verificationMetadata, UserAccess_verification_identity_verificationMetadata_details, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, 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, VirtualAccountFragment, VirtualAccountFragment_depositInstructions, VirtualAccounts, VirtualAccounts_virtualAccounts, VirtualAccounts_virtualAccounts_depositInstructions, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances, WebhookEvent };
|
|
26582
|
+
export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, BankAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BankAccountList, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, CreateBankAccountInput, CreateBankAccountResponse, CreateDepositRequest, CreateDepositWithReturnRequest, CreateDepositWithReturnResponse, CreateDirectPaymentInput, CreateOnrampPaymentInput, CreatePaymentRequestInput, CreateVirtualAccountInput, CreateWebhookParams, CurrentUser, CurrentUser_me, CurrentUser_verification, CurrentUser_verification_identity, CurrentUser_verification_identity_verificationMetadata, CurrentUser_verification_identity_verificationMetadata_details, DebitCardFragment, DebitCardInput, DeleteBankAccountResponse, DeleteFundingSourceResponse, Deposit, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkTokenResponse, OffRampRefundRequest, OffRampRefundResponse, OnRamp, OnRampDetail, OnRampListQuery, OnRampListResponse, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PathParams, PathQuery, PathRequestBody, PathResponse, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentFragment_transaction, PaymentLimits, PaymentLimitsResponse, PaymentLimitsVariables, PaymentLimits_paymentLimits, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, PrepareDepositRequest, PrepareDepositResponse, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, TokenBalanceFragment, UpdateWebhookParams, UpdateWebhookSecretResponse, UserAccess, UserAccessCapabilities, UserAccess_bridgeUser, UserAccess_me, UserAccess_verification, UserAccess_verification_identity, UserAccess_verification_identity_verificationMetadata, UserAccess_verification_identity_verificationMetadata_details, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, 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, VirtualAccountFragment, VirtualAccountFragment_depositInstructions, VirtualAccounts, VirtualAccounts_virtualAccounts, VirtualAccounts_virtualAccounts_depositInstructions, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances, WebhookEvent };
|