@spritz-finance/api-client 0.7.2 → 0.7.3
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/dist/spritz-api-client.cjs +1 -1
- package/dist/spritz-api-client.d.ts +602 -2031
- package/dist/spritz-api-client.mjs +1 -1
- package/package.json +1 -1
|
@@ -530,90 +530,6 @@ interface paths {
|
|
|
530
530
|
patch?: never;
|
|
531
531
|
trace?: never;
|
|
532
532
|
};
|
|
533
|
-
"/v1/deposit-destinations/prepare": {
|
|
534
|
-
parameters: {
|
|
535
|
-
query?: never;
|
|
536
|
-
header?: never;
|
|
537
|
-
path?: never;
|
|
538
|
-
cookie?: never;
|
|
539
|
-
};
|
|
540
|
-
get?: never;
|
|
541
|
-
put?: never;
|
|
542
|
-
/**
|
|
543
|
-
* Prepare a deposit destination bind
|
|
544
|
-
* @description Creates the canonical message a wallet must sign to bind a deposit destination to a funding source.
|
|
545
|
-
*/
|
|
546
|
-
post: operations["postV1Deposit-destinationsPrepare"];
|
|
547
|
-
delete?: never;
|
|
548
|
-
options?: never;
|
|
549
|
-
head?: never;
|
|
550
|
-
patch?: never;
|
|
551
|
-
trace?: never;
|
|
552
|
-
};
|
|
553
|
-
"/v1/deposit-destinations/": {
|
|
554
|
-
parameters: {
|
|
555
|
-
query?: never;
|
|
556
|
-
header?: never;
|
|
557
|
-
path?: never;
|
|
558
|
-
cookie?: never;
|
|
559
|
-
};
|
|
560
|
-
/**
|
|
561
|
-
* List deposit destinations
|
|
562
|
-
* @description Returns the authenticated user's bound deposit destinations.
|
|
563
|
-
*/
|
|
564
|
-
get: operations["getV1Deposit-destinations"];
|
|
565
|
-
put?: never;
|
|
566
|
-
/**
|
|
567
|
-
* Bind a deposit destination
|
|
568
|
-
* @description Verifies the signed destination bind message and stores the bound wallet destination.
|
|
569
|
-
*/
|
|
570
|
-
post: operations["postV1Deposit-destinations"];
|
|
571
|
-
delete?: never;
|
|
572
|
-
options?: never;
|
|
573
|
-
head?: never;
|
|
574
|
-
patch?: never;
|
|
575
|
-
trace?: never;
|
|
576
|
-
};
|
|
577
|
-
"/v1/deposits/prepare": {
|
|
578
|
-
parameters: {
|
|
579
|
-
query?: never;
|
|
580
|
-
header?: never;
|
|
581
|
-
path?: never;
|
|
582
|
-
cookie?: never;
|
|
583
|
-
};
|
|
584
|
-
get?: never;
|
|
585
|
-
put?: never;
|
|
586
|
-
/**
|
|
587
|
-
* Prepare a deposit authorization
|
|
588
|
-
* @description Creates the canonical ACH authorization message a wallet must sign for a single deposit.
|
|
589
|
-
*/
|
|
590
|
-
post: operations["postV1DepositsPrepare"];
|
|
591
|
-
delete?: never;
|
|
592
|
-
options?: never;
|
|
593
|
-
head?: never;
|
|
594
|
-
patch?: never;
|
|
595
|
-
trace?: never;
|
|
596
|
-
};
|
|
597
|
-
"/v1/deposits/": {
|
|
598
|
-
parameters: {
|
|
599
|
-
query?: never;
|
|
600
|
-
header?: never;
|
|
601
|
-
path?: never;
|
|
602
|
-
cookie?: never;
|
|
603
|
-
};
|
|
604
|
-
get?: never;
|
|
605
|
-
put?: never;
|
|
606
|
-
/**
|
|
607
|
-
* Create a deposit
|
|
608
|
-
* @description Verifies the signed ACH authorization and creates a deposit for asynchronous debit and release processing.
|
|
609
|
-
*/
|
|
610
|
-
post: operations["postV1Deposits"];
|
|
611
|
-
delete?: never;
|
|
612
|
-
options?: never;
|
|
613
|
-
head?: never;
|
|
614
|
-
patch?: never;
|
|
615
|
-
trace?: never;
|
|
616
|
-
};
|
|
617
533
|
"/v1/deposits/direct/prepare": {
|
|
618
534
|
parameters: {
|
|
619
535
|
query?: never;
|
|
@@ -1971,26 +1887,6 @@ interface paths {
|
|
|
1971
1887
|
patch?: never;
|
|
1972
1888
|
trace?: never;
|
|
1973
1889
|
};
|
|
1974
|
-
"/v1/sandbox/deposits": {
|
|
1975
|
-
parameters: {
|
|
1976
|
-
query?: never;
|
|
1977
|
-
header?: never;
|
|
1978
|
-
path?: never;
|
|
1979
|
-
cookie?: never;
|
|
1980
|
-
};
|
|
1981
|
-
get?: never;
|
|
1982
|
-
put?: never;
|
|
1983
|
-
/**
|
|
1984
|
-
* Create a sandbox deposit with an armed ACH return
|
|
1985
|
-
* @description Creates a deposit in sandbox and routes the Modern Treasury debit through a return-code-backed receiving account for end-to-end return testing.
|
|
1986
|
-
*/
|
|
1987
|
-
post: operations["postV1SandboxDeposits"];
|
|
1988
|
-
delete?: never;
|
|
1989
|
-
options?: never;
|
|
1990
|
-
head?: never;
|
|
1991
|
-
patch?: never;
|
|
1992
|
-
trace?: never;
|
|
1993
|
-
};
|
|
1994
1890
|
"/v1/sandbox/deposits/direct": {
|
|
1995
1891
|
parameters: {
|
|
1996
1892
|
query?: never;
|
|
@@ -2071,6 +1967,26 @@ interface paths {
|
|
|
2071
1967
|
patch?: never;
|
|
2072
1968
|
trace?: never;
|
|
2073
1969
|
};
|
|
1970
|
+
"/v1/sandbox/funding-sources/{fundingSourceId}": {
|
|
1971
|
+
parameters: {
|
|
1972
|
+
query?: never;
|
|
1973
|
+
header?: never;
|
|
1974
|
+
path?: never;
|
|
1975
|
+
cookie?: never;
|
|
1976
|
+
};
|
|
1977
|
+
get?: never;
|
|
1978
|
+
put?: never;
|
|
1979
|
+
post?: never;
|
|
1980
|
+
/**
|
|
1981
|
+
* Remove a funding source (sandbox only)
|
|
1982
|
+
* @description Permanently removes an ACH debit funding source for the authenticated user. **Only available in sandbox environments** — returns 403 in production. Intended for resetting funding sources during integration testing.
|
|
1983
|
+
*/
|
|
1984
|
+
delete: operations["deleteV1SandboxFunding-sourcesByFundingSourceId"];
|
|
1985
|
+
options?: never;
|
|
1986
|
+
head?: never;
|
|
1987
|
+
patch?: never;
|
|
1988
|
+
trace?: never;
|
|
1989
|
+
};
|
|
2074
1990
|
}
|
|
2075
1991
|
interface operations {
|
|
2076
1992
|
"getV1Auto-ramp-accounts": {
|
|
@@ -2877,7 +2793,7 @@ interface operations {
|
|
|
2877
2793
|
"application/json": {
|
|
2878
2794
|
/**
|
|
2879
2795
|
* @description Destination account ID
|
|
2880
|
-
* @example
|
|
2796
|
+
* @example 6a0d5f1ac3aa49d4f16d0721
|
|
2881
2797
|
*/
|
|
2882
2798
|
accountId: string;
|
|
2883
2799
|
/**
|
|
@@ -2905,7 +2821,7 @@ interface operations {
|
|
|
2905
2821
|
"application/x-www-form-urlencoded": {
|
|
2906
2822
|
/**
|
|
2907
2823
|
* @description Destination account ID
|
|
2908
|
-
* @example
|
|
2824
|
+
* @example 6a0d5f1ac3aa49d4f16d0721
|
|
2909
2825
|
*/
|
|
2910
2826
|
accountId: string;
|
|
2911
2827
|
/**
|
|
@@ -2933,7 +2849,7 @@ interface operations {
|
|
|
2933
2849
|
"multipart/form-data": {
|
|
2934
2850
|
/**
|
|
2935
2851
|
* @description Destination account ID
|
|
2936
|
-
* @example
|
|
2852
|
+
* @example 6a0d5f1ac3aa49d4f16d0721
|
|
2937
2853
|
*/
|
|
2938
2854
|
accountId: string;
|
|
2939
2855
|
/**
|
|
@@ -2980,7 +2896,7 @@ interface operations {
|
|
|
2980
2896
|
/**
|
|
2981
2897
|
* Format: date-time
|
|
2982
2898
|
* @description When the quote was created
|
|
2983
|
-
* @example 2026-05-
|
|
2899
|
+
* @example 2026-05-20T07:13:30.894Z
|
|
2984
2900
|
*/
|
|
2985
2901
|
createdAt: string;
|
|
2986
2902
|
/** @description What the user pays — total USD cost and token used. */
|
|
@@ -3019,7 +2935,7 @@ interface operations {
|
|
|
3019
2935
|
rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
|
|
3020
2936
|
/**
|
|
3021
2937
|
* @description Destination account ID
|
|
3022
|
-
* @example
|
|
2938
|
+
* @example 6a0d5f1ac3aa49d4f16d0722
|
|
3023
2939
|
*/
|
|
3024
2940
|
accountId: string;
|
|
3025
2941
|
};
|
|
@@ -3226,7 +3142,7 @@ interface operations {
|
|
|
3226
3142
|
/**
|
|
3227
3143
|
* Format: date-time
|
|
3228
3144
|
* @description When the quote was created
|
|
3229
|
-
* @example 2026-05-
|
|
3145
|
+
* @example 2026-05-20T07:13:30.894Z
|
|
3230
3146
|
*/
|
|
3231
3147
|
createdAt: string;
|
|
3232
3148
|
/** @description What the user pays — total USD cost and token used. */
|
|
@@ -3265,7 +3181,7 @@ interface operations {
|
|
|
3265
3181
|
rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
|
|
3266
3182
|
/**
|
|
3267
3183
|
* @description Destination account ID
|
|
3268
|
-
* @example
|
|
3184
|
+
* @example 6a0d5f1ac3aa49d4f16d0722
|
|
3269
3185
|
*/
|
|
3270
3186
|
accountId: string;
|
|
3271
3187
|
};
|
|
@@ -3762,7 +3678,7 @@ interface operations {
|
|
|
3762
3678
|
currency: string;
|
|
3763
3679
|
/**
|
|
3764
3680
|
* @description Destination account ID
|
|
3765
|
-
* @example
|
|
3681
|
+
* @example 6a0d5f1ac3aa49d4f16d0723
|
|
3766
3682
|
*/
|
|
3767
3683
|
accountId: string;
|
|
3768
3684
|
accountName: (string | null) | null;
|
|
@@ -3978,7 +3894,7 @@ interface operations {
|
|
|
3978
3894
|
currency: string;
|
|
3979
3895
|
/**
|
|
3980
3896
|
* @description Destination account ID
|
|
3981
|
-
* @example
|
|
3897
|
+
* @example 6a0d5f1ac3aa49d4f16d0723
|
|
3982
3898
|
*/
|
|
3983
3899
|
accountId: string;
|
|
3984
3900
|
accountName: (string | null) | null;
|
|
@@ -7740,7 +7656,7 @@ interface operations {
|
|
|
7740
7656
|
};
|
|
7741
7657
|
};
|
|
7742
7658
|
};
|
|
7743
|
-
|
|
7659
|
+
postV1DepositsDirectPrepare: {
|
|
7744
7660
|
parameters: {
|
|
7745
7661
|
query?: never;
|
|
7746
7662
|
header?: never;
|
|
@@ -7755,15 +7671,32 @@ interface operations {
|
|
|
7755
7671
|
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
7756
7672
|
*/
|
|
7757
7673
|
sourceId: string;
|
|
7758
|
-
/** @constant */
|
|
7759
|
-
network: "solana";
|
|
7760
|
-
/** @constant */
|
|
7761
|
-
asset: "USDC";
|
|
7762
7674
|
/**
|
|
7763
|
-
* @description Destination wallet address
|
|
7764
|
-
* @example
|
|
7675
|
+
* @description Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source.
|
|
7676
|
+
* @example 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY
|
|
7765
7677
|
*/
|
|
7766
7678
|
address: string;
|
|
7679
|
+
/** @enum {string} */
|
|
7680
|
+
network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
|
|
7681
|
+
/**
|
|
7682
|
+
* @description Asset sent to the deposit destination
|
|
7683
|
+
* @example USDC
|
|
7684
|
+
* @constant
|
|
7685
|
+
*/
|
|
7686
|
+
asset: "USDC";
|
|
7687
|
+
/** @enum {string} */
|
|
7688
|
+
quoteType: "exact_input" | "exact_output";
|
|
7689
|
+
/**
|
|
7690
|
+
* @description Requested USD amount as a decimal string
|
|
7691
|
+
* @example 100.00
|
|
7692
|
+
*/
|
|
7693
|
+
amountUsd: string;
|
|
7694
|
+
/** @enum {string} */
|
|
7695
|
+
priority: "normal" | "high";
|
|
7696
|
+
feeSubsidy?: {
|
|
7697
|
+
percentage: number;
|
|
7698
|
+
maxAmountUsd?: string;
|
|
7699
|
+
};
|
|
7767
7700
|
clientContext?: {
|
|
7768
7701
|
clientIp?: string;
|
|
7769
7702
|
userAgent?: string;
|
|
@@ -7779,15 +7712,32 @@ interface operations {
|
|
|
7779
7712
|
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
7780
7713
|
*/
|
|
7781
7714
|
sourceId: string;
|
|
7782
|
-
/** @constant */
|
|
7783
|
-
network: "solana";
|
|
7784
|
-
/** @constant */
|
|
7785
|
-
asset: "USDC";
|
|
7786
7715
|
/**
|
|
7787
|
-
* @description Destination wallet address
|
|
7788
|
-
* @example
|
|
7716
|
+
* @description Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source.
|
|
7717
|
+
* @example 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY
|
|
7789
7718
|
*/
|
|
7790
7719
|
address: string;
|
|
7720
|
+
/** @enum {string} */
|
|
7721
|
+
network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
|
|
7722
|
+
/**
|
|
7723
|
+
* @description Asset sent to the deposit destination
|
|
7724
|
+
* @example USDC
|
|
7725
|
+
* @constant
|
|
7726
|
+
*/
|
|
7727
|
+
asset: "USDC";
|
|
7728
|
+
/** @enum {string} */
|
|
7729
|
+
quoteType: "exact_input" | "exact_output";
|
|
7730
|
+
/**
|
|
7731
|
+
* @description Requested USD amount as a decimal string
|
|
7732
|
+
* @example 100.00
|
|
7733
|
+
*/
|
|
7734
|
+
amountUsd: string;
|
|
7735
|
+
/** @enum {string} */
|
|
7736
|
+
priority: "normal" | "high";
|
|
7737
|
+
feeSubsidy?: {
|
|
7738
|
+
percentage: number;
|
|
7739
|
+
maxAmountUsd?: string;
|
|
7740
|
+
};
|
|
7791
7741
|
clientContext?: {
|
|
7792
7742
|
clientIp?: string;
|
|
7793
7743
|
userAgent?: string;
|
|
@@ -7803,15 +7753,32 @@ interface operations {
|
|
|
7803
7753
|
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
7804
7754
|
*/
|
|
7805
7755
|
sourceId: string;
|
|
7806
|
-
/** @constant */
|
|
7807
|
-
network: "solana";
|
|
7808
|
-
/** @constant */
|
|
7809
|
-
asset: "USDC";
|
|
7810
7756
|
/**
|
|
7811
|
-
* @description Destination wallet address
|
|
7812
|
-
* @example
|
|
7757
|
+
* @description Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source.
|
|
7758
|
+
* @example 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY
|
|
7813
7759
|
*/
|
|
7814
7760
|
address: string;
|
|
7761
|
+
/** @enum {string} */
|
|
7762
|
+
network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
|
|
7763
|
+
/**
|
|
7764
|
+
* @description Asset sent to the deposit destination
|
|
7765
|
+
* @example USDC
|
|
7766
|
+
* @constant
|
|
7767
|
+
*/
|
|
7768
|
+
asset: "USDC";
|
|
7769
|
+
/** @enum {string} */
|
|
7770
|
+
quoteType: "exact_input" | "exact_output";
|
|
7771
|
+
/**
|
|
7772
|
+
* @description Requested USD amount as a decimal string
|
|
7773
|
+
* @example 100.00
|
|
7774
|
+
*/
|
|
7775
|
+
amountUsd: string;
|
|
7776
|
+
/** @enum {string} */
|
|
7777
|
+
priority: "normal" | "high";
|
|
7778
|
+
feeSubsidy?: {
|
|
7779
|
+
percentage: number;
|
|
7780
|
+
maxAmountUsd?: string;
|
|
7781
|
+
};
|
|
7815
7782
|
clientContext?: {
|
|
7816
7783
|
clientIp?: string;
|
|
7817
7784
|
userAgent?: string;
|
|
@@ -7837,20 +7804,43 @@ interface operations {
|
|
|
7837
7804
|
*/
|
|
7838
7805
|
preparationId: string;
|
|
7839
7806
|
/** @constant */
|
|
7840
|
-
kind: "
|
|
7807
|
+
kind: "deposit_authorization";
|
|
7841
7808
|
/** Format: date-time */
|
|
7842
7809
|
expiresAt: string;
|
|
7843
7810
|
/** @constant */
|
|
7844
7811
|
messageVersion: "v1";
|
|
7845
|
-
/** @description
|
|
7812
|
+
/** @description Display-ready ACH authorization message */
|
|
7846
7813
|
message: string;
|
|
7847
|
-
|
|
7848
|
-
|
|
7849
|
-
|
|
7850
|
-
|
|
7851
|
-
|
|
7852
|
-
|
|
7853
|
-
|
|
7814
|
+
summary: {
|
|
7815
|
+
/** @enum {string} */
|
|
7816
|
+
quoteType: "exact_input" | "exact_output";
|
|
7817
|
+
requestedAmountUsd: string;
|
|
7818
|
+
/** @enum {string} */
|
|
7819
|
+
priority: "normal" | "high";
|
|
7820
|
+
feeRateBps: number;
|
|
7821
|
+
principalAmountUsd: string;
|
|
7822
|
+
expectedAssetAmount: string;
|
|
7823
|
+
grossFeeUsd: string;
|
|
7824
|
+
feeSubsidyUsd: string;
|
|
7825
|
+
userFeeUsd: string;
|
|
7826
|
+
totalDebitAmountUsd: string;
|
|
7827
|
+
feeSubsidy: {
|
|
7828
|
+
percentage: number;
|
|
7829
|
+
percentageBps: number;
|
|
7830
|
+
maxAmountUsd: string | null;
|
|
7831
|
+
appliedAmountUsd: string;
|
|
7832
|
+
} | null;
|
|
7833
|
+
/** @enum {string} */
|
|
7834
|
+
network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
|
|
7835
|
+
/**
|
|
7836
|
+
* @description Asset sent to the deposit destination
|
|
7837
|
+
* @example USDC
|
|
7838
|
+
* @constant
|
|
7839
|
+
*/
|
|
7840
|
+
asset: "USDC";
|
|
7841
|
+
assetAddress: string;
|
|
7842
|
+
destinationAddress: string;
|
|
7843
|
+
};
|
|
7854
7844
|
};
|
|
7855
7845
|
};
|
|
7856
7846
|
};
|
|
@@ -7977,61 +7967,134 @@ interface operations {
|
|
|
7977
7967
|
};
|
|
7978
7968
|
};
|
|
7979
7969
|
};
|
|
7980
|
-
|
|
7970
|
+
postV1DepositsDirect: {
|
|
7981
7971
|
parameters: {
|
|
7982
7972
|
query?: never;
|
|
7983
7973
|
header?: never;
|
|
7984
7974
|
path?: never;
|
|
7985
7975
|
cookie?: never;
|
|
7986
7976
|
};
|
|
7987
|
-
requestBody
|
|
7988
|
-
|
|
7989
|
-
|
|
7990
|
-
|
|
7991
|
-
|
|
7992
|
-
|
|
7977
|
+
requestBody: {
|
|
7978
|
+
content: {
|
|
7979
|
+
"application/json": {
|
|
7980
|
+
/**
|
|
7981
|
+
* @description Opaque public preparation identifier returned by direct prepare
|
|
7982
|
+
* @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
7983
|
+
*/
|
|
7984
|
+
preparationId: string;
|
|
7985
|
+
clientContext?: {
|
|
7986
|
+
clientIp?: string;
|
|
7987
|
+
userAgent?: string;
|
|
7988
|
+
sessionId?: string;
|
|
7989
|
+
deviceId?: string;
|
|
7990
|
+
platform?: string;
|
|
7991
|
+
appVersion?: string;
|
|
7992
|
+
};
|
|
7993
7993
|
};
|
|
7994
|
-
|
|
7995
|
-
|
|
7996
|
-
|
|
7997
|
-
|
|
7998
|
-
|
|
7999
|
-
|
|
8000
|
-
|
|
8001
|
-
|
|
8002
|
-
|
|
8003
|
-
|
|
8004
|
-
|
|
8005
|
-
|
|
8006
|
-
|
|
8007
|
-
|
|
8008
|
-
|
|
8009
|
-
|
|
8010
|
-
|
|
8011
|
-
|
|
8012
|
-
|
|
8013
|
-
|
|
8014
|
-
|
|
8015
|
-
|
|
8016
|
-
|
|
8017
|
-
|
|
8018
|
-
|
|
8019
|
-
|
|
8020
|
-
|
|
8021
|
-
|
|
8022
|
-
|
|
8023
|
-
|
|
8024
|
-
|
|
8025
|
-
|
|
8026
|
-
|
|
8027
|
-
|
|
8028
|
-
|
|
8029
|
-
|
|
8030
|
-
|
|
8031
|
-
|
|
8032
|
-
|
|
8033
|
-
|
|
8034
|
-
|
|
7994
|
+
"application/x-www-form-urlencoded": {
|
|
7995
|
+
/**
|
|
7996
|
+
* @description Opaque public preparation identifier returned by direct prepare
|
|
7997
|
+
* @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
7998
|
+
*/
|
|
7999
|
+
preparationId: string;
|
|
8000
|
+
clientContext?: {
|
|
8001
|
+
clientIp?: string;
|
|
8002
|
+
userAgent?: string;
|
|
8003
|
+
sessionId?: string;
|
|
8004
|
+
deviceId?: string;
|
|
8005
|
+
platform?: string;
|
|
8006
|
+
appVersion?: string;
|
|
8007
|
+
};
|
|
8008
|
+
};
|
|
8009
|
+
"multipart/form-data": {
|
|
8010
|
+
/**
|
|
8011
|
+
* @description Opaque public preparation identifier returned by direct prepare
|
|
8012
|
+
* @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8013
|
+
*/
|
|
8014
|
+
preparationId: string;
|
|
8015
|
+
clientContext?: {
|
|
8016
|
+
clientIp?: string;
|
|
8017
|
+
userAgent?: string;
|
|
8018
|
+
sessionId?: string;
|
|
8019
|
+
deviceId?: string;
|
|
8020
|
+
platform?: string;
|
|
8021
|
+
appVersion?: string;
|
|
8022
|
+
};
|
|
8023
|
+
};
|
|
8024
|
+
};
|
|
8025
|
+
};
|
|
8026
|
+
responses: {
|
|
8027
|
+
/** @description An ACH debit deposit authorized by the user and processed asynchronously through debit and crypto release lifecycles. */
|
|
8028
|
+
200: {
|
|
8029
|
+
headers: {
|
|
8030
|
+
[name: string]: unknown;
|
|
8031
|
+
};
|
|
8032
|
+
content: {
|
|
8033
|
+
"application/json": {
|
|
8034
|
+
/**
|
|
8035
|
+
* @description Opaque public deposit identifier
|
|
8036
|
+
* @example dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8037
|
+
*/
|
|
8038
|
+
id: string;
|
|
8039
|
+
/**
|
|
8040
|
+
* @description Opaque public funding source identifier
|
|
8041
|
+
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8042
|
+
*/
|
|
8043
|
+
sourceId: string;
|
|
8044
|
+
/** @enum {string} */
|
|
8045
|
+
status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
|
|
8046
|
+
/** @enum {string} */
|
|
8047
|
+
quoteType: "exact_input" | "exact_output";
|
|
8048
|
+
/** @enum {string} */
|
|
8049
|
+
priority: "normal" | "high";
|
|
8050
|
+
feeRateBps: number;
|
|
8051
|
+
principalAmountUsd: string;
|
|
8052
|
+
expectedAssetAmount: string;
|
|
8053
|
+
grossFeeUsd: string;
|
|
8054
|
+
feeSubsidyUsd: string;
|
|
8055
|
+
userFeeUsd: string;
|
|
8056
|
+
totalDebitAmountUsd: string;
|
|
8057
|
+
feeSubsidy: {
|
|
8058
|
+
percentage: number;
|
|
8059
|
+
percentageBps: number;
|
|
8060
|
+
maxAmountUsd: string | null;
|
|
8061
|
+
appliedAmountUsd: string;
|
|
8062
|
+
} | null;
|
|
8063
|
+
/** @enum {string} */
|
|
8064
|
+
network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
|
|
8065
|
+
/**
|
|
8066
|
+
* @description Asset sent to the deposit destination
|
|
8067
|
+
* @example USDC
|
|
8068
|
+
* @constant
|
|
8069
|
+
*/
|
|
8070
|
+
asset: "USDC";
|
|
8071
|
+
assetAddress: string;
|
|
8072
|
+
/** @description Destination wallet address for the crypto release */
|
|
8073
|
+
address: string;
|
|
8074
|
+
/** @enum {string} */
|
|
8075
|
+
debitStatus: "authorized" | "submitting" | "submitted" | "settled" | "returned" | "failed";
|
|
8076
|
+
/** @enum {string} */
|
|
8077
|
+
releaseStatus: "not_started" | "queued" | "partial" | "completed" | "failed";
|
|
8078
|
+
/** @enum {string} */
|
|
8079
|
+
releaseDecisionMode: "after_settlement" | "early_full" | "early_partial";
|
|
8080
|
+
releasedAmountUsd: string;
|
|
8081
|
+
confirmedReleasedAmountUsd: string;
|
|
8082
|
+
exposureAmountUsd: string;
|
|
8083
|
+
/** Format: date-time */
|
|
8084
|
+
authorizedAt: string;
|
|
8085
|
+
/** Format: date-time */
|
|
8086
|
+
createdAt: string;
|
|
8087
|
+
settledAt: string | null;
|
|
8088
|
+
returnedAt: string | null;
|
|
8089
|
+
completedAt: string | null;
|
|
8090
|
+
returnCode: string | null;
|
|
8091
|
+
returnReason: string | null;
|
|
8092
|
+
debitFailureCode: string | null;
|
|
8093
|
+
debitFailureReason: string | null;
|
|
8094
|
+
releaseFailureCode: string | null;
|
|
8095
|
+
releaseFailureReason: string | null;
|
|
8096
|
+
payoutTxHash: string | null;
|
|
8097
|
+
};
|
|
8035
8098
|
};
|
|
8036
8099
|
};
|
|
8037
8100
|
/** @description Response for status 401 */
|
|
@@ -8157,7 +8220,7 @@ interface operations {
|
|
|
8157
8220
|
};
|
|
8158
8221
|
};
|
|
8159
8222
|
};
|
|
8160
|
-
"
|
|
8223
|
+
"postV1Bank-accountsLink-token": {
|
|
8161
8224
|
parameters: {
|
|
8162
8225
|
query?: never;
|
|
8163
8226
|
header?: never;
|
|
@@ -8168,118 +8231,44 @@ interface operations {
|
|
|
8168
8231
|
content: {
|
|
8169
8232
|
"application/json": {
|
|
8170
8233
|
/**
|
|
8171
|
-
* @description
|
|
8172
|
-
* @example
|
|
8173
|
-
|
|
8174
|
-
preparationId: string;
|
|
8175
|
-
/** @description Ed25519 signature over the exact message text. Base58 is preferred for Solana clients; base64 is also accepted. */
|
|
8176
|
-
signature: string;
|
|
8177
|
-
/**
|
|
8178
|
-
* @description Wallet address that produced the signature
|
|
8179
|
-
* @example 9xQeWvG816bUx9EPjHmaT23yvVM3qvGqLrL7Kx1YwM9R
|
|
8234
|
+
* @description Plaid OAuth target. For web or iOS, pass an https:// URL (web return URL or iOS universal link). For Android, pass the package name (e.g. com.example.app) — values without an https:// prefix are forwarded to Plaid as android_package_name with redirect_uri left blank, per Plaid's per-platform requirements.
|
|
8235
|
+
* @example https://app.example.com/plaid/oauth-return
|
|
8236
|
+
* @example com.example.app
|
|
8180
8237
|
*/
|
|
8181
|
-
|
|
8182
|
-
|
|
8183
|
-
clientIp?: string;
|
|
8184
|
-
userAgent?: string;
|
|
8185
|
-
sessionId?: string;
|
|
8186
|
-
deviceId?: string;
|
|
8187
|
-
platform?: string;
|
|
8188
|
-
appVersion?: string;
|
|
8189
|
-
};
|
|
8190
|
-
};
|
|
8238
|
+
redirectUri?: string;
|
|
8239
|
+
} | Record<string, never>;
|
|
8191
8240
|
"application/x-www-form-urlencoded": {
|
|
8192
8241
|
/**
|
|
8193
|
-
* @description
|
|
8194
|
-
* @example
|
|
8195
|
-
|
|
8196
|
-
preparationId: string;
|
|
8197
|
-
/** @description Ed25519 signature over the exact message text. Base58 is preferred for Solana clients; base64 is also accepted. */
|
|
8198
|
-
signature: string;
|
|
8199
|
-
/**
|
|
8200
|
-
* @description Wallet address that produced the signature
|
|
8201
|
-
* @example 9xQeWvG816bUx9EPjHmaT23yvVM3qvGqLrL7Kx1YwM9R
|
|
8242
|
+
* @description Plaid OAuth target. For web or iOS, pass an https:// URL (web return URL or iOS universal link). For Android, pass the package name (e.g. com.example.app) — values without an https:// prefix are forwarded to Plaid as android_package_name with redirect_uri left blank, per Plaid's per-platform requirements.
|
|
8243
|
+
* @example https://app.example.com/plaid/oauth-return
|
|
8244
|
+
* @example com.example.app
|
|
8202
8245
|
*/
|
|
8203
|
-
|
|
8204
|
-
|
|
8205
|
-
clientIp?: string;
|
|
8206
|
-
userAgent?: string;
|
|
8207
|
-
sessionId?: string;
|
|
8208
|
-
deviceId?: string;
|
|
8209
|
-
platform?: string;
|
|
8210
|
-
appVersion?: string;
|
|
8211
|
-
};
|
|
8212
|
-
};
|
|
8246
|
+
redirectUri?: string;
|
|
8247
|
+
} | Record<string, never>;
|
|
8213
8248
|
"multipart/form-data": {
|
|
8214
8249
|
/**
|
|
8215
|
-
* @description
|
|
8216
|
-
* @example
|
|
8217
|
-
|
|
8218
|
-
preparationId: string;
|
|
8219
|
-
/** @description Ed25519 signature over the exact message text. Base58 is preferred for Solana clients; base64 is also accepted. */
|
|
8220
|
-
signature: string;
|
|
8221
|
-
/**
|
|
8222
|
-
* @description Wallet address that produced the signature
|
|
8223
|
-
* @example 9xQeWvG816bUx9EPjHmaT23yvVM3qvGqLrL7Kx1YwM9R
|
|
8250
|
+
* @description Plaid OAuth target. For web or iOS, pass an https:// URL (web return URL or iOS universal link). For Android, pass the package name (e.g. com.example.app) — values without an https:// prefix are forwarded to Plaid as android_package_name with redirect_uri left blank, per Plaid's per-platform requirements.
|
|
8251
|
+
* @example https://app.example.com/plaid/oauth-return
|
|
8252
|
+
* @example com.example.app
|
|
8224
8253
|
*/
|
|
8225
|
-
|
|
8226
|
-
|
|
8227
|
-
clientIp?: string;
|
|
8228
|
-
userAgent?: string;
|
|
8229
|
-
sessionId?: string;
|
|
8230
|
-
deviceId?: string;
|
|
8231
|
-
platform?: string;
|
|
8232
|
-
appVersion?: string;
|
|
8233
|
-
};
|
|
8234
|
-
};
|
|
8254
|
+
redirectUri?: string;
|
|
8255
|
+
} | Record<string, never>;
|
|
8235
8256
|
};
|
|
8236
8257
|
};
|
|
8237
8258
|
responses: {
|
|
8238
|
-
/** @description
|
|
8259
|
+
/** @description Response for status 200 */
|
|
8239
8260
|
200: {
|
|
8240
8261
|
headers: {
|
|
8241
8262
|
[name: string]: unknown;
|
|
8242
8263
|
};
|
|
8243
8264
|
content: {
|
|
8244
8265
|
"application/json": {
|
|
8245
|
-
/**
|
|
8246
|
-
|
|
8247
|
-
|
|
8248
|
-
|
|
8249
|
-
|
|
8250
|
-
|
|
8251
|
-
* @description Opaque public funding source identifier
|
|
8252
|
-
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8253
|
-
*/
|
|
8254
|
-
sourceId: string;
|
|
8255
|
-
/**
|
|
8256
|
-
* @description Blockchain network for the bound deposit destination
|
|
8257
|
-
* @example solana
|
|
8258
|
-
* @constant
|
|
8259
|
-
*/
|
|
8260
|
-
network: "solana";
|
|
8261
|
-
/**
|
|
8262
|
-
* @description Asset sent to the deposit destination
|
|
8263
|
-
* @example USDC
|
|
8264
|
-
* @constant
|
|
8265
|
-
*/
|
|
8266
|
-
asset: "USDC";
|
|
8267
|
-
/**
|
|
8268
|
-
* @description Canonical asset address or mint address for the selected network and asset
|
|
8269
|
-
* @example EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
|
|
8270
|
-
*/
|
|
8271
|
-
assetAddress: string;
|
|
8272
|
-
/** @description Bound wallet destination address */
|
|
8273
|
-
address: string;
|
|
8274
|
-
/** @enum {string} */
|
|
8275
|
-
status: "active" | "revoked";
|
|
8276
|
-
/**
|
|
8277
|
-
* Format: date-time
|
|
8278
|
-
* @description When the destination was created
|
|
8279
|
-
*/
|
|
8280
|
-
createdAt: string;
|
|
8281
|
-
/** @description When the destination was revoked, or null when active */
|
|
8282
|
-
revokedAt: string | null;
|
|
8266
|
+
/** @description Token to initialize Plaid Link SDK */
|
|
8267
|
+
linkToken: string;
|
|
8268
|
+
/** @description Plaid-hosted URL for bank linking. Open in browser or webview. Null if hosted link was not requested. */
|
|
8269
|
+
hostedLinkUrl: string | null;
|
|
8270
|
+
expiration: string;
|
|
8271
|
+
requestId: string;
|
|
8283
8272
|
};
|
|
8284
8273
|
};
|
|
8285
8274
|
};
|
|
@@ -8331,41 +8320,6 @@ interface operations {
|
|
|
8331
8320
|
};
|
|
8332
8321
|
};
|
|
8333
8322
|
};
|
|
8334
|
-
/** @description Response for status 404 */
|
|
8335
|
-
404: {
|
|
8336
|
-
headers: {
|
|
8337
|
-
[name: string]: unknown;
|
|
8338
|
-
};
|
|
8339
|
-
content: {
|
|
8340
|
-
"application/json": {
|
|
8341
|
-
/**
|
|
8342
|
-
* @description A URI reference that identifies the problem type
|
|
8343
|
-
* @default about:blank
|
|
8344
|
-
*/
|
|
8345
|
-
type: string;
|
|
8346
|
-
/** @description A short, human-readable summary of the problem type */
|
|
8347
|
-
title: string;
|
|
8348
|
-
/**
|
|
8349
|
-
* @description The HTTP status code
|
|
8350
|
-
* @example 404
|
|
8351
|
-
*/
|
|
8352
|
-
status: number;
|
|
8353
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
8354
|
-
detail?: string;
|
|
8355
|
-
/** @description A URI reference that identifies the specific occurrence */
|
|
8356
|
-
instance?: string;
|
|
8357
|
-
/**
|
|
8358
|
-
* @description The type of resource that was not found
|
|
8359
|
-
* @example user
|
|
8360
|
-
* @example account
|
|
8361
|
-
* @example transaction
|
|
8362
|
-
*/
|
|
8363
|
-
resourceType: string;
|
|
8364
|
-
/** @description The identifier of the resource that was not found */
|
|
8365
|
-
resourceId: string;
|
|
8366
|
-
};
|
|
8367
|
-
};
|
|
8368
|
-
};
|
|
8369
8323
|
/** @description Response for status 500 */
|
|
8370
8324
|
500: {
|
|
8371
8325
|
headers: {
|
|
@@ -8406,1255 +8360,7 @@ interface operations {
|
|
|
8406
8360
|
};
|
|
8407
8361
|
};
|
|
8408
8362
|
};
|
|
8409
|
-
|
|
8410
|
-
parameters: {
|
|
8411
|
-
query?: never;
|
|
8412
|
-
header?: never;
|
|
8413
|
-
path?: never;
|
|
8414
|
-
cookie?: never;
|
|
8415
|
-
};
|
|
8416
|
-
requestBody: {
|
|
8417
|
-
content: {
|
|
8418
|
-
"application/json": {
|
|
8419
|
-
/**
|
|
8420
|
-
* @description Opaque public funding source identifier
|
|
8421
|
-
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8422
|
-
*/
|
|
8423
|
-
sourceId: string;
|
|
8424
|
-
/**
|
|
8425
|
-
* @description Opaque public deposit destination identifier
|
|
8426
|
-
* @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8427
|
-
*/
|
|
8428
|
-
destinationId: string;
|
|
8429
|
-
/** @enum {string} */
|
|
8430
|
-
quoteType: "exact_input" | "exact_output";
|
|
8431
|
-
/**
|
|
8432
|
-
* @description Requested USD amount as a decimal string
|
|
8433
|
-
* @example 100.00
|
|
8434
|
-
*/
|
|
8435
|
-
amountUsd: string;
|
|
8436
|
-
/** @enum {string} */
|
|
8437
|
-
priority: "normal" | "high";
|
|
8438
|
-
feeSubsidy?: {
|
|
8439
|
-
percentage: number;
|
|
8440
|
-
maxAmountUsd?: string;
|
|
8441
|
-
};
|
|
8442
|
-
clientContext?: {
|
|
8443
|
-
clientIp?: string;
|
|
8444
|
-
userAgent?: string;
|
|
8445
|
-
sessionId?: string;
|
|
8446
|
-
deviceId?: string;
|
|
8447
|
-
platform?: string;
|
|
8448
|
-
appVersion?: string;
|
|
8449
|
-
};
|
|
8450
|
-
};
|
|
8451
|
-
"application/x-www-form-urlencoded": {
|
|
8452
|
-
/**
|
|
8453
|
-
* @description Opaque public funding source identifier
|
|
8454
|
-
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8455
|
-
*/
|
|
8456
|
-
sourceId: string;
|
|
8457
|
-
/**
|
|
8458
|
-
* @description Opaque public deposit destination identifier
|
|
8459
|
-
* @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8460
|
-
*/
|
|
8461
|
-
destinationId: string;
|
|
8462
|
-
/** @enum {string} */
|
|
8463
|
-
quoteType: "exact_input" | "exact_output";
|
|
8464
|
-
/**
|
|
8465
|
-
* @description Requested USD amount as a decimal string
|
|
8466
|
-
* @example 100.00
|
|
8467
|
-
*/
|
|
8468
|
-
amountUsd: string;
|
|
8469
|
-
/** @enum {string} */
|
|
8470
|
-
priority: "normal" | "high";
|
|
8471
|
-
feeSubsidy?: {
|
|
8472
|
-
percentage: number;
|
|
8473
|
-
maxAmountUsd?: string;
|
|
8474
|
-
};
|
|
8475
|
-
clientContext?: {
|
|
8476
|
-
clientIp?: string;
|
|
8477
|
-
userAgent?: string;
|
|
8478
|
-
sessionId?: string;
|
|
8479
|
-
deviceId?: string;
|
|
8480
|
-
platform?: string;
|
|
8481
|
-
appVersion?: string;
|
|
8482
|
-
};
|
|
8483
|
-
};
|
|
8484
|
-
"multipart/form-data": {
|
|
8485
|
-
/**
|
|
8486
|
-
* @description Opaque public funding source identifier
|
|
8487
|
-
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8488
|
-
*/
|
|
8489
|
-
sourceId: string;
|
|
8490
|
-
/**
|
|
8491
|
-
* @description Opaque public deposit destination identifier
|
|
8492
|
-
* @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8493
|
-
*/
|
|
8494
|
-
destinationId: string;
|
|
8495
|
-
/** @enum {string} */
|
|
8496
|
-
quoteType: "exact_input" | "exact_output";
|
|
8497
|
-
/**
|
|
8498
|
-
* @description Requested USD amount as a decimal string
|
|
8499
|
-
* @example 100.00
|
|
8500
|
-
*/
|
|
8501
|
-
amountUsd: string;
|
|
8502
|
-
/** @enum {string} */
|
|
8503
|
-
priority: "normal" | "high";
|
|
8504
|
-
feeSubsidy?: {
|
|
8505
|
-
percentage: number;
|
|
8506
|
-
maxAmountUsd?: string;
|
|
8507
|
-
};
|
|
8508
|
-
clientContext?: {
|
|
8509
|
-
clientIp?: string;
|
|
8510
|
-
userAgent?: string;
|
|
8511
|
-
sessionId?: string;
|
|
8512
|
-
deviceId?: string;
|
|
8513
|
-
platform?: string;
|
|
8514
|
-
appVersion?: string;
|
|
8515
|
-
};
|
|
8516
|
-
};
|
|
8517
|
-
};
|
|
8518
|
-
};
|
|
8519
|
-
responses: {
|
|
8520
|
-
/** @description Response for status 200 */
|
|
8521
|
-
200: {
|
|
8522
|
-
headers: {
|
|
8523
|
-
[name: string]: unknown;
|
|
8524
|
-
};
|
|
8525
|
-
content: {
|
|
8526
|
-
"application/json": {
|
|
8527
|
-
/**
|
|
8528
|
-
* @description Opaque public preparation identifier
|
|
8529
|
-
* @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8530
|
-
*/
|
|
8531
|
-
preparationId: string;
|
|
8532
|
-
/** @constant */
|
|
8533
|
-
kind: "deposit_authorization";
|
|
8534
|
-
/** Format: date-time */
|
|
8535
|
-
expiresAt: string;
|
|
8536
|
-
/** @constant */
|
|
8537
|
-
messageVersion: "v1";
|
|
8538
|
-
/** @description Display-ready ACH authorization message */
|
|
8539
|
-
message: string;
|
|
8540
|
-
summary: {
|
|
8541
|
-
/** @enum {string} */
|
|
8542
|
-
quoteType: "exact_input" | "exact_output";
|
|
8543
|
-
requestedAmountUsd: string;
|
|
8544
|
-
/** @enum {string} */
|
|
8545
|
-
priority: "normal" | "high";
|
|
8546
|
-
feeRateBps: number;
|
|
8547
|
-
principalAmountUsd: string;
|
|
8548
|
-
expectedAssetAmount: string;
|
|
8549
|
-
grossFeeUsd: string;
|
|
8550
|
-
feeSubsidyUsd: string;
|
|
8551
|
-
userFeeUsd: string;
|
|
8552
|
-
totalDebitAmountUsd: string;
|
|
8553
|
-
feeSubsidy: {
|
|
8554
|
-
percentage: number;
|
|
8555
|
-
percentageBps: number;
|
|
8556
|
-
maxAmountUsd: string | null;
|
|
8557
|
-
appliedAmountUsd: string;
|
|
8558
|
-
} | null;
|
|
8559
|
-
/** @constant */
|
|
8560
|
-
network: "solana";
|
|
8561
|
-
/** @constant */
|
|
8562
|
-
asset: "USDC";
|
|
8563
|
-
assetAddress: string;
|
|
8564
|
-
destinationAddress: string;
|
|
8565
|
-
};
|
|
8566
|
-
};
|
|
8567
|
-
};
|
|
8568
|
-
};
|
|
8569
|
-
/** @description Response for status 401 */
|
|
8570
|
-
401: {
|
|
8571
|
-
headers: {
|
|
8572
|
-
[name: string]: unknown;
|
|
8573
|
-
};
|
|
8574
|
-
content: {
|
|
8575
|
-
"application/json": {
|
|
8576
|
-
/**
|
|
8577
|
-
* @description A URI reference that identifies the problem type
|
|
8578
|
-
* @default about:blank
|
|
8579
|
-
* @example urn:problem-type:auth:unauthorized
|
|
8580
|
-
* @example urn:problem-type:auth:token-expired
|
|
8581
|
-
*/
|
|
8582
|
-
type: string;
|
|
8583
|
-
/**
|
|
8584
|
-
* @description A short, human-readable summary of the problem type
|
|
8585
|
-
* @example Unauthorized
|
|
8586
|
-
* @example Token Expired
|
|
8587
|
-
*/
|
|
8588
|
-
title: string;
|
|
8589
|
-
/**
|
|
8590
|
-
* @description The HTTP status code
|
|
8591
|
-
* @example 401
|
|
8592
|
-
* @example 403
|
|
8593
|
-
*/
|
|
8594
|
-
status: number;
|
|
8595
|
-
/**
|
|
8596
|
-
* @description A human-readable explanation specific to this occurrence
|
|
8597
|
-
* @example Bearer token required
|
|
8598
|
-
* @example Invalid token
|
|
8599
|
-
*/
|
|
8600
|
-
detail?: string;
|
|
8601
|
-
/** @description A URI reference that identifies the specific occurrence */
|
|
8602
|
-
instance?: string;
|
|
8603
|
-
/**
|
|
8604
|
-
* @description The authentication realm
|
|
8605
|
-
* @example API
|
|
8606
|
-
*/
|
|
8607
|
-
realm?: string;
|
|
8608
|
-
/**
|
|
8609
|
-
* @description The required scope for this resource
|
|
8610
|
-
* @example read:users
|
|
8611
|
-
* @example write:orders
|
|
8612
|
-
*/
|
|
8613
|
-
scope?: string;
|
|
8614
|
-
};
|
|
8615
|
-
};
|
|
8616
|
-
};
|
|
8617
|
-
/** @description Response for status 404 */
|
|
8618
|
-
404: {
|
|
8619
|
-
headers: {
|
|
8620
|
-
[name: string]: unknown;
|
|
8621
|
-
};
|
|
8622
|
-
content: {
|
|
8623
|
-
"application/json": {
|
|
8624
|
-
/**
|
|
8625
|
-
* @description A URI reference that identifies the problem type
|
|
8626
|
-
* @default about:blank
|
|
8627
|
-
*/
|
|
8628
|
-
type: string;
|
|
8629
|
-
/** @description A short, human-readable summary of the problem type */
|
|
8630
|
-
title: string;
|
|
8631
|
-
/**
|
|
8632
|
-
* @description The HTTP status code
|
|
8633
|
-
* @example 404
|
|
8634
|
-
*/
|
|
8635
|
-
status: number;
|
|
8636
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
8637
|
-
detail?: string;
|
|
8638
|
-
/** @description A URI reference that identifies the specific occurrence */
|
|
8639
|
-
instance?: string;
|
|
8640
|
-
/**
|
|
8641
|
-
* @description The type of resource that was not found
|
|
8642
|
-
* @example user
|
|
8643
|
-
* @example account
|
|
8644
|
-
* @example transaction
|
|
8645
|
-
*/
|
|
8646
|
-
resourceType: string;
|
|
8647
|
-
/** @description The identifier of the resource that was not found */
|
|
8648
|
-
resourceId: string;
|
|
8649
|
-
};
|
|
8650
|
-
};
|
|
8651
|
-
};
|
|
8652
|
-
/** @description Response for status 500 */
|
|
8653
|
-
500: {
|
|
8654
|
-
headers: {
|
|
8655
|
-
[name: string]: unknown;
|
|
8656
|
-
};
|
|
8657
|
-
content: {
|
|
8658
|
-
"application/json": {
|
|
8659
|
-
/**
|
|
8660
|
-
* @description A URI reference that identifies the problem type
|
|
8661
|
-
* @default about:blank
|
|
8662
|
-
* @example urn:problem-type:auth:unauthorized
|
|
8663
|
-
* @example urn:problem-type:system:internal-error
|
|
8664
|
-
*/
|
|
8665
|
-
type: string;
|
|
8666
|
-
/**
|
|
8667
|
-
* @description A short, human-readable summary of the problem type
|
|
8668
|
-
* @example Unauthorized
|
|
8669
|
-
* @example Internal Server Error
|
|
8670
|
-
*/
|
|
8671
|
-
title: string;
|
|
8672
|
-
/**
|
|
8673
|
-
* @description The HTTP status code
|
|
8674
|
-
* @example 400
|
|
8675
|
-
* @example 401
|
|
8676
|
-
* @example 404
|
|
8677
|
-
* @example 500
|
|
8678
|
-
*/
|
|
8679
|
-
status: number;
|
|
8680
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
8681
|
-
detail?: string;
|
|
8682
|
-
/**
|
|
8683
|
-
* @description A URI reference that identifies the specific occurrence
|
|
8684
|
-
* @example /errors/1234567890
|
|
8685
|
-
*/
|
|
8686
|
-
instance?: string;
|
|
8687
|
-
};
|
|
8688
|
-
};
|
|
8689
|
-
};
|
|
8690
|
-
};
|
|
8691
|
-
};
|
|
8692
|
-
postV1Deposits: {
|
|
8693
|
-
parameters: {
|
|
8694
|
-
query?: never;
|
|
8695
|
-
header?: never;
|
|
8696
|
-
path?: never;
|
|
8697
|
-
cookie?: never;
|
|
8698
|
-
};
|
|
8699
|
-
requestBody: {
|
|
8700
|
-
content: {
|
|
8701
|
-
"application/json": {
|
|
8702
|
-
/**
|
|
8703
|
-
* @description Opaque public preparation identifier returned by prepare
|
|
8704
|
-
* @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8705
|
-
*/
|
|
8706
|
-
preparationId: string;
|
|
8707
|
-
/** @description Ed25519 signature over the exact authorization message text. Base58 is preferred for Solana clients; base64 is also accepted. */
|
|
8708
|
-
signature: string;
|
|
8709
|
-
clientContext?: {
|
|
8710
|
-
clientIp?: string;
|
|
8711
|
-
userAgent?: string;
|
|
8712
|
-
sessionId?: string;
|
|
8713
|
-
deviceId?: string;
|
|
8714
|
-
platform?: string;
|
|
8715
|
-
appVersion?: string;
|
|
8716
|
-
};
|
|
8717
|
-
};
|
|
8718
|
-
"application/x-www-form-urlencoded": {
|
|
8719
|
-
/**
|
|
8720
|
-
* @description Opaque public preparation identifier returned by prepare
|
|
8721
|
-
* @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8722
|
-
*/
|
|
8723
|
-
preparationId: string;
|
|
8724
|
-
/** @description Ed25519 signature over the exact authorization message text. Base58 is preferred for Solana clients; base64 is also accepted. */
|
|
8725
|
-
signature: string;
|
|
8726
|
-
clientContext?: {
|
|
8727
|
-
clientIp?: string;
|
|
8728
|
-
userAgent?: string;
|
|
8729
|
-
sessionId?: string;
|
|
8730
|
-
deviceId?: string;
|
|
8731
|
-
platform?: string;
|
|
8732
|
-
appVersion?: string;
|
|
8733
|
-
};
|
|
8734
|
-
};
|
|
8735
|
-
"multipart/form-data": {
|
|
8736
|
-
/**
|
|
8737
|
-
* @description Opaque public preparation identifier returned by prepare
|
|
8738
|
-
* @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8739
|
-
*/
|
|
8740
|
-
preparationId: string;
|
|
8741
|
-
/** @description Ed25519 signature over the exact authorization message text. Base58 is preferred for Solana clients; base64 is also accepted. */
|
|
8742
|
-
signature: string;
|
|
8743
|
-
clientContext?: {
|
|
8744
|
-
clientIp?: string;
|
|
8745
|
-
userAgent?: string;
|
|
8746
|
-
sessionId?: string;
|
|
8747
|
-
deviceId?: string;
|
|
8748
|
-
platform?: string;
|
|
8749
|
-
appVersion?: string;
|
|
8750
|
-
};
|
|
8751
|
-
};
|
|
8752
|
-
};
|
|
8753
|
-
};
|
|
8754
|
-
responses: {
|
|
8755
|
-
/** @description An ACH debit deposit authorized by the user and processed asynchronously through debit and crypto release lifecycles. */
|
|
8756
|
-
200: {
|
|
8757
|
-
headers: {
|
|
8758
|
-
[name: string]: unknown;
|
|
8759
|
-
};
|
|
8760
|
-
content: {
|
|
8761
|
-
"application/json": {
|
|
8762
|
-
/**
|
|
8763
|
-
* @description Opaque public deposit identifier
|
|
8764
|
-
* @example dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8765
|
-
*/
|
|
8766
|
-
id: string;
|
|
8767
|
-
/**
|
|
8768
|
-
* @description Opaque public funding source identifier
|
|
8769
|
-
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8770
|
-
*/
|
|
8771
|
-
sourceId: string;
|
|
8772
|
-
/**
|
|
8773
|
-
* @description Opaque public deposit destination identifier
|
|
8774
|
-
* @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8775
|
-
*/
|
|
8776
|
-
destinationId: string;
|
|
8777
|
-
/** @enum {string} */
|
|
8778
|
-
status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
|
|
8779
|
-
/** @enum {string} */
|
|
8780
|
-
quoteType: "exact_input" | "exact_output";
|
|
8781
|
-
/** @enum {string} */
|
|
8782
|
-
priority: "normal" | "high";
|
|
8783
|
-
feeRateBps: number;
|
|
8784
|
-
principalAmountUsd: string;
|
|
8785
|
-
expectedAssetAmount: string;
|
|
8786
|
-
grossFeeUsd: string;
|
|
8787
|
-
feeSubsidyUsd: string;
|
|
8788
|
-
userFeeUsd: string;
|
|
8789
|
-
totalDebitAmountUsd: string;
|
|
8790
|
-
feeSubsidy: {
|
|
8791
|
-
percentage: number;
|
|
8792
|
-
percentageBps: number;
|
|
8793
|
-
maxAmountUsd: string | null;
|
|
8794
|
-
appliedAmountUsd: string;
|
|
8795
|
-
} | null;
|
|
8796
|
-
/**
|
|
8797
|
-
* @description Blockchain network for the bound deposit destination
|
|
8798
|
-
* @example solana
|
|
8799
|
-
* @constant
|
|
8800
|
-
*/
|
|
8801
|
-
network: "solana";
|
|
8802
|
-
/**
|
|
8803
|
-
* @description Asset sent to the deposit destination
|
|
8804
|
-
* @example USDC
|
|
8805
|
-
* @constant
|
|
8806
|
-
*/
|
|
8807
|
-
asset: "USDC";
|
|
8808
|
-
assetAddress: string;
|
|
8809
|
-
/** @description Destination wallet address for the crypto release */
|
|
8810
|
-
address: string;
|
|
8811
|
-
/** @enum {string} */
|
|
8812
|
-
debitStatus: "authorized" | "submitting" | "submitted" | "settled" | "returned" | "failed";
|
|
8813
|
-
/** @enum {string} */
|
|
8814
|
-
releaseStatus: "not_started" | "queued" | "partial" | "completed" | "failed";
|
|
8815
|
-
/** @enum {string} */
|
|
8816
|
-
releaseDecisionMode: "after_settlement" | "early_full" | "early_partial";
|
|
8817
|
-
releasedAmountUsd: string;
|
|
8818
|
-
confirmedReleasedAmountUsd: string;
|
|
8819
|
-
exposureAmountUsd: string;
|
|
8820
|
-
/** Format: date-time */
|
|
8821
|
-
authorizedAt: string;
|
|
8822
|
-
/** Format: date-time */
|
|
8823
|
-
createdAt: string;
|
|
8824
|
-
settledAt: string | null;
|
|
8825
|
-
returnedAt: string | null;
|
|
8826
|
-
completedAt: string | null;
|
|
8827
|
-
returnCode: string | null;
|
|
8828
|
-
returnReason: string | null;
|
|
8829
|
-
debitFailureCode: string | null;
|
|
8830
|
-
debitFailureReason: string | null;
|
|
8831
|
-
releaseFailureCode: string | null;
|
|
8832
|
-
releaseFailureReason: string | null;
|
|
8833
|
-
payoutTxHash: string | null;
|
|
8834
|
-
};
|
|
8835
|
-
};
|
|
8836
|
-
};
|
|
8837
|
-
/** @description Response for status 401 */
|
|
8838
|
-
401: {
|
|
8839
|
-
headers: {
|
|
8840
|
-
[name: string]: unknown;
|
|
8841
|
-
};
|
|
8842
|
-
content: {
|
|
8843
|
-
"application/json": {
|
|
8844
|
-
/**
|
|
8845
|
-
* @description A URI reference that identifies the problem type
|
|
8846
|
-
* @default about:blank
|
|
8847
|
-
* @example urn:problem-type:auth:unauthorized
|
|
8848
|
-
* @example urn:problem-type:auth:token-expired
|
|
8849
|
-
*/
|
|
8850
|
-
type: string;
|
|
8851
|
-
/**
|
|
8852
|
-
* @description A short, human-readable summary of the problem type
|
|
8853
|
-
* @example Unauthorized
|
|
8854
|
-
* @example Token Expired
|
|
8855
|
-
*/
|
|
8856
|
-
title: string;
|
|
8857
|
-
/**
|
|
8858
|
-
* @description The HTTP status code
|
|
8859
|
-
* @example 401
|
|
8860
|
-
* @example 403
|
|
8861
|
-
*/
|
|
8862
|
-
status: number;
|
|
8863
|
-
/**
|
|
8864
|
-
* @description A human-readable explanation specific to this occurrence
|
|
8865
|
-
* @example Bearer token required
|
|
8866
|
-
* @example Invalid token
|
|
8867
|
-
*/
|
|
8868
|
-
detail?: string;
|
|
8869
|
-
/** @description A URI reference that identifies the specific occurrence */
|
|
8870
|
-
instance?: string;
|
|
8871
|
-
/**
|
|
8872
|
-
* @description The authentication realm
|
|
8873
|
-
* @example API
|
|
8874
|
-
*/
|
|
8875
|
-
realm?: string;
|
|
8876
|
-
/**
|
|
8877
|
-
* @description The required scope for this resource
|
|
8878
|
-
* @example read:users
|
|
8879
|
-
* @example write:orders
|
|
8880
|
-
*/
|
|
8881
|
-
scope?: string;
|
|
8882
|
-
};
|
|
8883
|
-
};
|
|
8884
|
-
};
|
|
8885
|
-
/** @description Response for status 404 */
|
|
8886
|
-
404: {
|
|
8887
|
-
headers: {
|
|
8888
|
-
[name: string]: unknown;
|
|
8889
|
-
};
|
|
8890
|
-
content: {
|
|
8891
|
-
"application/json": {
|
|
8892
|
-
/**
|
|
8893
|
-
* @description A URI reference that identifies the problem type
|
|
8894
|
-
* @default about:blank
|
|
8895
|
-
*/
|
|
8896
|
-
type: string;
|
|
8897
|
-
/** @description A short, human-readable summary of the problem type */
|
|
8898
|
-
title: string;
|
|
8899
|
-
/**
|
|
8900
|
-
* @description The HTTP status code
|
|
8901
|
-
* @example 404
|
|
8902
|
-
*/
|
|
8903
|
-
status: number;
|
|
8904
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
8905
|
-
detail?: string;
|
|
8906
|
-
/** @description A URI reference that identifies the specific occurrence */
|
|
8907
|
-
instance?: string;
|
|
8908
|
-
/**
|
|
8909
|
-
* @description The type of resource that was not found
|
|
8910
|
-
* @example user
|
|
8911
|
-
* @example account
|
|
8912
|
-
* @example transaction
|
|
8913
|
-
*/
|
|
8914
|
-
resourceType: string;
|
|
8915
|
-
/** @description The identifier of the resource that was not found */
|
|
8916
|
-
resourceId: string;
|
|
8917
|
-
};
|
|
8918
|
-
};
|
|
8919
|
-
};
|
|
8920
|
-
/** @description Response for status 500 */
|
|
8921
|
-
500: {
|
|
8922
|
-
headers: {
|
|
8923
|
-
[name: string]: unknown;
|
|
8924
|
-
};
|
|
8925
|
-
content: {
|
|
8926
|
-
"application/json": {
|
|
8927
|
-
/**
|
|
8928
|
-
* @description A URI reference that identifies the problem type
|
|
8929
|
-
* @default about:blank
|
|
8930
|
-
* @example urn:problem-type:auth:unauthorized
|
|
8931
|
-
* @example urn:problem-type:system:internal-error
|
|
8932
|
-
*/
|
|
8933
|
-
type: string;
|
|
8934
|
-
/**
|
|
8935
|
-
* @description A short, human-readable summary of the problem type
|
|
8936
|
-
* @example Unauthorized
|
|
8937
|
-
* @example Internal Server Error
|
|
8938
|
-
*/
|
|
8939
|
-
title: string;
|
|
8940
|
-
/**
|
|
8941
|
-
* @description The HTTP status code
|
|
8942
|
-
* @example 400
|
|
8943
|
-
* @example 401
|
|
8944
|
-
* @example 404
|
|
8945
|
-
* @example 500
|
|
8946
|
-
*/
|
|
8947
|
-
status: number;
|
|
8948
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
8949
|
-
detail?: string;
|
|
8950
|
-
/**
|
|
8951
|
-
* @description A URI reference that identifies the specific occurrence
|
|
8952
|
-
* @example /errors/1234567890
|
|
8953
|
-
*/
|
|
8954
|
-
instance?: string;
|
|
8955
|
-
};
|
|
8956
|
-
};
|
|
8957
|
-
};
|
|
8958
|
-
};
|
|
8959
|
-
};
|
|
8960
|
-
postV1DepositsDirectPrepare: {
|
|
8961
|
-
parameters: {
|
|
8962
|
-
query?: never;
|
|
8963
|
-
header?: never;
|
|
8964
|
-
path?: never;
|
|
8965
|
-
cookie?: never;
|
|
8966
|
-
};
|
|
8967
|
-
requestBody: {
|
|
8968
|
-
content: {
|
|
8969
|
-
"application/json": {
|
|
8970
|
-
/**
|
|
8971
|
-
* @description Opaque public funding source identifier
|
|
8972
|
-
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
8973
|
-
*/
|
|
8974
|
-
sourceId: string;
|
|
8975
|
-
/**
|
|
8976
|
-
* @description Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source.
|
|
8977
|
-
* @example 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY
|
|
8978
|
-
*/
|
|
8979
|
-
address: string;
|
|
8980
|
-
/** @constant */
|
|
8981
|
-
network: "solana";
|
|
8982
|
-
/** @constant */
|
|
8983
|
-
asset: "USDC";
|
|
8984
|
-
/** @enum {string} */
|
|
8985
|
-
quoteType: "exact_input" | "exact_output";
|
|
8986
|
-
/**
|
|
8987
|
-
* @description Requested USD amount as a decimal string
|
|
8988
|
-
* @example 100.00
|
|
8989
|
-
*/
|
|
8990
|
-
amountUsd: string;
|
|
8991
|
-
/** @enum {string} */
|
|
8992
|
-
priority: "normal" | "high";
|
|
8993
|
-
feeSubsidy?: {
|
|
8994
|
-
percentage: number;
|
|
8995
|
-
maxAmountUsd?: string;
|
|
8996
|
-
};
|
|
8997
|
-
clientContext?: {
|
|
8998
|
-
clientIp?: string;
|
|
8999
|
-
userAgent?: string;
|
|
9000
|
-
sessionId?: string;
|
|
9001
|
-
deviceId?: string;
|
|
9002
|
-
platform?: string;
|
|
9003
|
-
appVersion?: string;
|
|
9004
|
-
};
|
|
9005
|
-
};
|
|
9006
|
-
"application/x-www-form-urlencoded": {
|
|
9007
|
-
/**
|
|
9008
|
-
* @description Opaque public funding source identifier
|
|
9009
|
-
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
9010
|
-
*/
|
|
9011
|
-
sourceId: string;
|
|
9012
|
-
/**
|
|
9013
|
-
* @description Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source.
|
|
9014
|
-
* @example 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY
|
|
9015
|
-
*/
|
|
9016
|
-
address: string;
|
|
9017
|
-
/** @constant */
|
|
9018
|
-
network: "solana";
|
|
9019
|
-
/** @constant */
|
|
9020
|
-
asset: "USDC";
|
|
9021
|
-
/** @enum {string} */
|
|
9022
|
-
quoteType: "exact_input" | "exact_output";
|
|
9023
|
-
/**
|
|
9024
|
-
* @description Requested USD amount as a decimal string
|
|
9025
|
-
* @example 100.00
|
|
9026
|
-
*/
|
|
9027
|
-
amountUsd: string;
|
|
9028
|
-
/** @enum {string} */
|
|
9029
|
-
priority: "normal" | "high";
|
|
9030
|
-
feeSubsidy?: {
|
|
9031
|
-
percentage: number;
|
|
9032
|
-
maxAmountUsd?: string;
|
|
9033
|
-
};
|
|
9034
|
-
clientContext?: {
|
|
9035
|
-
clientIp?: string;
|
|
9036
|
-
userAgent?: string;
|
|
9037
|
-
sessionId?: string;
|
|
9038
|
-
deviceId?: string;
|
|
9039
|
-
platform?: string;
|
|
9040
|
-
appVersion?: string;
|
|
9041
|
-
};
|
|
9042
|
-
};
|
|
9043
|
-
"multipart/form-data": {
|
|
9044
|
-
/**
|
|
9045
|
-
* @description Opaque public funding source identifier
|
|
9046
|
-
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
9047
|
-
*/
|
|
9048
|
-
sourceId: string;
|
|
9049
|
-
/**
|
|
9050
|
-
* @description Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source.
|
|
9051
|
-
* @example 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY
|
|
9052
|
-
*/
|
|
9053
|
-
address: string;
|
|
9054
|
-
/** @constant */
|
|
9055
|
-
network: "solana";
|
|
9056
|
-
/** @constant */
|
|
9057
|
-
asset: "USDC";
|
|
9058
|
-
/** @enum {string} */
|
|
9059
|
-
quoteType: "exact_input" | "exact_output";
|
|
9060
|
-
/**
|
|
9061
|
-
* @description Requested USD amount as a decimal string
|
|
9062
|
-
* @example 100.00
|
|
9063
|
-
*/
|
|
9064
|
-
amountUsd: string;
|
|
9065
|
-
/** @enum {string} */
|
|
9066
|
-
priority: "normal" | "high";
|
|
9067
|
-
feeSubsidy?: {
|
|
9068
|
-
percentage: number;
|
|
9069
|
-
maxAmountUsd?: string;
|
|
9070
|
-
};
|
|
9071
|
-
clientContext?: {
|
|
9072
|
-
clientIp?: string;
|
|
9073
|
-
userAgent?: string;
|
|
9074
|
-
sessionId?: string;
|
|
9075
|
-
deviceId?: string;
|
|
9076
|
-
platform?: string;
|
|
9077
|
-
appVersion?: string;
|
|
9078
|
-
};
|
|
9079
|
-
};
|
|
9080
|
-
};
|
|
9081
|
-
};
|
|
9082
|
-
responses: {
|
|
9083
|
-
/** @description Response for status 200 */
|
|
9084
|
-
200: {
|
|
9085
|
-
headers: {
|
|
9086
|
-
[name: string]: unknown;
|
|
9087
|
-
};
|
|
9088
|
-
content: {
|
|
9089
|
-
"application/json": {
|
|
9090
|
-
/**
|
|
9091
|
-
* @description Opaque public preparation identifier
|
|
9092
|
-
* @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
9093
|
-
*/
|
|
9094
|
-
preparationId: string;
|
|
9095
|
-
/** @constant */
|
|
9096
|
-
kind: "deposit_authorization";
|
|
9097
|
-
/** Format: date-time */
|
|
9098
|
-
expiresAt: string;
|
|
9099
|
-
/** @constant */
|
|
9100
|
-
messageVersion: "v1";
|
|
9101
|
-
/** @description Display-ready ACH authorization message */
|
|
9102
|
-
message: string;
|
|
9103
|
-
summary: {
|
|
9104
|
-
/** @enum {string} */
|
|
9105
|
-
quoteType: "exact_input" | "exact_output";
|
|
9106
|
-
requestedAmountUsd: string;
|
|
9107
|
-
/** @enum {string} */
|
|
9108
|
-
priority: "normal" | "high";
|
|
9109
|
-
feeRateBps: number;
|
|
9110
|
-
principalAmountUsd: string;
|
|
9111
|
-
expectedAssetAmount: string;
|
|
9112
|
-
grossFeeUsd: string;
|
|
9113
|
-
feeSubsidyUsd: string;
|
|
9114
|
-
userFeeUsd: string;
|
|
9115
|
-
totalDebitAmountUsd: string;
|
|
9116
|
-
feeSubsidy: {
|
|
9117
|
-
percentage: number;
|
|
9118
|
-
percentageBps: number;
|
|
9119
|
-
maxAmountUsd: string | null;
|
|
9120
|
-
appliedAmountUsd: string;
|
|
9121
|
-
} | null;
|
|
9122
|
-
/** @constant */
|
|
9123
|
-
network: "solana";
|
|
9124
|
-
/** @constant */
|
|
9125
|
-
asset: "USDC";
|
|
9126
|
-
assetAddress: string;
|
|
9127
|
-
destinationAddress: string;
|
|
9128
|
-
};
|
|
9129
|
-
};
|
|
9130
|
-
};
|
|
9131
|
-
};
|
|
9132
|
-
/** @description Response for status 401 */
|
|
9133
|
-
401: {
|
|
9134
|
-
headers: {
|
|
9135
|
-
[name: string]: unknown;
|
|
9136
|
-
};
|
|
9137
|
-
content: {
|
|
9138
|
-
"application/json": {
|
|
9139
|
-
/**
|
|
9140
|
-
* @description A URI reference that identifies the problem type
|
|
9141
|
-
* @default about:blank
|
|
9142
|
-
* @example urn:problem-type:auth:unauthorized
|
|
9143
|
-
* @example urn:problem-type:auth:token-expired
|
|
9144
|
-
*/
|
|
9145
|
-
type: string;
|
|
9146
|
-
/**
|
|
9147
|
-
* @description A short, human-readable summary of the problem type
|
|
9148
|
-
* @example Unauthorized
|
|
9149
|
-
* @example Token Expired
|
|
9150
|
-
*/
|
|
9151
|
-
title: string;
|
|
9152
|
-
/**
|
|
9153
|
-
* @description The HTTP status code
|
|
9154
|
-
* @example 401
|
|
9155
|
-
* @example 403
|
|
9156
|
-
*/
|
|
9157
|
-
status: number;
|
|
9158
|
-
/**
|
|
9159
|
-
* @description A human-readable explanation specific to this occurrence
|
|
9160
|
-
* @example Bearer token required
|
|
9161
|
-
* @example Invalid token
|
|
9162
|
-
*/
|
|
9163
|
-
detail?: string;
|
|
9164
|
-
/** @description A URI reference that identifies the specific occurrence */
|
|
9165
|
-
instance?: string;
|
|
9166
|
-
/**
|
|
9167
|
-
* @description The authentication realm
|
|
9168
|
-
* @example API
|
|
9169
|
-
*/
|
|
9170
|
-
realm?: string;
|
|
9171
|
-
/**
|
|
9172
|
-
* @description The required scope for this resource
|
|
9173
|
-
* @example read:users
|
|
9174
|
-
* @example write:orders
|
|
9175
|
-
*/
|
|
9176
|
-
scope?: string;
|
|
9177
|
-
};
|
|
9178
|
-
};
|
|
9179
|
-
};
|
|
9180
|
-
/** @description Response for status 404 */
|
|
9181
|
-
404: {
|
|
9182
|
-
headers: {
|
|
9183
|
-
[name: string]: unknown;
|
|
9184
|
-
};
|
|
9185
|
-
content: {
|
|
9186
|
-
"application/json": {
|
|
9187
|
-
/**
|
|
9188
|
-
* @description A URI reference that identifies the problem type
|
|
9189
|
-
* @default about:blank
|
|
9190
|
-
*/
|
|
9191
|
-
type: string;
|
|
9192
|
-
/** @description A short, human-readable summary of the problem type */
|
|
9193
|
-
title: string;
|
|
9194
|
-
/**
|
|
9195
|
-
* @description The HTTP status code
|
|
9196
|
-
* @example 404
|
|
9197
|
-
*/
|
|
9198
|
-
status: number;
|
|
9199
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
9200
|
-
detail?: string;
|
|
9201
|
-
/** @description A URI reference that identifies the specific occurrence */
|
|
9202
|
-
instance?: string;
|
|
9203
|
-
/**
|
|
9204
|
-
* @description The type of resource that was not found
|
|
9205
|
-
* @example user
|
|
9206
|
-
* @example account
|
|
9207
|
-
* @example transaction
|
|
9208
|
-
*/
|
|
9209
|
-
resourceType: string;
|
|
9210
|
-
/** @description The identifier of the resource that was not found */
|
|
9211
|
-
resourceId: string;
|
|
9212
|
-
};
|
|
9213
|
-
};
|
|
9214
|
-
};
|
|
9215
|
-
/** @description Response for status 500 */
|
|
9216
|
-
500: {
|
|
9217
|
-
headers: {
|
|
9218
|
-
[name: string]: unknown;
|
|
9219
|
-
};
|
|
9220
|
-
content: {
|
|
9221
|
-
"application/json": {
|
|
9222
|
-
/**
|
|
9223
|
-
* @description A URI reference that identifies the problem type
|
|
9224
|
-
* @default about:blank
|
|
9225
|
-
* @example urn:problem-type:auth:unauthorized
|
|
9226
|
-
* @example urn:problem-type:system:internal-error
|
|
9227
|
-
*/
|
|
9228
|
-
type: string;
|
|
9229
|
-
/**
|
|
9230
|
-
* @description A short, human-readable summary of the problem type
|
|
9231
|
-
* @example Unauthorized
|
|
9232
|
-
* @example Internal Server Error
|
|
9233
|
-
*/
|
|
9234
|
-
title: string;
|
|
9235
|
-
/**
|
|
9236
|
-
* @description The HTTP status code
|
|
9237
|
-
* @example 400
|
|
9238
|
-
* @example 401
|
|
9239
|
-
* @example 404
|
|
9240
|
-
* @example 500
|
|
9241
|
-
*/
|
|
9242
|
-
status: number;
|
|
9243
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
9244
|
-
detail?: string;
|
|
9245
|
-
/**
|
|
9246
|
-
* @description A URI reference that identifies the specific occurrence
|
|
9247
|
-
* @example /errors/1234567890
|
|
9248
|
-
*/
|
|
9249
|
-
instance?: string;
|
|
9250
|
-
};
|
|
9251
|
-
};
|
|
9252
|
-
};
|
|
9253
|
-
};
|
|
9254
|
-
};
|
|
9255
|
-
postV1DepositsDirect: {
|
|
9256
|
-
parameters: {
|
|
9257
|
-
query?: never;
|
|
9258
|
-
header?: never;
|
|
9259
|
-
path?: never;
|
|
9260
|
-
cookie?: never;
|
|
9261
|
-
};
|
|
9262
|
-
requestBody: {
|
|
9263
|
-
content: {
|
|
9264
|
-
"application/json": {
|
|
9265
|
-
/**
|
|
9266
|
-
* @description Opaque public preparation identifier returned by direct prepare
|
|
9267
|
-
* @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
9268
|
-
*/
|
|
9269
|
-
preparationId: string;
|
|
9270
|
-
clientContext?: {
|
|
9271
|
-
clientIp?: string;
|
|
9272
|
-
userAgent?: string;
|
|
9273
|
-
sessionId?: string;
|
|
9274
|
-
deviceId?: string;
|
|
9275
|
-
platform?: string;
|
|
9276
|
-
appVersion?: string;
|
|
9277
|
-
};
|
|
9278
|
-
};
|
|
9279
|
-
"application/x-www-form-urlencoded": {
|
|
9280
|
-
/**
|
|
9281
|
-
* @description Opaque public preparation identifier returned by direct prepare
|
|
9282
|
-
* @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
9283
|
-
*/
|
|
9284
|
-
preparationId: string;
|
|
9285
|
-
clientContext?: {
|
|
9286
|
-
clientIp?: string;
|
|
9287
|
-
userAgent?: string;
|
|
9288
|
-
sessionId?: string;
|
|
9289
|
-
deviceId?: string;
|
|
9290
|
-
platform?: string;
|
|
9291
|
-
appVersion?: string;
|
|
9292
|
-
};
|
|
9293
|
-
};
|
|
9294
|
-
"multipart/form-data": {
|
|
9295
|
-
/**
|
|
9296
|
-
* @description Opaque public preparation identifier returned by direct prepare
|
|
9297
|
-
* @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
9298
|
-
*/
|
|
9299
|
-
preparationId: string;
|
|
9300
|
-
clientContext?: {
|
|
9301
|
-
clientIp?: string;
|
|
9302
|
-
userAgent?: string;
|
|
9303
|
-
sessionId?: string;
|
|
9304
|
-
deviceId?: string;
|
|
9305
|
-
platform?: string;
|
|
9306
|
-
appVersion?: string;
|
|
9307
|
-
};
|
|
9308
|
-
};
|
|
9309
|
-
};
|
|
9310
|
-
};
|
|
9311
|
-
responses: {
|
|
9312
|
-
/** @description An ACH debit deposit authorized by the user and processed asynchronously through debit and crypto release lifecycles. */
|
|
9313
|
-
200: {
|
|
9314
|
-
headers: {
|
|
9315
|
-
[name: string]: unknown;
|
|
9316
|
-
};
|
|
9317
|
-
content: {
|
|
9318
|
-
"application/json": {
|
|
9319
|
-
/**
|
|
9320
|
-
* @description Opaque public deposit identifier
|
|
9321
|
-
* @example dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
9322
|
-
*/
|
|
9323
|
-
id: string;
|
|
9324
|
-
/**
|
|
9325
|
-
* @description Opaque public funding source identifier
|
|
9326
|
-
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
9327
|
-
*/
|
|
9328
|
-
sourceId: string;
|
|
9329
|
-
/**
|
|
9330
|
-
* @description Opaque public deposit destination identifier
|
|
9331
|
-
* @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
9332
|
-
*/
|
|
9333
|
-
destinationId: string;
|
|
9334
|
-
/** @enum {string} */
|
|
9335
|
-
status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
|
|
9336
|
-
/** @enum {string} */
|
|
9337
|
-
quoteType: "exact_input" | "exact_output";
|
|
9338
|
-
/** @enum {string} */
|
|
9339
|
-
priority: "normal" | "high";
|
|
9340
|
-
feeRateBps: number;
|
|
9341
|
-
principalAmountUsd: string;
|
|
9342
|
-
expectedAssetAmount: string;
|
|
9343
|
-
grossFeeUsd: string;
|
|
9344
|
-
feeSubsidyUsd: string;
|
|
9345
|
-
userFeeUsd: string;
|
|
9346
|
-
totalDebitAmountUsd: string;
|
|
9347
|
-
feeSubsidy: {
|
|
9348
|
-
percentage: number;
|
|
9349
|
-
percentageBps: number;
|
|
9350
|
-
maxAmountUsd: string | null;
|
|
9351
|
-
appliedAmountUsd: string;
|
|
9352
|
-
} | null;
|
|
9353
|
-
/**
|
|
9354
|
-
* @description Blockchain network for the bound deposit destination
|
|
9355
|
-
* @example solana
|
|
9356
|
-
* @constant
|
|
9357
|
-
*/
|
|
9358
|
-
network: "solana";
|
|
9359
|
-
/**
|
|
9360
|
-
* @description Asset sent to the deposit destination
|
|
9361
|
-
* @example USDC
|
|
9362
|
-
* @constant
|
|
9363
|
-
*/
|
|
9364
|
-
asset: "USDC";
|
|
9365
|
-
assetAddress: string;
|
|
9366
|
-
/** @description Destination wallet address for the crypto release */
|
|
9367
|
-
address: string;
|
|
9368
|
-
/** @enum {string} */
|
|
9369
|
-
debitStatus: "authorized" | "submitting" | "submitted" | "settled" | "returned" | "failed";
|
|
9370
|
-
/** @enum {string} */
|
|
9371
|
-
releaseStatus: "not_started" | "queued" | "partial" | "completed" | "failed";
|
|
9372
|
-
/** @enum {string} */
|
|
9373
|
-
releaseDecisionMode: "after_settlement" | "early_full" | "early_partial";
|
|
9374
|
-
releasedAmountUsd: string;
|
|
9375
|
-
confirmedReleasedAmountUsd: string;
|
|
9376
|
-
exposureAmountUsd: string;
|
|
9377
|
-
/** Format: date-time */
|
|
9378
|
-
authorizedAt: string;
|
|
9379
|
-
/** Format: date-time */
|
|
9380
|
-
createdAt: string;
|
|
9381
|
-
settledAt: string | null;
|
|
9382
|
-
returnedAt: string | null;
|
|
9383
|
-
completedAt: string | null;
|
|
9384
|
-
returnCode: string | null;
|
|
9385
|
-
returnReason: string | null;
|
|
9386
|
-
debitFailureCode: string | null;
|
|
9387
|
-
debitFailureReason: string | null;
|
|
9388
|
-
releaseFailureCode: string | null;
|
|
9389
|
-
releaseFailureReason: string | null;
|
|
9390
|
-
payoutTxHash: string | null;
|
|
9391
|
-
};
|
|
9392
|
-
};
|
|
9393
|
-
};
|
|
9394
|
-
/** @description Response for status 401 */
|
|
9395
|
-
401: {
|
|
9396
|
-
headers: {
|
|
9397
|
-
[name: string]: unknown;
|
|
9398
|
-
};
|
|
9399
|
-
content: {
|
|
9400
|
-
"application/json": {
|
|
9401
|
-
/**
|
|
9402
|
-
* @description A URI reference that identifies the problem type
|
|
9403
|
-
* @default about:blank
|
|
9404
|
-
* @example urn:problem-type:auth:unauthorized
|
|
9405
|
-
* @example urn:problem-type:auth:token-expired
|
|
9406
|
-
*/
|
|
9407
|
-
type: string;
|
|
9408
|
-
/**
|
|
9409
|
-
* @description A short, human-readable summary of the problem type
|
|
9410
|
-
* @example Unauthorized
|
|
9411
|
-
* @example Token Expired
|
|
9412
|
-
*/
|
|
9413
|
-
title: string;
|
|
9414
|
-
/**
|
|
9415
|
-
* @description The HTTP status code
|
|
9416
|
-
* @example 401
|
|
9417
|
-
* @example 403
|
|
9418
|
-
*/
|
|
9419
|
-
status: number;
|
|
9420
|
-
/**
|
|
9421
|
-
* @description A human-readable explanation specific to this occurrence
|
|
9422
|
-
* @example Bearer token required
|
|
9423
|
-
* @example Invalid token
|
|
9424
|
-
*/
|
|
9425
|
-
detail?: string;
|
|
9426
|
-
/** @description A URI reference that identifies the specific occurrence */
|
|
9427
|
-
instance?: string;
|
|
9428
|
-
/**
|
|
9429
|
-
* @description The authentication realm
|
|
9430
|
-
* @example API
|
|
9431
|
-
*/
|
|
9432
|
-
realm?: string;
|
|
9433
|
-
/**
|
|
9434
|
-
* @description The required scope for this resource
|
|
9435
|
-
* @example read:users
|
|
9436
|
-
* @example write:orders
|
|
9437
|
-
*/
|
|
9438
|
-
scope?: string;
|
|
9439
|
-
};
|
|
9440
|
-
};
|
|
9441
|
-
};
|
|
9442
|
-
/** @description Response for status 404 */
|
|
9443
|
-
404: {
|
|
9444
|
-
headers: {
|
|
9445
|
-
[name: string]: unknown;
|
|
9446
|
-
};
|
|
9447
|
-
content: {
|
|
9448
|
-
"application/json": {
|
|
9449
|
-
/**
|
|
9450
|
-
* @description A URI reference that identifies the problem type
|
|
9451
|
-
* @default about:blank
|
|
9452
|
-
*/
|
|
9453
|
-
type: string;
|
|
9454
|
-
/** @description A short, human-readable summary of the problem type */
|
|
9455
|
-
title: string;
|
|
9456
|
-
/**
|
|
9457
|
-
* @description The HTTP status code
|
|
9458
|
-
* @example 404
|
|
9459
|
-
*/
|
|
9460
|
-
status: number;
|
|
9461
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
9462
|
-
detail?: string;
|
|
9463
|
-
/** @description A URI reference that identifies the specific occurrence */
|
|
9464
|
-
instance?: string;
|
|
9465
|
-
/**
|
|
9466
|
-
* @description The type of resource that was not found
|
|
9467
|
-
* @example user
|
|
9468
|
-
* @example account
|
|
9469
|
-
* @example transaction
|
|
9470
|
-
*/
|
|
9471
|
-
resourceType: string;
|
|
9472
|
-
/** @description The identifier of the resource that was not found */
|
|
9473
|
-
resourceId: string;
|
|
9474
|
-
};
|
|
9475
|
-
};
|
|
9476
|
-
};
|
|
9477
|
-
/** @description Response for status 500 */
|
|
9478
|
-
500: {
|
|
9479
|
-
headers: {
|
|
9480
|
-
[name: string]: unknown;
|
|
9481
|
-
};
|
|
9482
|
-
content: {
|
|
9483
|
-
"application/json": {
|
|
9484
|
-
/**
|
|
9485
|
-
* @description A URI reference that identifies the problem type
|
|
9486
|
-
* @default about:blank
|
|
9487
|
-
* @example urn:problem-type:auth:unauthorized
|
|
9488
|
-
* @example urn:problem-type:system:internal-error
|
|
9489
|
-
*/
|
|
9490
|
-
type: string;
|
|
9491
|
-
/**
|
|
9492
|
-
* @description A short, human-readable summary of the problem type
|
|
9493
|
-
* @example Unauthorized
|
|
9494
|
-
* @example Internal Server Error
|
|
9495
|
-
*/
|
|
9496
|
-
title: string;
|
|
9497
|
-
/**
|
|
9498
|
-
* @description The HTTP status code
|
|
9499
|
-
* @example 400
|
|
9500
|
-
* @example 401
|
|
9501
|
-
* @example 404
|
|
9502
|
-
* @example 500
|
|
9503
|
-
*/
|
|
9504
|
-
status: number;
|
|
9505
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
9506
|
-
detail?: string;
|
|
9507
|
-
/**
|
|
9508
|
-
* @description A URI reference that identifies the specific occurrence
|
|
9509
|
-
* @example /errors/1234567890
|
|
9510
|
-
*/
|
|
9511
|
-
instance?: string;
|
|
9512
|
-
};
|
|
9513
|
-
};
|
|
9514
|
-
};
|
|
9515
|
-
};
|
|
9516
|
-
};
|
|
9517
|
-
"postV1Bank-accountsLink-token": {
|
|
9518
|
-
parameters: {
|
|
9519
|
-
query?: never;
|
|
9520
|
-
header?: never;
|
|
9521
|
-
path?: never;
|
|
9522
|
-
cookie?: never;
|
|
9523
|
-
};
|
|
9524
|
-
requestBody: {
|
|
9525
|
-
content: {
|
|
9526
|
-
"application/json": {
|
|
9527
|
-
/**
|
|
9528
|
-
* @description Plaid OAuth redirect target. For web, use a URL. For iOS, use a universal link. For Android, use the package name.
|
|
9529
|
-
* @example https://app.example.com/plaid/oauth-return
|
|
9530
|
-
* @example com.example.app
|
|
9531
|
-
*/
|
|
9532
|
-
redirectUri?: string;
|
|
9533
|
-
} | Record<string, never>;
|
|
9534
|
-
"application/x-www-form-urlencoded": {
|
|
9535
|
-
/**
|
|
9536
|
-
* @description Plaid OAuth redirect target. For web, use a URL. For iOS, use a universal link. For Android, use the package name.
|
|
9537
|
-
* @example https://app.example.com/plaid/oauth-return
|
|
9538
|
-
* @example com.example.app
|
|
9539
|
-
*/
|
|
9540
|
-
redirectUri?: string;
|
|
9541
|
-
} | Record<string, never>;
|
|
9542
|
-
"multipart/form-data": {
|
|
9543
|
-
/**
|
|
9544
|
-
* @description Plaid OAuth redirect target. For web, use a URL. For iOS, use a universal link. For Android, use the package name.
|
|
9545
|
-
* @example https://app.example.com/plaid/oauth-return
|
|
9546
|
-
* @example com.example.app
|
|
9547
|
-
*/
|
|
9548
|
-
redirectUri?: string;
|
|
9549
|
-
} | Record<string, never>;
|
|
9550
|
-
};
|
|
9551
|
-
};
|
|
9552
|
-
responses: {
|
|
9553
|
-
/** @description Response for status 200 */
|
|
9554
|
-
200: {
|
|
9555
|
-
headers: {
|
|
9556
|
-
[name: string]: unknown;
|
|
9557
|
-
};
|
|
9558
|
-
content: {
|
|
9559
|
-
"application/json": {
|
|
9560
|
-
/** @description Token to initialize Plaid Link SDK */
|
|
9561
|
-
linkToken: string;
|
|
9562
|
-
/** @description Plaid-hosted URL for bank linking. Open in browser or webview. Null if hosted link was not requested. */
|
|
9563
|
-
hostedLinkUrl: string | null;
|
|
9564
|
-
expiration: string;
|
|
9565
|
-
requestId: string;
|
|
9566
|
-
};
|
|
9567
|
-
};
|
|
9568
|
-
};
|
|
9569
|
-
/** @description Response for status 401 */
|
|
9570
|
-
401: {
|
|
9571
|
-
headers: {
|
|
9572
|
-
[name: string]: unknown;
|
|
9573
|
-
};
|
|
9574
|
-
content: {
|
|
9575
|
-
"application/json": {
|
|
9576
|
-
/**
|
|
9577
|
-
* @description A URI reference that identifies the problem type
|
|
9578
|
-
* @default about:blank
|
|
9579
|
-
* @example urn:problem-type:auth:unauthorized
|
|
9580
|
-
* @example urn:problem-type:auth:token-expired
|
|
9581
|
-
*/
|
|
9582
|
-
type: string;
|
|
9583
|
-
/**
|
|
9584
|
-
* @description A short, human-readable summary of the problem type
|
|
9585
|
-
* @example Unauthorized
|
|
9586
|
-
* @example Token Expired
|
|
9587
|
-
*/
|
|
9588
|
-
title: string;
|
|
9589
|
-
/**
|
|
9590
|
-
* @description The HTTP status code
|
|
9591
|
-
* @example 401
|
|
9592
|
-
* @example 403
|
|
9593
|
-
*/
|
|
9594
|
-
status: number;
|
|
9595
|
-
/**
|
|
9596
|
-
* @description A human-readable explanation specific to this occurrence
|
|
9597
|
-
* @example Bearer token required
|
|
9598
|
-
* @example Invalid token
|
|
9599
|
-
*/
|
|
9600
|
-
detail?: string;
|
|
9601
|
-
/** @description A URI reference that identifies the specific occurrence */
|
|
9602
|
-
instance?: string;
|
|
9603
|
-
/**
|
|
9604
|
-
* @description The authentication realm
|
|
9605
|
-
* @example API
|
|
9606
|
-
*/
|
|
9607
|
-
realm?: string;
|
|
9608
|
-
/**
|
|
9609
|
-
* @description The required scope for this resource
|
|
9610
|
-
* @example read:users
|
|
9611
|
-
* @example write:orders
|
|
9612
|
-
*/
|
|
9613
|
-
scope?: string;
|
|
9614
|
-
};
|
|
9615
|
-
};
|
|
9616
|
-
};
|
|
9617
|
-
/** @description Response for status 500 */
|
|
9618
|
-
500: {
|
|
9619
|
-
headers: {
|
|
9620
|
-
[name: string]: unknown;
|
|
9621
|
-
};
|
|
9622
|
-
content: {
|
|
9623
|
-
"application/json": {
|
|
9624
|
-
/**
|
|
9625
|
-
* @description A URI reference that identifies the problem type
|
|
9626
|
-
* @default about:blank
|
|
9627
|
-
* @example urn:problem-type:auth:unauthorized
|
|
9628
|
-
* @example urn:problem-type:system:internal-error
|
|
9629
|
-
*/
|
|
9630
|
-
type: string;
|
|
9631
|
-
/**
|
|
9632
|
-
* @description A short, human-readable summary of the problem type
|
|
9633
|
-
* @example Unauthorized
|
|
9634
|
-
* @example Internal Server Error
|
|
9635
|
-
*/
|
|
9636
|
-
title: string;
|
|
9637
|
-
/**
|
|
9638
|
-
* @description The HTTP status code
|
|
9639
|
-
* @example 400
|
|
9640
|
-
* @example 401
|
|
9641
|
-
* @example 404
|
|
9642
|
-
* @example 500
|
|
9643
|
-
*/
|
|
9644
|
-
status: number;
|
|
9645
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
9646
|
-
detail?: string;
|
|
9647
|
-
/**
|
|
9648
|
-
* @description A URI reference that identifies the specific occurrence
|
|
9649
|
-
* @example /errors/1234567890
|
|
9650
|
-
*/
|
|
9651
|
-
instance?: string;
|
|
9652
|
-
};
|
|
9653
|
-
};
|
|
9654
|
-
};
|
|
9655
|
-
};
|
|
9656
|
-
};
|
|
9657
|
-
"postV1Bank-accountsLink-complete": {
|
|
8363
|
+
"postV1Bank-accountsLink-complete": {
|
|
9658
8364
|
parameters: {
|
|
9659
8365
|
query?: never;
|
|
9660
8366
|
header?: never;
|
|
@@ -12952,7 +11658,7 @@ interface operations {
|
|
|
12952
11658
|
accessToken: string;
|
|
12953
11659
|
/**
|
|
12954
11660
|
* @description The internal ID of the authorized user
|
|
12955
|
-
* @example
|
|
11661
|
+
* @example 6a0d5f1bc3aa49d4f16d072b
|
|
12956
11662
|
*/
|
|
12957
11663
|
userId: string;
|
|
12958
11664
|
/**
|
|
@@ -12968,7 +11674,7 @@ interface operations {
|
|
|
12968
11674
|
/**
|
|
12969
11675
|
* Format: date-time
|
|
12970
11676
|
* @description ISO 8601 timestamp when token expires
|
|
12971
|
-
* @example 2026-05-
|
|
11677
|
+
* @example 2026-05-20T08:13:31.080Z
|
|
12972
11678
|
*/
|
|
12973
11679
|
expiresAt: string;
|
|
12974
11680
|
};
|
|
@@ -13143,7 +11849,7 @@ interface operations {
|
|
|
13143
11849
|
/**
|
|
13144
11850
|
* Format: date-time
|
|
13145
11851
|
* @description ISO 8601 timestamp of when the integrator was created
|
|
13146
|
-
* @example 2026-05-
|
|
11852
|
+
* @example 2026-05-20T07:13:31.080Z
|
|
13147
11853
|
*/
|
|
13148
11854
|
createdAt: string;
|
|
13149
11855
|
};
|
|
@@ -13314,7 +12020,7 @@ interface operations {
|
|
|
13314
12020
|
depositId: string;
|
|
13315
12021
|
/**
|
|
13316
12022
|
* @description Spritz user ID associated with the returned deposit
|
|
13317
|
-
* @example
|
|
12023
|
+
* @example 6a0d5f1bc3aa49d4f16d072a
|
|
13318
12024
|
*/
|
|
13319
12025
|
userId: string;
|
|
13320
12026
|
/**
|
|
@@ -13502,7 +12208,7 @@ interface operations {
|
|
|
13502
12208
|
depositId: string;
|
|
13503
12209
|
/**
|
|
13504
12210
|
* @description Spritz user ID associated with the returned deposit
|
|
13505
|
-
* @example
|
|
12211
|
+
* @example 6a0d5f1bc3aa49d4f16d072a
|
|
13506
12212
|
*/
|
|
13507
12213
|
userId: string;
|
|
13508
12214
|
/**
|
|
@@ -13671,7 +12377,7 @@ interface operations {
|
|
|
13671
12377
|
"application/json": {
|
|
13672
12378
|
/**
|
|
13673
12379
|
* @description Unique identifier for the webhook
|
|
13674
|
-
* @example
|
|
12380
|
+
* @example 6a0d5f1bc3aa49d4f16d072c
|
|
13675
12381
|
*/
|
|
13676
12382
|
id: string;
|
|
13677
12383
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -13878,7 +12584,7 @@ interface operations {
|
|
|
13878
12584
|
"application/json": {
|
|
13879
12585
|
/**
|
|
13880
12586
|
* @description Unique identifier for the webhook
|
|
13881
|
-
* @example
|
|
12587
|
+
* @example 6a0d5f1bc3aa49d4f16d072c
|
|
13882
12588
|
*/
|
|
13883
12589
|
id: string;
|
|
13884
12590
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -14214,7 +12920,7 @@ interface operations {
|
|
|
14214
12920
|
"application/json": {
|
|
14215
12921
|
/**
|
|
14216
12922
|
* @description Unique identifier for the webhook
|
|
14217
|
-
* @example
|
|
12923
|
+
* @example 6a0d5f1bc3aa49d4f16d072c
|
|
14218
12924
|
*/
|
|
14219
12925
|
id: string;
|
|
14220
12926
|
/** @description List of event types this webhook is subscribed to */
|
|
@@ -14589,7 +13295,7 @@ interface operations {
|
|
|
14589
13295
|
/**
|
|
14590
13296
|
* Format: date-time
|
|
14591
13297
|
* @description ISO 8601 timestamp when the old secret will expire. Only present if a grace period was specified.
|
|
14592
|
-
* @example 2026-05-
|
|
13298
|
+
* @example 2026-05-20T07:18:31.080Z
|
|
14593
13299
|
*/
|
|
14594
13300
|
oldSecretExpiresAt?: string;
|
|
14595
13301
|
};
|
|
@@ -14736,7 +13442,7 @@ interface operations {
|
|
|
14736
13442
|
"application/json": {
|
|
14737
13443
|
/**
|
|
14738
13444
|
* @description Unique identifier for the user
|
|
14739
|
-
* @example
|
|
13445
|
+
* @example 6a0d5f1bc3aa49d4f16d0728
|
|
14740
13446
|
*/
|
|
14741
13447
|
id: string;
|
|
14742
13448
|
email: (string | null) | null;
|
|
@@ -14744,7 +13450,7 @@ interface operations {
|
|
|
14744
13450
|
/**
|
|
14745
13451
|
* Format: date-time
|
|
14746
13452
|
* @description ISO 8601 timestamp of when the user was created
|
|
14747
|
-
* @example 2026-05-
|
|
13453
|
+
* @example 2026-05-20T07:13:31.075Z
|
|
14748
13454
|
*/
|
|
14749
13455
|
signedUpAt: string;
|
|
14750
13456
|
timezone: (string | null) | null;
|
|
@@ -15074,7 +13780,7 @@ interface operations {
|
|
|
15074
13780
|
"application/json": {
|
|
15075
13781
|
/**
|
|
15076
13782
|
* @description Unique identifier for the user
|
|
15077
|
-
* @example
|
|
13783
|
+
* @example 6a0d5f1bc3aa49d4f16d0728
|
|
15078
13784
|
*/
|
|
15079
13785
|
id: string;
|
|
15080
13786
|
email: (string | null) | null;
|
|
@@ -15082,7 +13788,7 @@ interface operations {
|
|
|
15082
13788
|
/**
|
|
15083
13789
|
* Format: date-time
|
|
15084
13790
|
* @description ISO 8601 timestamp of when the user was created
|
|
15085
|
-
* @example 2026-05-
|
|
13791
|
+
* @example 2026-05-20T07:13:31.075Z
|
|
15086
13792
|
*/
|
|
15087
13793
|
signedUpAt: string;
|
|
15088
13794
|
timezone: (string | null) | null;
|
|
@@ -15484,7 +14190,7 @@ interface operations {
|
|
|
15484
14190
|
"application/json": {
|
|
15485
14191
|
/**
|
|
15486
14192
|
* @description Unique identifier for the user
|
|
15487
|
-
* @example
|
|
14193
|
+
* @example 6a0d5f1bc3aa49d4f16d0728
|
|
15488
14194
|
*/
|
|
15489
14195
|
id: string;
|
|
15490
14196
|
email: (string | null) | null;
|
|
@@ -15492,7 +14198,7 @@ interface operations {
|
|
|
15492
14198
|
/**
|
|
15493
14199
|
* Format: date-time
|
|
15494
14200
|
* @description ISO 8601 timestamp of when the user was created
|
|
15495
|
-
* @example 2026-05-
|
|
14201
|
+
* @example 2026-05-20T07:13:31.075Z
|
|
15496
14202
|
*/
|
|
15497
14203
|
signedUpAt: string;
|
|
15498
14204
|
timezone: (string | null) | null;
|
|
@@ -22010,210 +20716,36 @@ interface operations {
|
|
|
22010
20716
|
[name: string]: unknown;
|
|
22011
20717
|
};
|
|
22012
20718
|
content: {
|
|
22013
|
-
"application/json": {
|
|
22014
|
-
/**
|
|
22015
|
-
* @description A URI reference that identifies the problem type
|
|
22016
|
-
* @default about:blank
|
|
22017
|
-
* @example urn:problem-type:auth:unauthorized
|
|
22018
|
-
* @example urn:problem-type:system:internal-error
|
|
22019
|
-
*/
|
|
22020
|
-
type: string;
|
|
22021
|
-
/**
|
|
22022
|
-
* @description A short, human-readable summary of the problem type
|
|
22023
|
-
* @example Unauthorized
|
|
22024
|
-
* @example Internal Server Error
|
|
22025
|
-
*/
|
|
22026
|
-
title: string;
|
|
22027
|
-
/**
|
|
22028
|
-
* @description The HTTP status code
|
|
22029
|
-
* @example 400
|
|
22030
|
-
* @example 401
|
|
22031
|
-
* @example 404
|
|
22032
|
-
* @example 500
|
|
22033
|
-
*/
|
|
22034
|
-
status: number;
|
|
22035
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
22036
|
-
detail?: string;
|
|
22037
|
-
/**
|
|
22038
|
-
* @description A URI reference that identifies the specific occurrence
|
|
22039
|
-
* @example /errors/1234567890
|
|
22040
|
-
*/
|
|
22041
|
-
instance?: string;
|
|
22042
|
-
};
|
|
22043
|
-
};
|
|
22044
|
-
};
|
|
22045
|
-
/** @description Response for status 401 */
|
|
22046
|
-
401: {
|
|
22047
|
-
headers: {
|
|
22048
|
-
[name: string]: unknown;
|
|
22049
|
-
};
|
|
22050
|
-
content: {
|
|
22051
|
-
"application/json": {
|
|
22052
|
-
/**
|
|
22053
|
-
* @description A URI reference that identifies the problem type
|
|
22054
|
-
* @default about:blank
|
|
22055
|
-
* @example urn:problem-type:auth:unauthorized
|
|
22056
|
-
* @example urn:problem-type:auth:token-expired
|
|
22057
|
-
*/
|
|
22058
|
-
type: string;
|
|
22059
|
-
/**
|
|
22060
|
-
* @description A short, human-readable summary of the problem type
|
|
22061
|
-
* @example Unauthorized
|
|
22062
|
-
* @example Token Expired
|
|
22063
|
-
*/
|
|
22064
|
-
title: string;
|
|
22065
|
-
/**
|
|
22066
|
-
* @description The HTTP status code
|
|
22067
|
-
* @example 401
|
|
22068
|
-
* @example 403
|
|
22069
|
-
*/
|
|
22070
|
-
status: number;
|
|
22071
|
-
/**
|
|
22072
|
-
* @description A human-readable explanation specific to this occurrence
|
|
22073
|
-
* @example Bearer token required
|
|
22074
|
-
* @example Invalid token
|
|
22075
|
-
*/
|
|
22076
|
-
detail?: string;
|
|
22077
|
-
/** @description A URI reference that identifies the specific occurrence */
|
|
22078
|
-
instance?: string;
|
|
22079
|
-
/**
|
|
22080
|
-
* @description The authentication realm
|
|
22081
|
-
* @example API
|
|
22082
|
-
*/
|
|
22083
|
-
realm?: string;
|
|
22084
|
-
/**
|
|
22085
|
-
* @description The required scope for this resource
|
|
22086
|
-
* @example read:users
|
|
22087
|
-
* @example write:orders
|
|
22088
|
-
*/
|
|
22089
|
-
scope?: string;
|
|
22090
|
-
};
|
|
22091
|
-
};
|
|
22092
|
-
};
|
|
22093
|
-
/** @description Response for status 500 */
|
|
22094
|
-
500: {
|
|
22095
|
-
headers: {
|
|
22096
|
-
[name: string]: unknown;
|
|
22097
|
-
};
|
|
22098
|
-
content: {
|
|
22099
|
-
"application/json": {
|
|
22100
|
-
/**
|
|
22101
|
-
* @description A URI reference that identifies the problem type
|
|
22102
|
-
* @default about:blank
|
|
22103
|
-
* @example urn:problem-type:auth:unauthorized
|
|
22104
|
-
* @example urn:problem-type:system:internal-error
|
|
22105
|
-
*/
|
|
22106
|
-
type: string;
|
|
22107
|
-
/**
|
|
22108
|
-
* @description A short, human-readable summary of the problem type
|
|
22109
|
-
* @example Unauthorized
|
|
22110
|
-
* @example Internal Server Error
|
|
22111
|
-
*/
|
|
22112
|
-
title: string;
|
|
22113
|
-
/**
|
|
22114
|
-
* @description The HTTP status code
|
|
22115
|
-
* @example 400
|
|
22116
|
-
* @example 401
|
|
22117
|
-
* @example 404
|
|
22118
|
-
* @example 500
|
|
22119
|
-
*/
|
|
22120
|
-
status: number;
|
|
22121
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
22122
|
-
detail?: string;
|
|
22123
|
-
/**
|
|
22124
|
-
* @description A URI reference that identifies the specific occurrence
|
|
22125
|
-
* @example /errors/1234567890
|
|
22126
|
-
*/
|
|
22127
|
-
instance?: string;
|
|
22128
|
-
};
|
|
22129
|
-
};
|
|
22130
|
-
};
|
|
22131
|
-
/** @description Response for status 502 */
|
|
22132
|
-
502: {
|
|
22133
|
-
headers: {
|
|
22134
|
-
[name: string]: unknown;
|
|
22135
|
-
};
|
|
22136
|
-
content: {
|
|
22137
|
-
"application/json": {
|
|
22138
|
-
/**
|
|
22139
|
-
* @description A URI reference that identifies the problem type
|
|
22140
|
-
* @default about:blank
|
|
22141
|
-
* @example urn:problem-type:auth:unauthorized
|
|
22142
|
-
* @example urn:problem-type:system:internal-error
|
|
22143
|
-
*/
|
|
22144
|
-
type: string;
|
|
22145
|
-
/**
|
|
22146
|
-
* @description A short, human-readable summary of the problem type
|
|
22147
|
-
* @example Unauthorized
|
|
22148
|
-
* @example Internal Server Error
|
|
22149
|
-
*/
|
|
22150
|
-
title: string;
|
|
22151
|
-
/**
|
|
22152
|
-
* @description The HTTP status code
|
|
22153
|
-
* @example 400
|
|
22154
|
-
* @example 401
|
|
22155
|
-
* @example 404
|
|
22156
|
-
* @example 500
|
|
22157
|
-
*/
|
|
22158
|
-
status: number;
|
|
22159
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
22160
|
-
detail?: string;
|
|
22161
|
-
/**
|
|
22162
|
-
* @description A URI reference that identifies the specific occurrence
|
|
22163
|
-
* @example /errors/1234567890
|
|
22164
|
-
*/
|
|
22165
|
-
instance?: string;
|
|
22166
|
-
};
|
|
22167
|
-
};
|
|
22168
|
-
};
|
|
22169
|
-
};
|
|
22170
|
-
};
|
|
22171
|
-
"postV1SandboxBypass-kyc": {
|
|
22172
|
-
parameters: {
|
|
22173
|
-
query?: never;
|
|
22174
|
-
header?: never;
|
|
22175
|
-
path?: never;
|
|
22176
|
-
cookie?: never;
|
|
22177
|
-
};
|
|
22178
|
-
requestBody: {
|
|
22179
|
-
content: {
|
|
22180
|
-
"application/json": {
|
|
22181
|
-
/**
|
|
22182
|
-
* @description Country code to simulate successful KYC for
|
|
22183
|
-
* @example US
|
|
22184
|
-
*/
|
|
22185
|
-
country?: string;
|
|
22186
|
-
/** @description Set to true to simulate a failed KYC check */
|
|
22187
|
-
failed?: boolean;
|
|
22188
|
-
};
|
|
22189
|
-
"application/x-www-form-urlencoded": {
|
|
22190
|
-
/**
|
|
22191
|
-
* @description Country code to simulate successful KYC for
|
|
22192
|
-
* @example US
|
|
22193
|
-
*/
|
|
22194
|
-
country?: string;
|
|
22195
|
-
/** @description Set to true to simulate a failed KYC check */
|
|
22196
|
-
failed?: boolean;
|
|
22197
|
-
};
|
|
22198
|
-
"multipart/form-data": {
|
|
22199
|
-
/**
|
|
22200
|
-
* @description Country code to simulate successful KYC for
|
|
22201
|
-
* @example US
|
|
22202
|
-
*/
|
|
22203
|
-
country?: string;
|
|
22204
|
-
/** @description Set to true to simulate a failed KYC check */
|
|
22205
|
-
failed?: boolean;
|
|
22206
|
-
};
|
|
22207
|
-
};
|
|
22208
|
-
};
|
|
22209
|
-
responses: {
|
|
22210
|
-
/** @description The resulting verification document */
|
|
22211
|
-
200: {
|
|
22212
|
-
headers: {
|
|
22213
|
-
[name: string]: unknown;
|
|
22214
|
-
};
|
|
22215
|
-
content: {
|
|
22216
|
-
"application/json": unknown;
|
|
20719
|
+
"application/json": {
|
|
20720
|
+
/**
|
|
20721
|
+
* @description A URI reference that identifies the problem type
|
|
20722
|
+
* @default about:blank
|
|
20723
|
+
* @example urn:problem-type:auth:unauthorized
|
|
20724
|
+
* @example urn:problem-type:system:internal-error
|
|
20725
|
+
*/
|
|
20726
|
+
type: string;
|
|
20727
|
+
/**
|
|
20728
|
+
* @description A short, human-readable summary of the problem type
|
|
20729
|
+
* @example Unauthorized
|
|
20730
|
+
* @example Internal Server Error
|
|
20731
|
+
*/
|
|
20732
|
+
title: string;
|
|
20733
|
+
/**
|
|
20734
|
+
* @description The HTTP status code
|
|
20735
|
+
* @example 400
|
|
20736
|
+
* @example 401
|
|
20737
|
+
* @example 404
|
|
20738
|
+
* @example 500
|
|
20739
|
+
*/
|
|
20740
|
+
status: number;
|
|
20741
|
+
/** @description A human-readable explanation specific to this occurrence */
|
|
20742
|
+
detail?: string;
|
|
20743
|
+
/**
|
|
20744
|
+
* @description A URI reference that identifies the specific occurrence
|
|
20745
|
+
* @example /errors/1234567890
|
|
20746
|
+
*/
|
|
20747
|
+
instance?: string;
|
|
20748
|
+
};
|
|
22217
20749
|
};
|
|
22218
20750
|
};
|
|
22219
20751
|
/** @description Response for status 401 */
|
|
@@ -22302,9 +20834,47 @@ interface operations {
|
|
|
22302
20834
|
};
|
|
22303
20835
|
};
|
|
22304
20836
|
};
|
|
20837
|
+
/** @description Response for status 502 */
|
|
20838
|
+
502: {
|
|
20839
|
+
headers: {
|
|
20840
|
+
[name: string]: unknown;
|
|
20841
|
+
};
|
|
20842
|
+
content: {
|
|
20843
|
+
"application/json": {
|
|
20844
|
+
/**
|
|
20845
|
+
* @description A URI reference that identifies the problem type
|
|
20846
|
+
* @default about:blank
|
|
20847
|
+
* @example urn:problem-type:auth:unauthorized
|
|
20848
|
+
* @example urn:problem-type:system:internal-error
|
|
20849
|
+
*/
|
|
20850
|
+
type: string;
|
|
20851
|
+
/**
|
|
20852
|
+
* @description A short, human-readable summary of the problem type
|
|
20853
|
+
* @example Unauthorized
|
|
20854
|
+
* @example Internal Server Error
|
|
20855
|
+
*/
|
|
20856
|
+
title: string;
|
|
20857
|
+
/**
|
|
20858
|
+
* @description The HTTP status code
|
|
20859
|
+
* @example 400
|
|
20860
|
+
* @example 401
|
|
20861
|
+
* @example 404
|
|
20862
|
+
* @example 500
|
|
20863
|
+
*/
|
|
20864
|
+
status: number;
|
|
20865
|
+
/** @description A human-readable explanation specific to this occurrence */
|
|
20866
|
+
detail?: string;
|
|
20867
|
+
/**
|
|
20868
|
+
* @description A URI reference that identifies the specific occurrence
|
|
20869
|
+
* @example /errors/1234567890
|
|
20870
|
+
*/
|
|
20871
|
+
instance?: string;
|
|
20872
|
+
};
|
|
20873
|
+
};
|
|
20874
|
+
};
|
|
22305
20875
|
};
|
|
22306
20876
|
};
|
|
22307
|
-
|
|
20877
|
+
"postV1SandboxBypass-kyc": {
|
|
22308
20878
|
parameters: {
|
|
22309
20879
|
query?: never;
|
|
22310
20880
|
header?: never;
|
|
@@ -22315,211 +20885,45 @@ interface operations {
|
|
|
22315
20885
|
content: {
|
|
22316
20886
|
"application/json": {
|
|
22317
20887
|
/**
|
|
22318
|
-
* @description
|
|
22319
|
-
* @example
|
|
20888
|
+
* @description Country code to simulate successful KYC for
|
|
20889
|
+
* @example US
|
|
22320
20890
|
*/
|
|
22321
|
-
|
|
22322
|
-
/** @description
|
|
22323
|
-
|
|
22324
|
-
clientContext?: {
|
|
22325
|
-
clientIp?: string;
|
|
22326
|
-
userAgent?: string;
|
|
22327
|
-
sessionId?: string;
|
|
22328
|
-
deviceId?: string;
|
|
22329
|
-
platform?: string;
|
|
22330
|
-
appVersion?: string;
|
|
22331
|
-
};
|
|
22332
|
-
returnSimulation: {
|
|
22333
|
-
/**
|
|
22334
|
-
* @description Sandbox-only ACH return code to simulate through the Modern Treasury provider path
|
|
22335
|
-
* @example R10
|
|
22336
|
-
*/
|
|
22337
|
-
code: string;
|
|
22338
|
-
};
|
|
20891
|
+
country?: string;
|
|
20892
|
+
/** @description Set to true to simulate a failed KYC check */
|
|
20893
|
+
failed?: boolean;
|
|
22339
20894
|
};
|
|
22340
20895
|
"application/x-www-form-urlencoded": {
|
|
22341
20896
|
/**
|
|
22342
|
-
* @description
|
|
22343
|
-
* @example
|
|
20897
|
+
* @description Country code to simulate successful KYC for
|
|
20898
|
+
* @example US
|
|
22344
20899
|
*/
|
|
22345
|
-
|
|
22346
|
-
/** @description
|
|
22347
|
-
|
|
22348
|
-
clientContext?: {
|
|
22349
|
-
clientIp?: string;
|
|
22350
|
-
userAgent?: string;
|
|
22351
|
-
sessionId?: string;
|
|
22352
|
-
deviceId?: string;
|
|
22353
|
-
platform?: string;
|
|
22354
|
-
appVersion?: string;
|
|
22355
|
-
};
|
|
22356
|
-
returnSimulation: {
|
|
22357
|
-
/**
|
|
22358
|
-
* @description Sandbox-only ACH return code to simulate through the Modern Treasury provider path
|
|
22359
|
-
* @example R10
|
|
22360
|
-
*/
|
|
22361
|
-
code: string;
|
|
22362
|
-
};
|
|
20900
|
+
country?: string;
|
|
20901
|
+
/** @description Set to true to simulate a failed KYC check */
|
|
20902
|
+
failed?: boolean;
|
|
22363
20903
|
};
|
|
22364
20904
|
"multipart/form-data": {
|
|
22365
20905
|
/**
|
|
22366
|
-
* @description
|
|
22367
|
-
* @example
|
|
20906
|
+
* @description Country code to simulate successful KYC for
|
|
20907
|
+
* @example US
|
|
22368
20908
|
*/
|
|
22369
|
-
|
|
22370
|
-
/** @description
|
|
22371
|
-
|
|
22372
|
-
clientContext?: {
|
|
22373
|
-
clientIp?: string;
|
|
22374
|
-
userAgent?: string;
|
|
22375
|
-
sessionId?: string;
|
|
22376
|
-
deviceId?: string;
|
|
22377
|
-
platform?: string;
|
|
22378
|
-
appVersion?: string;
|
|
22379
|
-
};
|
|
22380
|
-
returnSimulation: {
|
|
22381
|
-
/**
|
|
22382
|
-
* @description Sandbox-only ACH return code to simulate through the Modern Treasury provider path
|
|
22383
|
-
* @example R10
|
|
22384
|
-
*/
|
|
22385
|
-
code: string;
|
|
22386
|
-
};
|
|
20909
|
+
country?: string;
|
|
20910
|
+
/** @description Set to true to simulate a failed KYC check */
|
|
20911
|
+
failed?: boolean;
|
|
22387
20912
|
};
|
|
22388
20913
|
};
|
|
22389
20914
|
};
|
|
22390
20915
|
responses: {
|
|
22391
|
-
/** @description
|
|
20916
|
+
/** @description The resulting verification document */
|
|
22392
20917
|
200: {
|
|
22393
20918
|
headers: {
|
|
22394
20919
|
[name: string]: unknown;
|
|
22395
20920
|
};
|
|
22396
20921
|
content: {
|
|
22397
|
-
"application/json":
|
|
22398
|
-
/**
|
|
22399
|
-
* @description Opaque public deposit identifier
|
|
22400
|
-
* @example dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
22401
|
-
*/
|
|
22402
|
-
id: string;
|
|
22403
|
-
/**
|
|
22404
|
-
* @description Opaque public funding source identifier
|
|
22405
|
-
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
22406
|
-
*/
|
|
22407
|
-
sourceId: string;
|
|
22408
|
-
/**
|
|
22409
|
-
* @description Opaque public deposit destination identifier
|
|
22410
|
-
* @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
22411
|
-
*/
|
|
22412
|
-
destinationId: string;
|
|
22413
|
-
/** @enum {string} */
|
|
22414
|
-
status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
|
|
22415
|
-
/** @enum {string} */
|
|
22416
|
-
quoteType: "exact_input" | "exact_output";
|
|
22417
|
-
/** @enum {string} */
|
|
22418
|
-
priority: "normal" | "high";
|
|
22419
|
-
feeRateBps: number;
|
|
22420
|
-
principalAmountUsd: string;
|
|
22421
|
-
expectedAssetAmount: string;
|
|
22422
|
-
grossFeeUsd: string;
|
|
22423
|
-
feeSubsidyUsd: string;
|
|
22424
|
-
userFeeUsd: string;
|
|
22425
|
-
totalDebitAmountUsd: string;
|
|
22426
|
-
feeSubsidy: {
|
|
22427
|
-
percentage: number;
|
|
22428
|
-
percentageBps: number;
|
|
22429
|
-
maxAmountUsd: string | null;
|
|
22430
|
-
appliedAmountUsd: string;
|
|
22431
|
-
} | null;
|
|
22432
|
-
/**
|
|
22433
|
-
* @description Blockchain network for the bound deposit destination
|
|
22434
|
-
* @example solana
|
|
22435
|
-
* @constant
|
|
22436
|
-
*/
|
|
22437
|
-
network: "solana";
|
|
22438
|
-
/**
|
|
22439
|
-
* @description Asset sent to the deposit destination
|
|
22440
|
-
* @example USDC
|
|
22441
|
-
* @constant
|
|
22442
|
-
*/
|
|
22443
|
-
asset: "USDC";
|
|
22444
|
-
assetAddress: string;
|
|
22445
|
-
/** @description Destination wallet address for the crypto release */
|
|
22446
|
-
address: string;
|
|
22447
|
-
/** @enum {string} */
|
|
22448
|
-
debitStatus: "authorized" | "submitting" | "submitted" | "settled" | "returned" | "failed";
|
|
22449
|
-
/** @enum {string} */
|
|
22450
|
-
releaseStatus: "not_started" | "queued" | "partial" | "completed" | "failed";
|
|
22451
|
-
/** @enum {string} */
|
|
22452
|
-
releaseDecisionMode: "after_settlement" | "early_full" | "early_partial";
|
|
22453
|
-
releasedAmountUsd: string;
|
|
22454
|
-
confirmedReleasedAmountUsd: string;
|
|
22455
|
-
exposureAmountUsd: string;
|
|
22456
|
-
/** Format: date-time */
|
|
22457
|
-
authorizedAt: string;
|
|
22458
|
-
/** Format: date-time */
|
|
22459
|
-
createdAt: string;
|
|
22460
|
-
settledAt: string | null;
|
|
22461
|
-
returnedAt: string | null;
|
|
22462
|
-
completedAt: string | null;
|
|
22463
|
-
returnCode: string | null;
|
|
22464
|
-
returnReason: string | null;
|
|
22465
|
-
debitFailureCode: string | null;
|
|
22466
|
-
debitFailureReason: string | null;
|
|
22467
|
-
releaseFailureCode: string | null;
|
|
22468
|
-
releaseFailureReason: string | null;
|
|
22469
|
-
payoutTxHash: string | null;
|
|
22470
|
-
};
|
|
20922
|
+
"application/json": unknown;
|
|
22471
20923
|
};
|
|
22472
20924
|
};
|
|
22473
20925
|
/** @description Response for status 401 */
|
|
22474
|
-
401: {
|
|
22475
|
-
headers: {
|
|
22476
|
-
[name: string]: unknown;
|
|
22477
|
-
};
|
|
22478
|
-
content: {
|
|
22479
|
-
"application/json": {
|
|
22480
|
-
/**
|
|
22481
|
-
* @description A URI reference that identifies the problem type
|
|
22482
|
-
* @default about:blank
|
|
22483
|
-
* @example urn:problem-type:auth:unauthorized
|
|
22484
|
-
* @example urn:problem-type:auth:token-expired
|
|
22485
|
-
*/
|
|
22486
|
-
type: string;
|
|
22487
|
-
/**
|
|
22488
|
-
* @description A short, human-readable summary of the problem type
|
|
22489
|
-
* @example Unauthorized
|
|
22490
|
-
* @example Token Expired
|
|
22491
|
-
*/
|
|
22492
|
-
title: string;
|
|
22493
|
-
/**
|
|
22494
|
-
* @description The HTTP status code
|
|
22495
|
-
* @example 401
|
|
22496
|
-
* @example 403
|
|
22497
|
-
*/
|
|
22498
|
-
status: number;
|
|
22499
|
-
/**
|
|
22500
|
-
* @description A human-readable explanation specific to this occurrence
|
|
22501
|
-
* @example Bearer token required
|
|
22502
|
-
* @example Invalid token
|
|
22503
|
-
*/
|
|
22504
|
-
detail?: string;
|
|
22505
|
-
/** @description A URI reference that identifies the specific occurrence */
|
|
22506
|
-
instance?: string;
|
|
22507
|
-
/**
|
|
22508
|
-
* @description The authentication realm
|
|
22509
|
-
* @example API
|
|
22510
|
-
*/
|
|
22511
|
-
realm?: string;
|
|
22512
|
-
/**
|
|
22513
|
-
* @description The required scope for this resource
|
|
22514
|
-
* @example read:users
|
|
22515
|
-
* @example write:orders
|
|
22516
|
-
*/
|
|
22517
|
-
scope?: string;
|
|
22518
|
-
};
|
|
22519
|
-
};
|
|
22520
|
-
};
|
|
22521
|
-
/** @description Response for status 403 */
|
|
22522
|
-
403: {
|
|
20926
|
+
401: {
|
|
22523
20927
|
headers: {
|
|
22524
20928
|
[name: string]: unknown;
|
|
22525
20929
|
};
|
|
@@ -22529,65 +20933,40 @@ interface operations {
|
|
|
22529
20933
|
* @description A URI reference that identifies the problem type
|
|
22530
20934
|
* @default about:blank
|
|
22531
20935
|
* @example urn:problem-type:auth:unauthorized
|
|
22532
|
-
* @example urn:problem-type:
|
|
20936
|
+
* @example urn:problem-type:auth:token-expired
|
|
22533
20937
|
*/
|
|
22534
20938
|
type: string;
|
|
22535
20939
|
/**
|
|
22536
20940
|
* @description A short, human-readable summary of the problem type
|
|
22537
20941
|
* @example Unauthorized
|
|
22538
|
-
* @example
|
|
20942
|
+
* @example Token Expired
|
|
22539
20943
|
*/
|
|
22540
20944
|
title: string;
|
|
22541
20945
|
/**
|
|
22542
20946
|
* @description The HTTP status code
|
|
22543
|
-
* @example 400
|
|
22544
20947
|
* @example 401
|
|
22545
|
-
* @example
|
|
22546
|
-
* @example 500
|
|
20948
|
+
* @example 403
|
|
22547
20949
|
*/
|
|
22548
20950
|
status: number;
|
|
22549
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
22550
|
-
detail?: string;
|
|
22551
|
-
/**
|
|
22552
|
-
* @description A URI reference that identifies the specific occurrence
|
|
22553
|
-
* @example /errors/1234567890
|
|
22554
|
-
*/
|
|
22555
|
-
instance?: string;
|
|
22556
|
-
};
|
|
22557
|
-
};
|
|
22558
|
-
};
|
|
22559
|
-
/** @description Response for status 404 */
|
|
22560
|
-
404: {
|
|
22561
|
-
headers: {
|
|
22562
|
-
[name: string]: unknown;
|
|
22563
|
-
};
|
|
22564
|
-
content: {
|
|
22565
|
-
"application/json": {
|
|
22566
|
-
/**
|
|
22567
|
-
* @description A URI reference that identifies the problem type
|
|
22568
|
-
* @default about:blank
|
|
22569
|
-
*/
|
|
22570
|
-
type: string;
|
|
22571
|
-
/** @description A short, human-readable summary of the problem type */
|
|
22572
|
-
title: string;
|
|
22573
20951
|
/**
|
|
22574
|
-
* @description
|
|
22575
|
-
* @example
|
|
20952
|
+
* @description A human-readable explanation specific to this occurrence
|
|
20953
|
+
* @example Bearer token required
|
|
20954
|
+
* @example Invalid token
|
|
22576
20955
|
*/
|
|
22577
|
-
status: number;
|
|
22578
|
-
/** @description A human-readable explanation specific to this occurrence */
|
|
22579
20956
|
detail?: string;
|
|
22580
20957
|
/** @description A URI reference that identifies the specific occurrence */
|
|
22581
20958
|
instance?: string;
|
|
22582
20959
|
/**
|
|
22583
|
-
* @description The
|
|
22584
|
-
* @example
|
|
22585
|
-
* @example account
|
|
22586
|
-
* @example transaction
|
|
20960
|
+
* @description The authentication realm
|
|
20961
|
+
* @example API
|
|
22587
20962
|
*/
|
|
22588
|
-
|
|
22589
|
-
/**
|
|
22590
|
-
|
|
20963
|
+
realm?: string;
|
|
20964
|
+
/**
|
|
20965
|
+
* @description The required scope for this resource
|
|
20966
|
+
* @example read:users
|
|
20967
|
+
* @example write:orders
|
|
20968
|
+
*/
|
|
20969
|
+
scope?: string;
|
|
22591
20970
|
};
|
|
22592
20971
|
};
|
|
22593
20972
|
};
|
|
@@ -22726,11 +21105,6 @@ interface operations {
|
|
|
22726
21105
|
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
22727
21106
|
*/
|
|
22728
21107
|
sourceId: string;
|
|
22729
|
-
/**
|
|
22730
|
-
* @description Opaque public deposit destination identifier
|
|
22731
|
-
* @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
22732
|
-
*/
|
|
22733
|
-
destinationId: string;
|
|
22734
21108
|
/** @enum {string} */
|
|
22735
21109
|
status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
|
|
22736
21110
|
/** @enum {string} */
|
|
@@ -22750,12 +21124,8 @@ interface operations {
|
|
|
22750
21124
|
maxAmountUsd: string | null;
|
|
22751
21125
|
appliedAmountUsd: string;
|
|
22752
21126
|
} | null;
|
|
22753
|
-
/**
|
|
22754
|
-
|
|
22755
|
-
* @example solana
|
|
22756
|
-
* @constant
|
|
22757
|
-
*/
|
|
22758
|
-
network: "solana";
|
|
21127
|
+
/** @enum {string} */
|
|
21128
|
+
network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
|
|
22759
21129
|
/**
|
|
22760
21130
|
* @description Asset sent to the deposit destination
|
|
22761
21131
|
* @example USDC
|
|
@@ -23548,6 +21918,198 @@ interface operations {
|
|
|
23548
21918
|
};
|
|
23549
21919
|
};
|
|
23550
21920
|
};
|
|
21921
|
+
"deleteV1SandboxFunding-sourcesByFundingSourceId": {
|
|
21922
|
+
parameters: {
|
|
21923
|
+
query?: never;
|
|
21924
|
+
header?: never;
|
|
21925
|
+
path: {
|
|
21926
|
+
fundingSourceId: string;
|
|
21927
|
+
};
|
|
21928
|
+
cookie?: never;
|
|
21929
|
+
};
|
|
21930
|
+
requestBody?: never;
|
|
21931
|
+
responses: {
|
|
21932
|
+
/** @description Confirmation that a funding source was removed */
|
|
21933
|
+
200: {
|
|
21934
|
+
headers: {
|
|
21935
|
+
[name: string]: unknown;
|
|
21936
|
+
};
|
|
21937
|
+
content: {
|
|
21938
|
+
"application/json": {
|
|
21939
|
+
/**
|
|
21940
|
+
* @description Opaque public identifier for the removed funding source
|
|
21941
|
+
* @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
|
|
21942
|
+
*/
|
|
21943
|
+
id: string;
|
|
21944
|
+
/**
|
|
21945
|
+
* @description Always true for a removed funding source response
|
|
21946
|
+
* @constant
|
|
21947
|
+
*/
|
|
21948
|
+
deleted: true;
|
|
21949
|
+
};
|
|
21950
|
+
};
|
|
21951
|
+
};
|
|
21952
|
+
/** @description Response for status 401 */
|
|
21953
|
+
401: {
|
|
21954
|
+
headers: {
|
|
21955
|
+
[name: string]: unknown;
|
|
21956
|
+
};
|
|
21957
|
+
content: {
|
|
21958
|
+
"application/json": {
|
|
21959
|
+
/**
|
|
21960
|
+
* @description A URI reference that identifies the problem type
|
|
21961
|
+
* @default about:blank
|
|
21962
|
+
* @example urn:problem-type:auth:unauthorized
|
|
21963
|
+
* @example urn:problem-type:auth:token-expired
|
|
21964
|
+
*/
|
|
21965
|
+
type: string;
|
|
21966
|
+
/**
|
|
21967
|
+
* @description A short, human-readable summary of the problem type
|
|
21968
|
+
* @example Unauthorized
|
|
21969
|
+
* @example Token Expired
|
|
21970
|
+
*/
|
|
21971
|
+
title: string;
|
|
21972
|
+
/**
|
|
21973
|
+
* @description The HTTP status code
|
|
21974
|
+
* @example 401
|
|
21975
|
+
* @example 403
|
|
21976
|
+
*/
|
|
21977
|
+
status: number;
|
|
21978
|
+
/**
|
|
21979
|
+
* @description A human-readable explanation specific to this occurrence
|
|
21980
|
+
* @example Bearer token required
|
|
21981
|
+
* @example Invalid token
|
|
21982
|
+
*/
|
|
21983
|
+
detail?: string;
|
|
21984
|
+
/** @description A URI reference that identifies the specific occurrence */
|
|
21985
|
+
instance?: string;
|
|
21986
|
+
/**
|
|
21987
|
+
* @description The authentication realm
|
|
21988
|
+
* @example API
|
|
21989
|
+
*/
|
|
21990
|
+
realm?: string;
|
|
21991
|
+
/**
|
|
21992
|
+
* @description The required scope for this resource
|
|
21993
|
+
* @example read:users
|
|
21994
|
+
* @example write:orders
|
|
21995
|
+
*/
|
|
21996
|
+
scope?: string;
|
|
21997
|
+
};
|
|
21998
|
+
};
|
|
21999
|
+
};
|
|
22000
|
+
/** @description Response for status 403 */
|
|
22001
|
+
403: {
|
|
22002
|
+
headers: {
|
|
22003
|
+
[name: string]: unknown;
|
|
22004
|
+
};
|
|
22005
|
+
content: {
|
|
22006
|
+
"application/json": {
|
|
22007
|
+
/**
|
|
22008
|
+
* @description A URI reference that identifies the problem type
|
|
22009
|
+
* @default about:blank
|
|
22010
|
+
* @example urn:problem-type:auth:unauthorized
|
|
22011
|
+
* @example urn:problem-type:system:internal-error
|
|
22012
|
+
*/
|
|
22013
|
+
type: string;
|
|
22014
|
+
/**
|
|
22015
|
+
* @description A short, human-readable summary of the problem type
|
|
22016
|
+
* @example Unauthorized
|
|
22017
|
+
* @example Internal Server Error
|
|
22018
|
+
*/
|
|
22019
|
+
title: string;
|
|
22020
|
+
/**
|
|
22021
|
+
* @description The HTTP status code
|
|
22022
|
+
* @example 400
|
|
22023
|
+
* @example 401
|
|
22024
|
+
* @example 404
|
|
22025
|
+
* @example 500
|
|
22026
|
+
*/
|
|
22027
|
+
status: number;
|
|
22028
|
+
/** @description A human-readable explanation specific to this occurrence */
|
|
22029
|
+
detail?: string;
|
|
22030
|
+
/**
|
|
22031
|
+
* @description A URI reference that identifies the specific occurrence
|
|
22032
|
+
* @example /errors/1234567890
|
|
22033
|
+
*/
|
|
22034
|
+
instance?: string;
|
|
22035
|
+
};
|
|
22036
|
+
};
|
|
22037
|
+
};
|
|
22038
|
+
/** @description Response for status 404 */
|
|
22039
|
+
404: {
|
|
22040
|
+
headers: {
|
|
22041
|
+
[name: string]: unknown;
|
|
22042
|
+
};
|
|
22043
|
+
content: {
|
|
22044
|
+
"application/json": {
|
|
22045
|
+
/**
|
|
22046
|
+
* @description A URI reference that identifies the problem type
|
|
22047
|
+
* @default about:blank
|
|
22048
|
+
*/
|
|
22049
|
+
type: string;
|
|
22050
|
+
/** @description A short, human-readable summary of the problem type */
|
|
22051
|
+
title: string;
|
|
22052
|
+
/**
|
|
22053
|
+
* @description The HTTP status code
|
|
22054
|
+
* @example 404
|
|
22055
|
+
*/
|
|
22056
|
+
status: number;
|
|
22057
|
+
/** @description A human-readable explanation specific to this occurrence */
|
|
22058
|
+
detail?: string;
|
|
22059
|
+
/** @description A URI reference that identifies the specific occurrence */
|
|
22060
|
+
instance?: string;
|
|
22061
|
+
/**
|
|
22062
|
+
* @description The type of resource that was not found
|
|
22063
|
+
* @example user
|
|
22064
|
+
* @example account
|
|
22065
|
+
* @example transaction
|
|
22066
|
+
*/
|
|
22067
|
+
resourceType: string;
|
|
22068
|
+
/** @description The identifier of the resource that was not found */
|
|
22069
|
+
resourceId: string;
|
|
22070
|
+
};
|
|
22071
|
+
};
|
|
22072
|
+
};
|
|
22073
|
+
/** @description Response for status 500 */
|
|
22074
|
+
500: {
|
|
22075
|
+
headers: {
|
|
22076
|
+
[name: string]: unknown;
|
|
22077
|
+
};
|
|
22078
|
+
content: {
|
|
22079
|
+
"application/json": {
|
|
22080
|
+
/**
|
|
22081
|
+
* @description A URI reference that identifies the problem type
|
|
22082
|
+
* @default about:blank
|
|
22083
|
+
* @example urn:problem-type:auth:unauthorized
|
|
22084
|
+
* @example urn:problem-type:system:internal-error
|
|
22085
|
+
*/
|
|
22086
|
+
type: string;
|
|
22087
|
+
/**
|
|
22088
|
+
* @description A short, human-readable summary of the problem type
|
|
22089
|
+
* @example Unauthorized
|
|
22090
|
+
* @example Internal Server Error
|
|
22091
|
+
*/
|
|
22092
|
+
title: string;
|
|
22093
|
+
/**
|
|
22094
|
+
* @description The HTTP status code
|
|
22095
|
+
* @example 400
|
|
22096
|
+
* @example 401
|
|
22097
|
+
* @example 404
|
|
22098
|
+
* @example 500
|
|
22099
|
+
*/
|
|
22100
|
+
status: number;
|
|
22101
|
+
/** @description A human-readable explanation specific to this occurrence */
|
|
22102
|
+
detail?: string;
|
|
22103
|
+
/**
|
|
22104
|
+
* @description A URI reference that identifies the specific occurrence
|
|
22105
|
+
* @example /errors/1234567890
|
|
22106
|
+
*/
|
|
22107
|
+
instance?: string;
|
|
22108
|
+
};
|
|
22109
|
+
};
|
|
22110
|
+
};
|
|
22111
|
+
};
|
|
22112
|
+
};
|
|
23551
22113
|
}
|
|
23552
22114
|
|
|
23553
22115
|
type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
|
|
@@ -25365,7 +23927,7 @@ declare class DepositService {
|
|
|
25365
23927
|
maxAmountUsd: string | null;
|
|
25366
23928
|
appliedAmountUsd: string;
|
|
25367
23929
|
} | null;
|
|
25368
|
-
network: "solana";
|
|
23930
|
+
network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
|
|
25369
23931
|
asset: "USDC";
|
|
25370
23932
|
assetAddress: string;
|
|
25371
23933
|
destinationAddress: string;
|
|
@@ -25374,7 +23936,6 @@ declare class DepositService {
|
|
|
25374
23936
|
create(input: CreateDepositRequest): Promise<{
|
|
25375
23937
|
id: string;
|
|
25376
23938
|
sourceId: string;
|
|
25377
|
-
destinationId: string;
|
|
25378
23939
|
status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
|
|
25379
23940
|
quoteType: "exact_input" | "exact_output";
|
|
25380
23941
|
priority: "normal" | "high";
|
|
@@ -25391,7 +23952,7 @@ declare class DepositService {
|
|
|
25391
23952
|
maxAmountUsd: string | null;
|
|
25392
23953
|
appliedAmountUsd: string;
|
|
25393
23954
|
} | null;
|
|
25394
|
-
network: "solana";
|
|
23955
|
+
network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
|
|
25395
23956
|
asset: "USDC";
|
|
25396
23957
|
assetAddress: string;
|
|
25397
23958
|
address: string;
|
|
@@ -25475,6 +24036,7 @@ declare class InstitutionService {
|
|
|
25475
24036
|
type BypassKycRequest = PathRequestBody<'/v1/sandbox/bypass-kyc', 'post'>;
|
|
25476
24037
|
type CreateDepositWithReturnRequest = PathRequestBody<'/v1/sandbox/deposits/direct', 'post'>;
|
|
25477
24038
|
type CreateDepositWithReturnResponse = PathResponse<'/v1/sandbox/deposits/direct', 'post'>;
|
|
24039
|
+
type DeleteFundingSourceResponse = PathResponse<'/v1/sandbox/funding-sources/{fundingSourceId}', 'delete'>;
|
|
25478
24040
|
declare class SandboxService {
|
|
25479
24041
|
private client;
|
|
25480
24042
|
constructor(client: SpritzClient);
|
|
@@ -25493,7 +24055,6 @@ declare class SandboxService {
|
|
|
25493
24055
|
createDepositWithReturn(input: CreateDepositWithReturnRequest): Promise<{
|
|
25494
24056
|
id: string;
|
|
25495
24057
|
sourceId: string;
|
|
25496
|
-
destinationId: string;
|
|
25497
24058
|
status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
|
|
25498
24059
|
quoteType: "exact_input" | "exact_output";
|
|
25499
24060
|
priority: "normal" | "high";
|
|
@@ -25510,7 +24071,7 @@ declare class SandboxService {
|
|
|
25510
24071
|
maxAmountUsd: string | null;
|
|
25511
24072
|
appliedAmountUsd: string;
|
|
25512
24073
|
} | null;
|
|
25513
|
-
network: "solana";
|
|
24074
|
+
network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
|
|
25514
24075
|
asset: "USDC";
|
|
25515
24076
|
assetAddress: string;
|
|
25516
24077
|
address: string;
|
|
@@ -25533,6 +24094,16 @@ declare class SandboxService {
|
|
|
25533
24094
|
releaseFailureReason: string | null;
|
|
25534
24095
|
payoutTxHash: string | null;
|
|
25535
24096
|
}>;
|
|
24097
|
+
/**
|
|
24098
|
+
* Permanently remove an ACH debit funding source for the authenticated user.
|
|
24099
|
+
* Intended for resetting funding sources during integration testing.
|
|
24100
|
+
*
|
|
24101
|
+
* Only available in sandbox environments — returns 403 in production.
|
|
24102
|
+
*/
|
|
24103
|
+
deleteFundingSource(fundingSourceId: string): Promise<{
|
|
24104
|
+
id: string;
|
|
24105
|
+
deleted: true;
|
|
24106
|
+
}>;
|
|
25536
24107
|
}
|
|
25537
24108
|
|
|
25538
24109
|
interface CreateOnrampPayment_createOnrampPayment_depositInstructions {
|
|
@@ -26160,4 +24731,4 @@ declare class InternalServerError extends APIError {
|
|
|
26160
24731
|
}
|
|
26161
24732
|
|
|
26162
24733
|
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 };
|
|
26163
|
-
export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CategoryAccess, ClientOptions, CompleteLinkingRequest, 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, 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 };
|
|
24734
|
+
export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CategoryAccess, ClientOptions, CompleteLinkingRequest, 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, 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 };
|