@spritz-finance/api-client 0.8.0 → 0.8.2

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.
@@ -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;
@@ -2877,7 +2773,7 @@ interface operations {
2877
2773
  "application/json": {
2878
2774
  /**
2879
2775
  * @description Destination account ID
2880
- * @example 69fcc3849e56476d70fe629a
2776
+ * @example 6a073b8fc31db9dffe9cd278
2881
2777
  */
2882
2778
  accountId: string;
2883
2779
  /**
@@ -2905,7 +2801,7 @@ interface operations {
2905
2801
  "application/x-www-form-urlencoded": {
2906
2802
  /**
2907
2803
  * @description Destination account ID
2908
- * @example 69fcc3849e56476d70fe629a
2804
+ * @example 6a073b8fc31db9dffe9cd278
2909
2805
  */
2910
2806
  accountId: string;
2911
2807
  /**
@@ -2933,7 +2829,7 @@ interface operations {
2933
2829
  "multipart/form-data": {
2934
2830
  /**
2935
2831
  * @description Destination account ID
2936
- * @example 69fcc3849e56476d70fe629a
2832
+ * @example 6a073b8fc31db9dffe9cd278
2937
2833
  */
2938
2834
  accountId: string;
2939
2835
  /**
@@ -2980,7 +2876,7 @@ interface operations {
2980
2876
  /**
2981
2877
  * Format: date-time
2982
2878
  * @description When the quote was created
2983
- * @example 2026-05-07T16:53:24.366Z
2879
+ * @example 2026-05-15T15:28:15.636Z
2984
2880
  */
2985
2881
  createdAt: string;
2986
2882
  /** @description What the user pays — total USD cost and token used. */
@@ -3019,7 +2915,7 @@ interface operations {
3019
2915
  rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
3020
2916
  /**
3021
2917
  * @description Destination account ID
3022
- * @example 69fcc3849e56476d70fe629b
2918
+ * @example 6a073b8fc31db9dffe9cd279
3023
2919
  */
3024
2920
  accountId: string;
3025
2921
  };
@@ -3226,7 +3122,7 @@ interface operations {
3226
3122
  /**
3227
3123
  * Format: date-time
3228
3124
  * @description When the quote was created
3229
- * @example 2026-05-07T16:53:24.366Z
3125
+ * @example 2026-05-15T15:28:15.636Z
3230
3126
  */
3231
3127
  createdAt: string;
3232
3128
  /** @description What the user pays — total USD cost and token used. */
@@ -3265,7 +3161,7 @@ interface operations {
3265
3161
  rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
3266
3162
  /**
3267
3163
  * @description Destination account ID
3268
- * @example 69fcc3849e56476d70fe629b
3164
+ * @example 6a073b8fc31db9dffe9cd279
3269
3165
  */
3270
3166
  accountId: string;
3271
3167
  };
@@ -3762,7 +3658,7 @@ interface operations {
3762
3658
  currency: string;
3763
3659
  /**
3764
3660
  * @description Destination account ID
3765
- * @example 69fcc3849e56476d70fe629c
3661
+ * @example 6a073b8fc31db9dffe9cd27a
3766
3662
  */
3767
3663
  accountId: string;
3768
3664
  accountName: (string | null) | null;
@@ -3978,7 +3874,7 @@ interface operations {
3978
3874
  currency: string;
3979
3875
  /**
3980
3876
  * @description Destination account ID
3981
- * @example 69fcc3849e56476d70fe629c
3877
+ * @example 6a073b8fc31db9dffe9cd27a
3982
3878
  */
3983
3879
  accountId: string;
3984
3880
  accountName: (string | null) | null;
@@ -7187,11 +7083,31 @@ interface operations {
7187
7083
  */
7188
7084
  bankAccountId: string;
7189
7085
  /**
7190
- * @description Institution name used for funding source display
7086
+ * @description Institution name used for funding source display. Prefer `institution.name` when present; this field will be removed in a future release.
7191
7087
  * @example Plaid Test Bank
7192
7088
  * @example null
7193
7089
  */
7194
7090
  institutionName: string | null;
7091
+ /** @description Branding metadata for the institution backing the funding source, or null when no institution data is available. */
7092
+ institution: {
7093
+ /**
7094
+ * @description Display name for the institution
7095
+ * @example Chase
7096
+ */
7097
+ name: string;
7098
+ /**
7099
+ * @description Absolute URL to the institution's logo (PNG). Null when the institution has no logo on file.
7100
+ * @example https://assets.platform.spritz.finance/institutions/ins_109508.png
7101
+ * @example null
7102
+ */
7103
+ logoUrl: string | null;
7104
+ /**
7105
+ * @description Hex color (e.g. `#1e88e5`) representing the institution's brand. Null when unavailable.
7106
+ * @example #1e88e5
7107
+ * @example null
7108
+ */
7109
+ primaryColor: string | null;
7110
+ } | null;
7195
7111
  /**
7196
7112
  * @description Last 4 digits of the linked bank account number
7197
7113
  * @example 6789
@@ -7550,11 +7466,31 @@ interface operations {
7550
7466
  */
7551
7467
  bankAccountId: string;
7552
7468
  /**
7553
- * @description Institution name used for funding source display
7469
+ * @description Institution name used for funding source display. Prefer `institution.name` when present; this field will be removed in a future release.
7554
7470
  * @example Plaid Test Bank
7555
7471
  * @example null
7556
7472
  */
7557
7473
  institutionName: string | null;
7474
+ /** @description Branding metadata for the institution backing the funding source, or null when no institution data is available. */
7475
+ institution: {
7476
+ /**
7477
+ * @description Display name for the institution
7478
+ * @example Chase
7479
+ */
7480
+ name: string;
7481
+ /**
7482
+ * @description Absolute URL to the institution's logo (PNG). Null when the institution has no logo on file.
7483
+ * @example https://assets.platform.spritz.finance/institutions/ins_109508.png
7484
+ * @example null
7485
+ */
7486
+ logoUrl: string | null;
7487
+ /**
7488
+ * @description Hex color (e.g. `#1e88e5`) representing the institution's brand. Null when unavailable.
7489
+ * @example #1e88e5
7490
+ * @example null
7491
+ */
7492
+ primaryColor: string | null;
7493
+ } | null;
7558
7494
  /**
7559
7495
  * @description Last 4 digits of the linked bank account number
7560
7496
  * @example 6789
@@ -7700,7 +7636,7 @@ interface operations {
7700
7636
  };
7701
7637
  };
7702
7638
  };
7703
- "postV1Deposit-destinationsPrepare": {
7639
+ postV1DepositsDirectPrepare: {
7704
7640
  parameters: {
7705
7641
  query?: never;
7706
7642
  header?: never;
@@ -7715,15 +7651,32 @@ interface operations {
7715
7651
  * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
7716
7652
  */
7717
7653
  sourceId: string;
7718
- /** @constant */
7719
- network: "solana";
7720
- /** @constant */
7721
- asset: "USDC";
7722
7654
  /**
7723
- * @description Destination wallet address for the selected network
7724
- * @example 9xQeWvG816bUx9EPjHmaT23yvVM3qvGqLrL7Kx1YwM9R
7655
+ * @description Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source.
7656
+ * @example 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY
7725
7657
  */
7726
7658
  address: string;
7659
+ /** @enum {string} */
7660
+ network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
7661
+ /**
7662
+ * @description Asset sent to the deposit destination
7663
+ * @example USDC
7664
+ * @constant
7665
+ */
7666
+ asset: "USDC";
7667
+ /** @enum {string} */
7668
+ quoteType: "exact_input" | "exact_output";
7669
+ /**
7670
+ * @description Requested USD amount as a decimal string
7671
+ * @example 100.00
7672
+ */
7673
+ amountUsd: string;
7674
+ /** @enum {string} */
7675
+ priority: "normal" | "high";
7676
+ feeSubsidy?: {
7677
+ percentage: number;
7678
+ maxAmountUsd?: string;
7679
+ };
7727
7680
  clientContext?: {
7728
7681
  clientIp?: string;
7729
7682
  userAgent?: string;
@@ -7739,15 +7692,32 @@ interface operations {
7739
7692
  * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
7740
7693
  */
7741
7694
  sourceId: string;
7742
- /** @constant */
7743
- network: "solana";
7744
- /** @constant */
7745
- asset: "USDC";
7746
7695
  /**
7747
- * @description Destination wallet address for the selected network
7748
- * @example 9xQeWvG816bUx9EPjHmaT23yvVM3qvGqLrL7Kx1YwM9R
7696
+ * @description Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source.
7697
+ * @example 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY
7749
7698
  */
7750
7699
  address: string;
7700
+ /** @enum {string} */
7701
+ network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
7702
+ /**
7703
+ * @description Asset sent to the deposit destination
7704
+ * @example USDC
7705
+ * @constant
7706
+ */
7707
+ asset: "USDC";
7708
+ /** @enum {string} */
7709
+ quoteType: "exact_input" | "exact_output";
7710
+ /**
7711
+ * @description Requested USD amount as a decimal string
7712
+ * @example 100.00
7713
+ */
7714
+ amountUsd: string;
7715
+ /** @enum {string} */
7716
+ priority: "normal" | "high";
7717
+ feeSubsidy?: {
7718
+ percentage: number;
7719
+ maxAmountUsd?: string;
7720
+ };
7751
7721
  clientContext?: {
7752
7722
  clientIp?: string;
7753
7723
  userAgent?: string;
@@ -7763,15 +7733,32 @@ interface operations {
7763
7733
  * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
7764
7734
  */
7765
7735
  sourceId: string;
7766
- /** @constant */
7767
- network: "solana";
7768
- /** @constant */
7769
- asset: "USDC";
7770
7736
  /**
7771
- * @description Destination wallet address for the selected network
7772
- * @example 9xQeWvG816bUx9EPjHmaT23yvVM3qvGqLrL7Kx1YwM9R
7737
+ * @description Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source.
7738
+ * @example 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY
7773
7739
  */
7774
7740
  address: string;
7741
+ /** @enum {string} */
7742
+ network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
7743
+ /**
7744
+ * @description Asset sent to the deposit destination
7745
+ * @example USDC
7746
+ * @constant
7747
+ */
7748
+ asset: "USDC";
7749
+ /** @enum {string} */
7750
+ quoteType: "exact_input" | "exact_output";
7751
+ /**
7752
+ * @description Requested USD amount as a decimal string
7753
+ * @example 100.00
7754
+ */
7755
+ amountUsd: string;
7756
+ /** @enum {string} */
7757
+ priority: "normal" | "high";
7758
+ feeSubsidy?: {
7759
+ percentage: number;
7760
+ maxAmountUsd?: string;
7761
+ };
7775
7762
  clientContext?: {
7776
7763
  clientIp?: string;
7777
7764
  userAgent?: string;
@@ -7797,20 +7784,43 @@ interface operations {
7797
7784
  */
7798
7785
  preparationId: string;
7799
7786
  /** @constant */
7800
- kind: "destination_bind";
7787
+ kind: "deposit_authorization";
7801
7788
  /** Format: date-time */
7802
7789
  expiresAt: string;
7803
7790
  /** @constant */
7804
7791
  messageVersion: "v1";
7805
- /** @description Canonical wallet-signable verification message */
7792
+ /** @description Display-ready ACH authorization message */
7806
7793
  message: string;
7807
- /**
7808
- * @description Canonical asset address or mint address for the selected network and asset
7809
- * @example EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
7810
- */
7811
- assetAddress: string;
7812
- /** @description Normalized destination address used in the signed message */
7813
- normalizedAddress: string;
7794
+ summary: {
7795
+ /** @enum {string} */
7796
+ quoteType: "exact_input" | "exact_output";
7797
+ requestedAmountUsd: string;
7798
+ /** @enum {string} */
7799
+ priority: "normal" | "high";
7800
+ feeRateBps: number;
7801
+ principalAmountUsd: string;
7802
+ expectedAssetAmount: string;
7803
+ grossFeeUsd: string;
7804
+ feeSubsidyUsd: string;
7805
+ userFeeUsd: string;
7806
+ totalDebitAmountUsd: string;
7807
+ feeSubsidy: {
7808
+ percentage: number;
7809
+ percentageBps: number;
7810
+ maxAmountUsd: string | null;
7811
+ appliedAmountUsd: string;
7812
+ } | null;
7813
+ /** @enum {string} */
7814
+ network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
7815
+ /**
7816
+ * @description Asset sent to the deposit destination
7817
+ * @example USDC
7818
+ * @constant
7819
+ */
7820
+ asset: "USDC";
7821
+ assetAddress: string;
7822
+ destinationAddress: string;
7823
+ };
7814
7824
  };
7815
7825
  };
7816
7826
  };
@@ -7937,1304 +7947,29 @@ interface operations {
7937
7947
  };
7938
7948
  };
7939
7949
  };
7940
- "getV1Deposit-destinations": {
7950
+ postV1DepositsDirect: {
7941
7951
  parameters: {
7942
7952
  query?: never;
7943
7953
  header?: never;
7944
7954
  path?: never;
7945
7955
  cookie?: never;
7946
7956
  };
7947
- requestBody?: never;
7948
- responses: {
7949
- /** @description Response for status 200 */
7950
- 200: {
7951
- headers: {
7952
- [name: string]: unknown;
7953
- };
7954
- content: {
7955
- "application/json": {
7956
- /**
7957
- * @description Opaque public identifier for the deposit destination
7958
- * @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
7959
- */
7960
- id: string;
7961
- /**
7962
- * @description Opaque public funding source identifier
7963
- * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
7964
- */
7965
- sourceId: string;
7966
- /**
7967
- * @description Blockchain network for the bound deposit destination
7968
- * @example solana
7969
- * @constant
7970
- */
7971
- network: "solana";
7972
- /**
7973
- * @description Asset sent to the deposit destination
7974
- * @example USDC
7975
- * @constant
7976
- */
7977
- asset: "USDC";
7978
- /**
7979
- * @description Canonical asset address or mint address for the selected network and asset
7980
- * @example EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
7981
- */
7982
- assetAddress: string;
7983
- /** @description Bound wallet destination address */
7984
- address: string;
7985
- /** @enum {string} */
7986
- status: "active" | "revoked";
7987
- /**
7988
- * Format: date-time
7989
- * @description When the destination was created
7990
- */
7991
- createdAt: string;
7992
- /** @description When the destination was revoked, or null when active */
7993
- revokedAt: string | null;
7994
- }[];
7995
- };
7996
- };
7997
- /** @description Response for status 401 */
7998
- 401: {
7999
- headers: {
8000
- [name: string]: unknown;
8001
- };
8002
- content: {
8003
- "application/json": {
8004
- /**
8005
- * @description A URI reference that identifies the problem type
8006
- * @default about:blank
8007
- * @example urn:problem-type:auth:unauthorized
8008
- * @example urn:problem-type:auth:token-expired
8009
- */
8010
- type: string;
8011
- /**
8012
- * @description A short, human-readable summary of the problem type
8013
- * @example Unauthorized
8014
- * @example Token Expired
8015
- */
8016
- title: string;
8017
- /**
8018
- * @description The HTTP status code
8019
- * @example 401
8020
- * @example 403
8021
- */
8022
- status: number;
8023
- /**
8024
- * @description A human-readable explanation specific to this occurrence
8025
- * @example Bearer token required
8026
- * @example Invalid token
8027
- */
8028
- detail?: string;
8029
- /** @description A URI reference that identifies the specific occurrence */
8030
- instance?: string;
8031
- /**
8032
- * @description The authentication realm
8033
- * @example API
8034
- */
8035
- realm?: string;
8036
- /**
8037
- * @description The required scope for this resource
8038
- * @example read:users
8039
- * @example write:orders
8040
- */
8041
- scope?: string;
8042
- };
8043
- };
8044
- };
8045
- /** @description Response for status 404 */
8046
- 404: {
8047
- headers: {
8048
- [name: string]: unknown;
8049
- };
8050
- content: {
8051
- "application/json": {
8052
- /**
8053
- * @description A URI reference that identifies the problem type
8054
- * @default about:blank
8055
- */
8056
- type: string;
8057
- /** @description A short, human-readable summary of the problem type */
8058
- title: string;
8059
- /**
8060
- * @description The HTTP status code
8061
- * @example 404
8062
- */
8063
- status: number;
8064
- /** @description A human-readable explanation specific to this occurrence */
8065
- detail?: string;
8066
- /** @description A URI reference that identifies the specific occurrence */
8067
- instance?: string;
8068
- /**
8069
- * @description The type of resource that was not found
8070
- * @example user
8071
- * @example account
8072
- * @example transaction
8073
- */
8074
- resourceType: string;
8075
- /** @description The identifier of the resource that was not found */
8076
- resourceId: string;
8077
- };
8078
- };
8079
- };
8080
- /** @description Response for status 500 */
8081
- 500: {
8082
- headers: {
8083
- [name: string]: unknown;
8084
- };
8085
- content: {
8086
- "application/json": {
8087
- /**
8088
- * @description A URI reference that identifies the problem type
8089
- * @default about:blank
8090
- * @example urn:problem-type:auth:unauthorized
8091
- * @example urn:problem-type:system:internal-error
8092
- */
8093
- type: string;
8094
- /**
8095
- * @description A short, human-readable summary of the problem type
8096
- * @example Unauthorized
8097
- * @example Internal Server Error
8098
- */
8099
- title: string;
8100
- /**
8101
- * @description The HTTP status code
8102
- * @example 400
8103
- * @example 401
8104
- * @example 404
8105
- * @example 500
8106
- */
8107
- status: number;
8108
- /** @description A human-readable explanation specific to this occurrence */
8109
- detail?: string;
8110
- /**
8111
- * @description A URI reference that identifies the specific occurrence
8112
- * @example /errors/1234567890
8113
- */
8114
- instance?: string;
8115
- };
8116
- };
8117
- };
8118
- };
8119
- };
8120
- "postV1Deposit-destinations": {
8121
- parameters: {
8122
- query?: never;
8123
- header?: never;
8124
- path?: never;
8125
- cookie?: never;
8126
- };
8127
- requestBody: {
8128
- content: {
8129
- "application/json": {
8130
- /**
8131
- * @description Opaque public preparation identifier returned by prepare
8132
- * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8133
- */
8134
- preparationId: string;
8135
- /** @description Ed25519 signature over the exact message text. Base58 is preferred for Solana clients; base64 is also accepted. */
8136
- signature: string;
8137
- /**
8138
- * @description Wallet address that produced the signature
8139
- * @example 9xQeWvG816bUx9EPjHmaT23yvVM3qvGqLrL7Kx1YwM9R
8140
- */
8141
- signerAddress: string;
8142
- clientContext?: {
8143
- clientIp?: string;
8144
- userAgent?: string;
8145
- sessionId?: string;
8146
- deviceId?: string;
8147
- platform?: string;
8148
- appVersion?: string;
8149
- };
8150
- };
8151
- "application/x-www-form-urlencoded": {
8152
- /**
8153
- * @description Opaque public preparation identifier returned by prepare
8154
- * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8155
- */
8156
- preparationId: string;
8157
- /** @description Ed25519 signature over the exact message text. Base58 is preferred for Solana clients; base64 is also accepted. */
8158
- signature: string;
8159
- /**
8160
- * @description Wallet address that produced the signature
8161
- * @example 9xQeWvG816bUx9EPjHmaT23yvVM3qvGqLrL7Kx1YwM9R
8162
- */
8163
- signerAddress: string;
8164
- clientContext?: {
8165
- clientIp?: string;
8166
- userAgent?: string;
8167
- sessionId?: string;
8168
- deviceId?: string;
8169
- platform?: string;
8170
- appVersion?: string;
8171
- };
8172
- };
8173
- "multipart/form-data": {
8174
- /**
8175
- * @description Opaque public preparation identifier returned by prepare
8176
- * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8177
- */
8178
- preparationId: string;
8179
- /** @description Ed25519 signature over the exact message text. Base58 is preferred for Solana clients; base64 is also accepted. */
8180
- signature: string;
8181
- /**
8182
- * @description Wallet address that produced the signature
8183
- * @example 9xQeWvG816bUx9EPjHmaT23yvVM3qvGqLrL7Kx1YwM9R
8184
- */
8185
- signerAddress: string;
8186
- clientContext?: {
8187
- clientIp?: string;
8188
- userAgent?: string;
8189
- sessionId?: string;
8190
- deviceId?: string;
8191
- platform?: string;
8192
- appVersion?: string;
8193
- };
8194
- };
8195
- };
8196
- };
8197
- responses: {
8198
- /** @description A wallet destination bound to a funding source for future on-ramp deposits */
8199
- 200: {
8200
- headers: {
8201
- [name: string]: unknown;
8202
- };
8203
- content: {
8204
- "application/json": {
8205
- /**
8206
- * @description Opaque public identifier for the deposit destination
8207
- * @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8208
- */
8209
- id: string;
8210
- /**
8211
- * @description Opaque public funding source identifier
8212
- * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8213
- */
8214
- sourceId: string;
8215
- /**
8216
- * @description Blockchain network for the bound deposit destination
8217
- * @example solana
8218
- * @constant
8219
- */
8220
- network: "solana";
8221
- /**
8222
- * @description Asset sent to the deposit destination
8223
- * @example USDC
8224
- * @constant
8225
- */
8226
- asset: "USDC";
8227
- /**
8228
- * @description Canonical asset address or mint address for the selected network and asset
8229
- * @example EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
8230
- */
8231
- assetAddress: string;
8232
- /** @description Bound wallet destination address */
8233
- address: string;
8234
- /** @enum {string} */
8235
- status: "active" | "revoked";
8236
- /**
8237
- * Format: date-time
8238
- * @description When the destination was created
8239
- */
8240
- createdAt: string;
8241
- /** @description When the destination was revoked, or null when active */
8242
- revokedAt: string | null;
8243
- };
8244
- };
8245
- };
8246
- /** @description Response for status 401 */
8247
- 401: {
8248
- headers: {
8249
- [name: string]: unknown;
8250
- };
8251
- content: {
8252
- "application/json": {
8253
- /**
8254
- * @description A URI reference that identifies the problem type
8255
- * @default about:blank
8256
- * @example urn:problem-type:auth:unauthorized
8257
- * @example urn:problem-type:auth:token-expired
8258
- */
8259
- type: string;
8260
- /**
8261
- * @description A short, human-readable summary of the problem type
8262
- * @example Unauthorized
8263
- * @example Token Expired
8264
- */
8265
- title: string;
8266
- /**
8267
- * @description The HTTP status code
8268
- * @example 401
8269
- * @example 403
8270
- */
8271
- status: number;
8272
- /**
8273
- * @description A human-readable explanation specific to this occurrence
8274
- * @example Bearer token required
8275
- * @example Invalid token
8276
- */
8277
- detail?: string;
8278
- /** @description A URI reference that identifies the specific occurrence */
8279
- instance?: string;
8280
- /**
8281
- * @description The authentication realm
8282
- * @example API
8283
- */
8284
- realm?: string;
8285
- /**
8286
- * @description The required scope for this resource
8287
- * @example read:users
8288
- * @example write:orders
8289
- */
8290
- scope?: string;
8291
- };
8292
- };
8293
- };
8294
- /** @description Response for status 404 */
8295
- 404: {
8296
- headers: {
8297
- [name: string]: unknown;
8298
- };
8299
- content: {
8300
- "application/json": {
8301
- /**
8302
- * @description A URI reference that identifies the problem type
8303
- * @default about:blank
8304
- */
8305
- type: string;
8306
- /** @description A short, human-readable summary of the problem type */
8307
- title: string;
8308
- /**
8309
- * @description The HTTP status code
8310
- * @example 404
8311
- */
8312
- status: number;
8313
- /** @description A human-readable explanation specific to this occurrence */
8314
- detail?: string;
8315
- /** @description A URI reference that identifies the specific occurrence */
8316
- instance?: string;
8317
- /**
8318
- * @description The type of resource that was not found
8319
- * @example user
8320
- * @example account
8321
- * @example transaction
8322
- */
8323
- resourceType: string;
8324
- /** @description The identifier of the resource that was not found */
8325
- resourceId: string;
8326
- };
8327
- };
8328
- };
8329
- /** @description Response for status 500 */
8330
- 500: {
8331
- headers: {
8332
- [name: string]: unknown;
8333
- };
8334
- content: {
8335
- "application/json": {
8336
- /**
8337
- * @description A URI reference that identifies the problem type
8338
- * @default about:blank
8339
- * @example urn:problem-type:auth:unauthorized
8340
- * @example urn:problem-type:system:internal-error
8341
- */
8342
- type: string;
8343
- /**
8344
- * @description A short, human-readable summary of the problem type
8345
- * @example Unauthorized
8346
- * @example Internal Server Error
8347
- */
8348
- title: string;
8349
- /**
8350
- * @description The HTTP status code
8351
- * @example 400
8352
- * @example 401
8353
- * @example 404
8354
- * @example 500
8355
- */
8356
- status: number;
8357
- /** @description A human-readable explanation specific to this occurrence */
8358
- detail?: string;
8359
- /**
8360
- * @description A URI reference that identifies the specific occurrence
8361
- * @example /errors/1234567890
8362
- */
8363
- instance?: string;
8364
- };
8365
- };
8366
- };
8367
- };
8368
- };
8369
- postV1DepositsPrepare: {
8370
- parameters: {
8371
- query?: never;
8372
- header?: never;
8373
- path?: never;
8374
- cookie?: never;
8375
- };
8376
- requestBody: {
8377
- content: {
8378
- "application/json": {
8379
- /**
8380
- * @description Opaque public funding source identifier
8381
- * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8382
- */
8383
- sourceId: string;
8384
- /**
8385
- * @description Opaque public deposit destination identifier
8386
- * @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8387
- */
8388
- destinationId: string;
8389
- /** @enum {string} */
8390
- quoteType: "exact_input" | "exact_output";
8391
- /**
8392
- * @description Requested USD amount as a decimal string
8393
- * @example 100.00
8394
- */
8395
- amountUsd: string;
8396
- /** @enum {string} */
8397
- priority: "normal" | "high";
8398
- feeSubsidy?: {
8399
- percentage: number;
8400
- maxAmountUsd?: string;
8401
- };
8402
- clientContext?: {
8403
- clientIp?: string;
8404
- userAgent?: string;
8405
- sessionId?: string;
8406
- deviceId?: string;
8407
- platform?: string;
8408
- appVersion?: string;
8409
- };
8410
- };
8411
- "application/x-www-form-urlencoded": {
8412
- /**
8413
- * @description Opaque public funding source identifier
8414
- * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8415
- */
8416
- sourceId: string;
8417
- /**
8418
- * @description Opaque public deposit destination identifier
8419
- * @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8420
- */
8421
- destinationId: string;
8422
- /** @enum {string} */
8423
- quoteType: "exact_input" | "exact_output";
8424
- /**
8425
- * @description Requested USD amount as a decimal string
8426
- * @example 100.00
8427
- */
8428
- amountUsd: string;
8429
- /** @enum {string} */
8430
- priority: "normal" | "high";
8431
- feeSubsidy?: {
8432
- percentage: number;
8433
- maxAmountUsd?: string;
8434
- };
8435
- clientContext?: {
8436
- clientIp?: string;
8437
- userAgent?: string;
8438
- sessionId?: string;
8439
- deviceId?: string;
8440
- platform?: string;
8441
- appVersion?: string;
8442
- };
8443
- };
8444
- "multipart/form-data": {
8445
- /**
8446
- * @description Opaque public funding source identifier
8447
- * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8448
- */
8449
- sourceId: string;
8450
- /**
8451
- * @description Opaque public deposit destination identifier
8452
- * @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8453
- */
8454
- destinationId: string;
8455
- /** @enum {string} */
8456
- quoteType: "exact_input" | "exact_output";
8457
- /**
8458
- * @description Requested USD amount as a decimal string
8459
- * @example 100.00
8460
- */
8461
- amountUsd: string;
8462
- /** @enum {string} */
8463
- priority: "normal" | "high";
8464
- feeSubsidy?: {
8465
- percentage: number;
8466
- maxAmountUsd?: string;
8467
- };
8468
- clientContext?: {
8469
- clientIp?: string;
8470
- userAgent?: string;
8471
- sessionId?: string;
8472
- deviceId?: string;
8473
- platform?: string;
8474
- appVersion?: string;
8475
- };
8476
- };
8477
- };
8478
- };
8479
- responses: {
8480
- /** @description Response for status 200 */
8481
- 200: {
8482
- headers: {
8483
- [name: string]: unknown;
8484
- };
8485
- content: {
8486
- "application/json": {
8487
- /**
8488
- * @description Opaque public preparation identifier
8489
- * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8490
- */
8491
- preparationId: string;
8492
- /** @constant */
8493
- kind: "deposit_authorization";
8494
- /** Format: date-time */
8495
- expiresAt: string;
8496
- /** @constant */
8497
- messageVersion: "v1";
8498
- /** @description Display-ready ACH authorization message */
8499
- message: string;
8500
- summary: {
8501
- /** @enum {string} */
8502
- quoteType: "exact_input" | "exact_output";
8503
- requestedAmountUsd: string;
8504
- /** @enum {string} */
8505
- priority: "normal" | "high";
8506
- feeRateBps: number;
8507
- principalAmountUsd: string;
8508
- expectedAssetAmount: string;
8509
- grossFeeUsd: string;
8510
- feeSubsidyUsd: string;
8511
- userFeeUsd: string;
8512
- totalDebitAmountUsd: string;
8513
- feeSubsidy: {
8514
- percentage: number;
8515
- percentageBps: number;
8516
- maxAmountUsd: string | null;
8517
- appliedAmountUsd: string;
8518
- } | null;
8519
- /** @constant */
8520
- network: "solana";
8521
- /** @constant */
8522
- asset: "USDC";
8523
- assetAddress: string;
8524
- destinationAddress: string;
8525
- };
8526
- };
8527
- };
8528
- };
8529
- /** @description Response for status 401 */
8530
- 401: {
8531
- headers: {
8532
- [name: string]: unknown;
8533
- };
8534
- content: {
8535
- "application/json": {
8536
- /**
8537
- * @description A URI reference that identifies the problem type
8538
- * @default about:blank
8539
- * @example urn:problem-type:auth:unauthorized
8540
- * @example urn:problem-type:auth:token-expired
8541
- */
8542
- type: string;
8543
- /**
8544
- * @description A short, human-readable summary of the problem type
8545
- * @example Unauthorized
8546
- * @example Token Expired
8547
- */
8548
- title: string;
8549
- /**
8550
- * @description The HTTP status code
8551
- * @example 401
8552
- * @example 403
8553
- */
8554
- status: number;
8555
- /**
8556
- * @description A human-readable explanation specific to this occurrence
8557
- * @example Bearer token required
8558
- * @example Invalid token
8559
- */
8560
- detail?: string;
8561
- /** @description A URI reference that identifies the specific occurrence */
8562
- instance?: string;
8563
- /**
8564
- * @description The authentication realm
8565
- * @example API
8566
- */
8567
- realm?: string;
8568
- /**
8569
- * @description The required scope for this resource
8570
- * @example read:users
8571
- * @example write:orders
8572
- */
8573
- scope?: string;
8574
- };
8575
- };
8576
- };
8577
- /** @description Response for status 404 */
8578
- 404: {
8579
- headers: {
8580
- [name: string]: unknown;
8581
- };
8582
- content: {
8583
- "application/json": {
8584
- /**
8585
- * @description A URI reference that identifies the problem type
8586
- * @default about:blank
8587
- */
8588
- type: string;
8589
- /** @description A short, human-readable summary of the problem type */
8590
- title: string;
8591
- /**
8592
- * @description The HTTP status code
8593
- * @example 404
8594
- */
8595
- status: number;
8596
- /** @description A human-readable explanation specific to this occurrence */
8597
- detail?: string;
8598
- /** @description A URI reference that identifies the specific occurrence */
8599
- instance?: string;
8600
- /**
8601
- * @description The type of resource that was not found
8602
- * @example user
8603
- * @example account
8604
- * @example transaction
8605
- */
8606
- resourceType: string;
8607
- /** @description The identifier of the resource that was not found */
8608
- resourceId: string;
8609
- };
8610
- };
8611
- };
8612
- /** @description Response for status 500 */
8613
- 500: {
8614
- headers: {
8615
- [name: string]: unknown;
8616
- };
8617
- content: {
8618
- "application/json": {
8619
- /**
8620
- * @description A URI reference that identifies the problem type
8621
- * @default about:blank
8622
- * @example urn:problem-type:auth:unauthorized
8623
- * @example urn:problem-type:system:internal-error
8624
- */
8625
- type: string;
8626
- /**
8627
- * @description A short, human-readable summary of the problem type
8628
- * @example Unauthorized
8629
- * @example Internal Server Error
8630
- */
8631
- title: string;
8632
- /**
8633
- * @description The HTTP status code
8634
- * @example 400
8635
- * @example 401
8636
- * @example 404
8637
- * @example 500
8638
- */
8639
- status: number;
8640
- /** @description A human-readable explanation specific to this occurrence */
8641
- detail?: string;
8642
- /**
8643
- * @description A URI reference that identifies the specific occurrence
8644
- * @example /errors/1234567890
8645
- */
8646
- instance?: string;
8647
- };
8648
- };
8649
- };
8650
- };
8651
- };
8652
- postV1Deposits: {
8653
- parameters: {
8654
- query?: never;
8655
- header?: never;
8656
- path?: never;
8657
- cookie?: never;
8658
- };
8659
- requestBody: {
8660
- content: {
8661
- "application/json": {
8662
- /**
8663
- * @description Opaque public preparation identifier returned by prepare
8664
- * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8665
- */
8666
- preparationId: string;
8667
- /** @description Ed25519 signature over the exact authorization message text. Base58 is preferred for Solana clients; base64 is also accepted. */
8668
- signature: string;
8669
- clientContext?: {
8670
- clientIp?: string;
8671
- userAgent?: string;
8672
- sessionId?: string;
8673
- deviceId?: string;
8674
- platform?: string;
8675
- appVersion?: string;
8676
- };
8677
- };
8678
- "application/x-www-form-urlencoded": {
8679
- /**
8680
- * @description Opaque public preparation identifier returned by prepare
8681
- * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8682
- */
8683
- preparationId: string;
8684
- /** @description Ed25519 signature over the exact authorization message text. Base58 is preferred for Solana clients; base64 is also accepted. */
8685
- signature: string;
8686
- clientContext?: {
8687
- clientIp?: string;
8688
- userAgent?: string;
8689
- sessionId?: string;
8690
- deviceId?: string;
8691
- platform?: string;
8692
- appVersion?: string;
8693
- };
8694
- };
8695
- "multipart/form-data": {
8696
- /**
8697
- * @description Opaque public preparation identifier returned by prepare
8698
- * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8699
- */
8700
- preparationId: string;
8701
- /** @description Ed25519 signature over the exact authorization message text. Base58 is preferred for Solana clients; base64 is also accepted. */
8702
- signature: string;
8703
- clientContext?: {
8704
- clientIp?: string;
8705
- userAgent?: string;
8706
- sessionId?: string;
8707
- deviceId?: string;
8708
- platform?: string;
8709
- appVersion?: string;
8710
- };
8711
- };
8712
- };
8713
- };
8714
- responses: {
8715
- /** @description An ACH debit deposit authorized by the user and processed asynchronously through debit and crypto release lifecycles. */
8716
- 200: {
8717
- headers: {
8718
- [name: string]: unknown;
8719
- };
8720
- content: {
8721
- "application/json": {
8722
- /**
8723
- * @description Opaque public deposit identifier
8724
- * @example dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8725
- */
8726
- id: string;
8727
- /**
8728
- * @description Opaque public funding source identifier
8729
- * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8730
- */
8731
- sourceId: string;
8732
- /**
8733
- * @description Opaque public deposit destination identifier
8734
- * @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8735
- */
8736
- destinationId: string;
8737
- /** @enum {string} */
8738
- status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
8739
- /** @enum {string} */
8740
- quoteType: "exact_input" | "exact_output";
8741
- /** @enum {string} */
8742
- priority: "normal" | "high";
8743
- feeRateBps: number;
8744
- principalAmountUsd: string;
8745
- expectedAssetAmount: string;
8746
- grossFeeUsd: string;
8747
- feeSubsidyUsd: string;
8748
- userFeeUsd: string;
8749
- totalDebitAmountUsd: string;
8750
- feeSubsidy: {
8751
- percentage: number;
8752
- percentageBps: number;
8753
- maxAmountUsd: string | null;
8754
- appliedAmountUsd: string;
8755
- } | null;
8756
- /**
8757
- * @description Blockchain network for the bound deposit destination
8758
- * @example solana
8759
- * @constant
8760
- */
8761
- network: "solana";
8762
- /**
8763
- * @description Asset sent to the deposit destination
8764
- * @example USDC
8765
- * @constant
8766
- */
8767
- asset: "USDC";
8768
- assetAddress: string;
8769
- /** @description Destination wallet address for the crypto release */
8770
- address: string;
8771
- /** @enum {string} */
8772
- debitStatus: "authorized" | "submitting" | "submitted" | "settled" | "returned" | "failed";
8773
- /** @enum {string} */
8774
- releaseStatus: "not_started" | "queued" | "partial" | "completed" | "failed";
8775
- /** @enum {string} */
8776
- releaseDecisionMode: "after_settlement" | "early_full" | "early_partial";
8777
- releasedAmountUsd: string;
8778
- confirmedReleasedAmountUsd: string;
8779
- exposureAmountUsd: string;
8780
- /** Format: date-time */
8781
- authorizedAt: string;
8782
- /** Format: date-time */
8783
- createdAt: string;
8784
- settledAt: string | null;
8785
- returnedAt: string | null;
8786
- completedAt: string | null;
8787
- returnCode: string | null;
8788
- returnReason: string | null;
8789
- debitFailureCode: string | null;
8790
- debitFailureReason: string | null;
8791
- releaseFailureCode: string | null;
8792
- releaseFailureReason: string | null;
8793
- payoutTxHash: string | null;
8794
- };
8795
- };
8796
- };
8797
- /** @description Response for status 401 */
8798
- 401: {
8799
- headers: {
8800
- [name: string]: unknown;
8801
- };
8802
- content: {
8803
- "application/json": {
8804
- /**
8805
- * @description A URI reference that identifies the problem type
8806
- * @default about:blank
8807
- * @example urn:problem-type:auth:unauthorized
8808
- * @example urn:problem-type:auth:token-expired
8809
- */
8810
- type: string;
8811
- /**
8812
- * @description A short, human-readable summary of the problem type
8813
- * @example Unauthorized
8814
- * @example Token Expired
8815
- */
8816
- title: string;
8817
- /**
8818
- * @description The HTTP status code
8819
- * @example 401
8820
- * @example 403
8821
- */
8822
- status: number;
8823
- /**
8824
- * @description A human-readable explanation specific to this occurrence
8825
- * @example Bearer token required
8826
- * @example Invalid token
8827
- */
8828
- detail?: string;
8829
- /** @description A URI reference that identifies the specific occurrence */
8830
- instance?: string;
8831
- /**
8832
- * @description The authentication realm
8833
- * @example API
8834
- */
8835
- realm?: string;
8836
- /**
8837
- * @description The required scope for this resource
8838
- * @example read:users
8839
- * @example write:orders
8840
- */
8841
- scope?: string;
8842
- };
8843
- };
8844
- };
8845
- /** @description Response for status 404 */
8846
- 404: {
8847
- headers: {
8848
- [name: string]: unknown;
8849
- };
8850
- content: {
8851
- "application/json": {
8852
- /**
8853
- * @description A URI reference that identifies the problem type
8854
- * @default about:blank
8855
- */
8856
- type: string;
8857
- /** @description A short, human-readable summary of the problem type */
8858
- title: string;
8859
- /**
8860
- * @description The HTTP status code
8861
- * @example 404
8862
- */
8863
- status: number;
8864
- /** @description A human-readable explanation specific to this occurrence */
8865
- detail?: string;
8866
- /** @description A URI reference that identifies the specific occurrence */
8867
- instance?: string;
8868
- /**
8869
- * @description The type of resource that was not found
8870
- * @example user
8871
- * @example account
8872
- * @example transaction
8873
- */
8874
- resourceType: string;
8875
- /** @description The identifier of the resource that was not found */
8876
- resourceId: string;
8877
- };
8878
- };
8879
- };
8880
- /** @description Response for status 500 */
8881
- 500: {
8882
- headers: {
8883
- [name: string]: unknown;
8884
- };
8885
- content: {
8886
- "application/json": {
8887
- /**
8888
- * @description A URI reference that identifies the problem type
8889
- * @default about:blank
8890
- * @example urn:problem-type:auth:unauthorized
8891
- * @example urn:problem-type:system:internal-error
8892
- */
8893
- type: string;
8894
- /**
8895
- * @description A short, human-readable summary of the problem type
8896
- * @example Unauthorized
8897
- * @example Internal Server Error
8898
- */
8899
- title: string;
8900
- /**
8901
- * @description The HTTP status code
8902
- * @example 400
8903
- * @example 401
8904
- * @example 404
8905
- * @example 500
8906
- */
8907
- status: number;
8908
- /** @description A human-readable explanation specific to this occurrence */
8909
- detail?: string;
8910
- /**
8911
- * @description A URI reference that identifies the specific occurrence
8912
- * @example /errors/1234567890
8913
- */
8914
- instance?: string;
8915
- };
8916
- };
8917
- };
8918
- };
8919
- };
8920
- postV1DepositsDirectPrepare: {
8921
- parameters: {
8922
- query?: never;
8923
- header?: never;
8924
- path?: never;
8925
- cookie?: never;
8926
- };
8927
- requestBody: {
8928
- content: {
8929
- "application/json": {
8930
- /**
8931
- * @description Opaque public funding source identifier
8932
- * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8933
- */
8934
- sourceId: string;
8935
- /**
8936
- * @description Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source.
8937
- * @example 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY
8938
- */
8939
- address: string;
8940
- /** @constant */
8941
- network: "solana";
8942
- /** @constant */
8943
- asset: "USDC";
8944
- /** @enum {string} */
8945
- quoteType: "exact_input" | "exact_output";
8946
- /**
8947
- * @description Requested USD amount as a decimal string
8948
- * @example 100.00
8949
- */
8950
- amountUsd: string;
8951
- /** @enum {string} */
8952
- priority: "normal" | "high";
8953
- feeSubsidy?: {
8954
- percentage: number;
8955
- maxAmountUsd?: string;
8956
- };
8957
- clientContext?: {
8958
- clientIp?: string;
8959
- userAgent?: string;
8960
- sessionId?: string;
8961
- deviceId?: string;
8962
- platform?: string;
8963
- appVersion?: string;
8964
- };
8965
- };
8966
- "application/x-www-form-urlencoded": {
8967
- /**
8968
- * @description Opaque public funding source identifier
8969
- * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
8970
- */
8971
- sourceId: string;
8972
- /**
8973
- * @description Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source.
8974
- * @example 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY
8975
- */
8976
- address: string;
8977
- /** @constant */
8978
- network: "solana";
8979
- /** @constant */
8980
- asset: "USDC";
8981
- /** @enum {string} */
8982
- quoteType: "exact_input" | "exact_output";
8983
- /**
8984
- * @description Requested USD amount as a decimal string
8985
- * @example 100.00
8986
- */
8987
- amountUsd: string;
8988
- /** @enum {string} */
8989
- priority: "normal" | "high";
8990
- feeSubsidy?: {
8991
- percentage: number;
8992
- maxAmountUsd?: string;
8993
- };
8994
- clientContext?: {
8995
- clientIp?: string;
8996
- userAgent?: string;
8997
- sessionId?: string;
8998
- deviceId?: string;
8999
- platform?: string;
9000
- appVersion?: string;
9001
- };
9002
- };
9003
- "multipart/form-data": {
9004
- /**
9005
- * @description Opaque public funding source identifier
9006
- * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
9007
- */
9008
- sourceId: string;
9009
- /**
9010
- * @description Destination wallet address to deposit into. Validated but not proven via wallet signature; authorization is derived from the verified ACH funding source.
9011
- * @example 9n4nbM75f5Ui33ZbPYXn59EwSb9Y1zdyu3x2b1f8jQRY
9012
- */
9013
- address: string;
9014
- /** @constant */
9015
- network: "solana";
9016
- /** @constant */
9017
- asset: "USDC";
9018
- /** @enum {string} */
9019
- quoteType: "exact_input" | "exact_output";
9020
- /**
9021
- * @description Requested USD amount as a decimal string
9022
- * @example 100.00
9023
- */
9024
- amountUsd: string;
9025
- /** @enum {string} */
9026
- priority: "normal" | "high";
9027
- feeSubsidy?: {
9028
- percentage: number;
9029
- maxAmountUsd?: string;
9030
- };
9031
- clientContext?: {
9032
- clientIp?: string;
9033
- userAgent?: string;
9034
- sessionId?: string;
9035
- deviceId?: string;
9036
- platform?: string;
9037
- appVersion?: string;
9038
- };
9039
- };
9040
- };
9041
- };
9042
- responses: {
9043
- /** @description Response for status 200 */
9044
- 200: {
9045
- headers: {
9046
- [name: string]: unknown;
9047
- };
9048
- content: {
9049
- "application/json": {
9050
- /**
9051
- * @description Opaque public preparation identifier
9052
- * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
9053
- */
9054
- preparationId: string;
9055
- /** @constant */
9056
- kind: "deposit_authorization";
9057
- /** Format: date-time */
9058
- expiresAt: string;
9059
- /** @constant */
9060
- messageVersion: "v1";
9061
- /** @description Display-ready ACH authorization message */
9062
- message: string;
9063
- summary: {
9064
- /** @enum {string} */
9065
- quoteType: "exact_input" | "exact_output";
9066
- requestedAmountUsd: string;
9067
- /** @enum {string} */
9068
- priority: "normal" | "high";
9069
- feeRateBps: number;
9070
- principalAmountUsd: string;
9071
- expectedAssetAmount: string;
9072
- grossFeeUsd: string;
9073
- feeSubsidyUsd: string;
9074
- userFeeUsd: string;
9075
- totalDebitAmountUsd: string;
9076
- feeSubsidy: {
9077
- percentage: number;
9078
- percentageBps: number;
9079
- maxAmountUsd: string | null;
9080
- appliedAmountUsd: string;
9081
- } | null;
9082
- /** @constant */
9083
- network: "solana";
9084
- /** @constant */
9085
- asset: "USDC";
9086
- assetAddress: string;
9087
- destinationAddress: string;
9088
- };
9089
- };
9090
- };
9091
- };
9092
- /** @description Response for status 401 */
9093
- 401: {
9094
- headers: {
9095
- [name: string]: unknown;
9096
- };
9097
- content: {
9098
- "application/json": {
9099
- /**
9100
- * @description A URI reference that identifies the problem type
9101
- * @default about:blank
9102
- * @example urn:problem-type:auth:unauthorized
9103
- * @example urn:problem-type:auth:token-expired
9104
- */
9105
- type: string;
9106
- /**
9107
- * @description A short, human-readable summary of the problem type
9108
- * @example Unauthorized
9109
- * @example Token Expired
9110
- */
9111
- title: string;
9112
- /**
9113
- * @description The HTTP status code
9114
- * @example 401
9115
- * @example 403
9116
- */
9117
- status: number;
9118
- /**
9119
- * @description A human-readable explanation specific to this occurrence
9120
- * @example Bearer token required
9121
- * @example Invalid token
9122
- */
9123
- detail?: string;
9124
- /** @description A URI reference that identifies the specific occurrence */
9125
- instance?: string;
9126
- /**
9127
- * @description The authentication realm
9128
- * @example API
9129
- */
9130
- realm?: string;
9131
- /**
9132
- * @description The required scope for this resource
9133
- * @example read:users
9134
- * @example write:orders
9135
- */
9136
- scope?: string;
9137
- };
9138
- };
9139
- };
9140
- /** @description Response for status 404 */
9141
- 404: {
9142
- headers: {
9143
- [name: string]: unknown;
9144
- };
9145
- content: {
9146
- "application/json": {
9147
- /**
9148
- * @description A URI reference that identifies the problem type
9149
- * @default about:blank
9150
- */
9151
- type: string;
9152
- /** @description A short, human-readable summary of the problem type */
9153
- title: string;
9154
- /**
9155
- * @description The HTTP status code
9156
- * @example 404
9157
- */
9158
- status: number;
9159
- /** @description A human-readable explanation specific to this occurrence */
9160
- detail?: string;
9161
- /** @description A URI reference that identifies the specific occurrence */
9162
- instance?: string;
9163
- /**
9164
- * @description The type of resource that was not found
9165
- * @example user
9166
- * @example account
9167
- * @example transaction
9168
- */
9169
- resourceType: string;
9170
- /** @description The identifier of the resource that was not found */
9171
- resourceId: string;
9172
- };
9173
- };
9174
- };
9175
- /** @description Response for status 500 */
9176
- 500: {
9177
- headers: {
9178
- [name: string]: unknown;
9179
- };
9180
- content: {
9181
- "application/json": {
9182
- /**
9183
- * @description A URI reference that identifies the problem type
9184
- * @default about:blank
9185
- * @example urn:problem-type:auth:unauthorized
9186
- * @example urn:problem-type:system:internal-error
9187
- */
9188
- type: string;
9189
- /**
9190
- * @description A short, human-readable summary of the problem type
9191
- * @example Unauthorized
9192
- * @example Internal Server Error
9193
- */
9194
- title: string;
9195
- /**
9196
- * @description The HTTP status code
9197
- * @example 400
9198
- * @example 401
9199
- * @example 404
9200
- * @example 500
9201
- */
9202
- status: number;
9203
- /** @description A human-readable explanation specific to this occurrence */
9204
- detail?: string;
9205
- /**
9206
- * @description A URI reference that identifies the specific occurrence
9207
- * @example /errors/1234567890
9208
- */
9209
- instance?: string;
9210
- };
9211
- };
9212
- };
9213
- };
9214
- };
9215
- postV1DepositsDirect: {
9216
- parameters: {
9217
- query?: never;
9218
- header?: never;
9219
- path?: never;
9220
- cookie?: never;
9221
- };
9222
- requestBody: {
9223
- content: {
9224
- "application/json": {
9225
- /**
9226
- * @description Opaque public preparation identifier returned by direct prepare
9227
- * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
9228
- */
9229
- preparationId: string;
9230
- clientContext?: {
9231
- clientIp?: string;
9232
- userAgent?: string;
9233
- sessionId?: string;
9234
- deviceId?: string;
9235
- platform?: string;
9236
- appVersion?: string;
9237
- };
7957
+ requestBody: {
7958
+ content: {
7959
+ "application/json": {
7960
+ /**
7961
+ * @description Opaque public preparation identifier returned by direct prepare
7962
+ * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
7963
+ */
7964
+ preparationId: string;
7965
+ clientContext?: {
7966
+ clientIp?: string;
7967
+ userAgent?: string;
7968
+ sessionId?: string;
7969
+ deviceId?: string;
7970
+ platform?: string;
7971
+ appVersion?: string;
7972
+ };
9238
7973
  };
9239
7974
  "application/x-www-form-urlencoded": {
9240
7975
  /**
@@ -9286,11 +8021,6 @@ interface operations {
9286
8021
  * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
9287
8022
  */
9288
8023
  sourceId: string;
9289
- /**
9290
- * @description Opaque public deposit destination identifier
9291
- * @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
9292
- */
9293
- destinationId: string;
9294
8024
  /** @enum {string} */
9295
8025
  status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
9296
8026
  /** @enum {string} */
@@ -9310,12 +8040,8 @@ interface operations {
9310
8040
  maxAmountUsd: string | null;
9311
8041
  appliedAmountUsd: string;
9312
8042
  } | null;
9313
- /**
9314
- * @description Blockchain network for the bound deposit destination
9315
- * @example solana
9316
- * @constant
9317
- */
9318
- network: "solana";
8043
+ /** @enum {string} */
8044
+ network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
9319
8045
  /**
9320
8046
  * @description Asset sent to the deposit destination
9321
8047
  * @example USDC
@@ -9481,7 +8207,34 @@ interface operations {
9481
8207
  path?: never;
9482
8208
  cookie?: never;
9483
8209
  };
9484
- requestBody?: never;
8210
+ requestBody: {
8211
+ content: {
8212
+ "application/json": {
8213
+ /**
8214
+ * @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.
8215
+ * @example https://app.example.com/plaid/oauth-return
8216
+ * @example com.example.app
8217
+ */
8218
+ redirectUri?: string;
8219
+ } | Record<string, never>;
8220
+ "application/x-www-form-urlencoded": {
8221
+ /**
8222
+ * @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.
8223
+ * @example https://app.example.com/plaid/oauth-return
8224
+ * @example com.example.app
8225
+ */
8226
+ redirectUri?: string;
8227
+ } | Record<string, never>;
8228
+ "multipart/form-data": {
8229
+ /**
8230
+ * @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.
8231
+ * @example https://app.example.com/plaid/oauth-return
8232
+ * @example com.example.app
8233
+ */
8234
+ redirectUri?: string;
8235
+ } | Record<string, never>;
8236
+ };
8237
+ };
9485
8238
  responses: {
9486
8239
  /** @description Response for status 200 */
9487
8240
  200: {
@@ -12885,7 +11638,7 @@ interface operations {
12885
11638
  accessToken: string;
12886
11639
  /**
12887
11640
  * @description The internal ID of the authorized user
12888
- * @example 69fcc3849e56476d70fe62a4
11641
+ * @example 6a073b8fc31db9dffe9cd282
12889
11642
  */
12890
11643
  userId: string;
12891
11644
  /**
@@ -12901,7 +11654,7 @@ interface operations {
12901
11654
  /**
12902
11655
  * Format: date-time
12903
11656
  * @description ISO 8601 timestamp when token expires
12904
- * @example 2026-05-07T17:53:24.550Z
11657
+ * @example 2026-05-15T16:28:15.737Z
12905
11658
  */
12906
11659
  expiresAt: string;
12907
11660
  };
@@ -13076,7 +11829,7 @@ interface operations {
13076
11829
  /**
13077
11830
  * Format: date-time
13078
11831
  * @description ISO 8601 timestamp of when the integrator was created
13079
- * @example 2026-05-07T16:53:24.550Z
11832
+ * @example 2026-05-15T15:28:15.737Z
13080
11833
  */
13081
11834
  createdAt: string;
13082
11835
  };
@@ -13247,7 +12000,7 @@ interface operations {
13247
12000
  depositId: string;
13248
12001
  /**
13249
12002
  * @description Spritz user ID associated with the returned deposit
13250
- * @example 69fcc3849e56476d70fe62a3
12003
+ * @example 6a073b8fc31db9dffe9cd281
13251
12004
  */
13252
12005
  userId: string;
13253
12006
  /**
@@ -13435,7 +12188,7 @@ interface operations {
13435
12188
  depositId: string;
13436
12189
  /**
13437
12190
  * @description Spritz user ID associated with the returned deposit
13438
- * @example 69fcc3849e56476d70fe62a3
12191
+ * @example 6a073b8fc31db9dffe9cd281
13439
12192
  */
13440
12193
  userId: string;
13441
12194
  /**
@@ -13604,7 +12357,7 @@ interface operations {
13604
12357
  "application/json": {
13605
12358
  /**
13606
12359
  * @description Unique identifier for the webhook
13607
- * @example 69fcc3849e56476d70fe62a5
12360
+ * @example 6a073b8fc31db9dffe9cd283
13608
12361
  */
13609
12362
  id: string;
13610
12363
  /** @description List of event types this webhook is subscribed to */
@@ -13811,7 +12564,7 @@ interface operations {
13811
12564
  "application/json": {
13812
12565
  /**
13813
12566
  * @description Unique identifier for the webhook
13814
- * @example 69fcc3849e56476d70fe62a5
12567
+ * @example 6a073b8fc31db9dffe9cd283
13815
12568
  */
13816
12569
  id: string;
13817
12570
  /** @description List of event types this webhook is subscribed to */
@@ -14147,7 +12900,7 @@ interface operations {
14147
12900
  "application/json": {
14148
12901
  /**
14149
12902
  * @description Unique identifier for the webhook
14150
- * @example 69fcc3849e56476d70fe62a5
12903
+ * @example 6a073b8fc31db9dffe9cd283
14151
12904
  */
14152
12905
  id: string;
14153
12906
  /** @description List of event types this webhook is subscribed to */
@@ -14522,7 +13275,7 @@ interface operations {
14522
13275
  /**
14523
13276
  * Format: date-time
14524
13277
  * @description ISO 8601 timestamp when the old secret will expire. Only present if a grace period was specified.
14525
- * @example 2026-05-07T16:58:24.550Z
13278
+ * @example 2026-05-15T15:33:15.737Z
14526
13279
  */
14527
13280
  oldSecretExpiresAt?: string;
14528
13281
  };
@@ -14669,7 +13422,7 @@ interface operations {
14669
13422
  "application/json": {
14670
13423
  /**
14671
13424
  * @description Unique identifier for the user
14672
- * @example 69fcc3849e56476d70fe62a1
13425
+ * @example 6a073b8fc31db9dffe9cd27f
14673
13426
  */
14674
13427
  id: string;
14675
13428
  email: (string | null) | null;
@@ -14677,7 +13430,7 @@ interface operations {
14677
13430
  /**
14678
13431
  * Format: date-time
14679
13432
  * @description ISO 8601 timestamp of when the user was created
14680
- * @example 2026-05-07T16:53:24.483Z
13433
+ * @example 2026-05-15T15:28:15.732Z
14681
13434
  */
14682
13435
  signedUpAt: string;
14683
13436
  timezone: (string | null) | null;
@@ -15007,7 +13760,7 @@ interface operations {
15007
13760
  "application/json": {
15008
13761
  /**
15009
13762
  * @description Unique identifier for the user
15010
- * @example 69fcc3849e56476d70fe62a1
13763
+ * @example 6a073b8fc31db9dffe9cd27f
15011
13764
  */
15012
13765
  id: string;
15013
13766
  email: (string | null) | null;
@@ -15015,7 +13768,7 @@ interface operations {
15015
13768
  /**
15016
13769
  * Format: date-time
15017
13770
  * @description ISO 8601 timestamp of when the user was created
15018
- * @example 2026-05-07T16:53:24.483Z
13771
+ * @example 2026-05-15T15:28:15.732Z
15019
13772
  */
15020
13773
  signedUpAt: string;
15021
13774
  timezone: (string | null) | null;
@@ -15417,7 +14170,7 @@ interface operations {
15417
14170
  "application/json": {
15418
14171
  /**
15419
14172
  * @description Unique identifier for the user
15420
- * @example 69fcc3849e56476d70fe62a1
14173
+ * @example 6a073b8fc31db9dffe9cd27f
15421
14174
  */
15422
14175
  id: string;
15423
14176
  email: (string | null) | null;
@@ -15425,7 +14178,7 @@ interface operations {
15425
14178
  /**
15426
14179
  * Format: date-time
15427
14180
  * @description ISO 8601 timestamp of when the user was created
15428
- * @example 2026-05-07T16:53:24.483Z
14181
+ * @example 2026-05-15T15:28:15.732Z
15429
14182
  */
15430
14183
  signedUpAt: string;
15431
14184
  timezone: (string | null) | null;
@@ -22022,135 +20775,9 @@ interface operations {
22022
20775
  scope?: string;
22023
20776
  };
22024
20777
  };
22025
- };
22026
- /** @description Response for status 500 */
22027
- 500: {
22028
- headers: {
22029
- [name: string]: unknown;
22030
- };
22031
- content: {
22032
- "application/json": {
22033
- /**
22034
- * @description A URI reference that identifies the problem type
22035
- * @default about:blank
22036
- * @example urn:problem-type:auth:unauthorized
22037
- * @example urn:problem-type:system:internal-error
22038
- */
22039
- type: string;
22040
- /**
22041
- * @description A short, human-readable summary of the problem type
22042
- * @example Unauthorized
22043
- * @example Internal Server Error
22044
- */
22045
- title: string;
22046
- /**
22047
- * @description The HTTP status code
22048
- * @example 400
22049
- * @example 401
22050
- * @example 404
22051
- * @example 500
22052
- */
22053
- status: number;
22054
- /** @description A human-readable explanation specific to this occurrence */
22055
- detail?: string;
22056
- /**
22057
- * @description A URI reference that identifies the specific occurrence
22058
- * @example /errors/1234567890
22059
- */
22060
- instance?: string;
22061
- };
22062
- };
22063
- };
22064
- /** @description Response for status 502 */
22065
- 502: {
22066
- headers: {
22067
- [name: string]: unknown;
22068
- };
22069
- content: {
22070
- "application/json": {
22071
- /**
22072
- * @description A URI reference that identifies the problem type
22073
- * @default about:blank
22074
- * @example urn:problem-type:auth:unauthorized
22075
- * @example urn:problem-type:system:internal-error
22076
- */
22077
- type: string;
22078
- /**
22079
- * @description A short, human-readable summary of the problem type
22080
- * @example Unauthorized
22081
- * @example Internal Server Error
22082
- */
22083
- title: string;
22084
- /**
22085
- * @description The HTTP status code
22086
- * @example 400
22087
- * @example 401
22088
- * @example 404
22089
- * @example 500
22090
- */
22091
- status: number;
22092
- /** @description A human-readable explanation specific to this occurrence */
22093
- detail?: string;
22094
- /**
22095
- * @description A URI reference that identifies the specific occurrence
22096
- * @example /errors/1234567890
22097
- */
22098
- instance?: string;
22099
- };
22100
- };
22101
- };
22102
- };
22103
- };
22104
- "postV1SandboxBypass-kyc": {
22105
- parameters: {
22106
- query?: never;
22107
- header?: never;
22108
- path?: never;
22109
- cookie?: never;
22110
- };
22111
- requestBody: {
22112
- content: {
22113
- "application/json": {
22114
- /**
22115
- * @description Country code to simulate successful KYC for
22116
- * @example US
22117
- */
22118
- country?: string;
22119
- /** @description Set to true to simulate a failed KYC check */
22120
- failed?: boolean;
22121
- };
22122
- "application/x-www-form-urlencoded": {
22123
- /**
22124
- * @description Country code to simulate successful KYC for
22125
- * @example US
22126
- */
22127
- country?: string;
22128
- /** @description Set to true to simulate a failed KYC check */
22129
- failed?: boolean;
22130
- };
22131
- "multipart/form-data": {
22132
- /**
22133
- * @description Country code to simulate successful KYC for
22134
- * @example US
22135
- */
22136
- country?: string;
22137
- /** @description Set to true to simulate a failed KYC check */
22138
- failed?: boolean;
22139
- };
22140
- };
22141
- };
22142
- responses: {
22143
- /** @description The resulting verification document */
22144
- 200: {
22145
- headers: {
22146
- [name: string]: unknown;
22147
- };
22148
- content: {
22149
- "application/json": unknown;
22150
- };
22151
- };
22152
- /** @description Response for status 401 */
22153
- 401: {
20778
+ };
20779
+ /** @description Response for status 500 */
20780
+ 500: {
22154
20781
  headers: {
22155
20782
  [name: string]: unknown;
22156
20783
  };
@@ -22160,45 +20787,35 @@ interface operations {
22160
20787
  * @description A URI reference that identifies the problem type
22161
20788
  * @default about:blank
22162
20789
  * @example urn:problem-type:auth:unauthorized
22163
- * @example urn:problem-type:auth:token-expired
20790
+ * @example urn:problem-type:system:internal-error
22164
20791
  */
22165
20792
  type: string;
22166
20793
  /**
22167
20794
  * @description A short, human-readable summary of the problem type
22168
20795
  * @example Unauthorized
22169
- * @example Token Expired
20796
+ * @example Internal Server Error
22170
20797
  */
22171
20798
  title: string;
22172
20799
  /**
22173
20800
  * @description The HTTP status code
20801
+ * @example 400
22174
20802
  * @example 401
22175
- * @example 403
20803
+ * @example 404
20804
+ * @example 500
22176
20805
  */
22177
20806
  status: number;
22178
- /**
22179
- * @description A human-readable explanation specific to this occurrence
22180
- * @example Bearer token required
22181
- * @example Invalid token
22182
- */
20807
+ /** @description A human-readable explanation specific to this occurrence */
22183
20808
  detail?: string;
22184
- /** @description A URI reference that identifies the specific occurrence */
22185
- instance?: string;
22186
- /**
22187
- * @description The authentication realm
22188
- * @example API
22189
- */
22190
- realm?: string;
22191
20809
  /**
22192
- * @description The required scope for this resource
22193
- * @example read:users
22194
- * @example write:orders
20810
+ * @description A URI reference that identifies the specific occurrence
20811
+ * @example /errors/1234567890
22195
20812
  */
22196
- scope?: string;
20813
+ instance?: string;
22197
20814
  };
22198
20815
  };
22199
20816
  };
22200
- /** @description Response for status 500 */
22201
- 500: {
20817
+ /** @description Response for status 502 */
20818
+ 502: {
22202
20819
  headers: {
22203
20820
  [name: string]: unknown;
22204
20821
  };
@@ -22237,7 +20854,7 @@ interface operations {
22237
20854
  };
22238
20855
  };
22239
20856
  };
22240
- postV1SandboxDeposits: {
20857
+ "postV1SandboxBypass-kyc": {
22241
20858
  parameters: {
22242
20859
  query?: never;
22243
20860
  header?: never;
@@ -22248,159 +20865,41 @@ interface operations {
22248
20865
  content: {
22249
20866
  "application/json": {
22250
20867
  /**
22251
- * @description Opaque public preparation identifier returned by prepare
22252
- * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
20868
+ * @description Country code to simulate successful KYC for
20869
+ * @example US
22253
20870
  */
22254
- preparationId: string;
22255
- /** @description Ed25519 signature over the exact authorization message text. Base58 is preferred for Solana clients; base64 is also accepted. */
22256
- signature: string;
22257
- clientContext?: {
22258
- clientIp?: string;
22259
- userAgent?: string;
22260
- sessionId?: string;
22261
- deviceId?: string;
22262
- platform?: string;
22263
- appVersion?: string;
22264
- };
22265
- returnSimulation: {
22266
- /**
22267
- * @description Sandbox-only ACH return code to simulate through the Modern Treasury provider path
22268
- * @example R10
22269
- */
22270
- code: string;
22271
- };
20871
+ country?: string;
20872
+ /** @description Set to true to simulate a failed KYC check */
20873
+ failed?: boolean;
22272
20874
  };
22273
20875
  "application/x-www-form-urlencoded": {
22274
20876
  /**
22275
- * @description Opaque public preparation identifier returned by prepare
22276
- * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
20877
+ * @description Country code to simulate successful KYC for
20878
+ * @example US
22277
20879
  */
22278
- preparationId: string;
22279
- /** @description Ed25519 signature over the exact authorization message text. Base58 is preferred for Solana clients; base64 is also accepted. */
22280
- signature: string;
22281
- clientContext?: {
22282
- clientIp?: string;
22283
- userAgent?: string;
22284
- sessionId?: string;
22285
- deviceId?: string;
22286
- platform?: string;
22287
- appVersion?: string;
22288
- };
22289
- returnSimulation: {
22290
- /**
22291
- * @description Sandbox-only ACH return code to simulate through the Modern Treasury provider path
22292
- * @example R10
22293
- */
22294
- code: string;
22295
- };
20880
+ country?: string;
20881
+ /** @description Set to true to simulate a failed KYC check */
20882
+ failed?: boolean;
22296
20883
  };
22297
20884
  "multipart/form-data": {
22298
20885
  /**
22299
- * @description Opaque public preparation identifier returned by prepare
22300
- * @example prep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
20886
+ * @description Country code to simulate successful KYC for
20887
+ * @example US
22301
20888
  */
22302
- preparationId: string;
22303
- /** @description Ed25519 signature over the exact authorization message text. Base58 is preferred for Solana clients; base64 is also accepted. */
22304
- signature: string;
22305
- clientContext?: {
22306
- clientIp?: string;
22307
- userAgent?: string;
22308
- sessionId?: string;
22309
- deviceId?: string;
22310
- platform?: string;
22311
- appVersion?: string;
22312
- };
22313
- returnSimulation: {
22314
- /**
22315
- * @description Sandbox-only ACH return code to simulate through the Modern Treasury provider path
22316
- * @example R10
22317
- */
22318
- code: string;
22319
- };
20889
+ country?: string;
20890
+ /** @description Set to true to simulate a failed KYC check */
20891
+ failed?: boolean;
22320
20892
  };
22321
20893
  };
22322
20894
  };
22323
20895
  responses: {
22324
- /** @description An ACH debit deposit authorized by the user and processed asynchronously through debit and crypto release lifecycles. */
20896
+ /** @description The resulting verification document */
22325
20897
  200: {
22326
20898
  headers: {
22327
20899
  [name: string]: unknown;
22328
20900
  };
22329
20901
  content: {
22330
- "application/json": {
22331
- /**
22332
- * @description Opaque public deposit identifier
22333
- * @example dep_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
22334
- */
22335
- id: string;
22336
- /**
22337
- * @description Opaque public funding source identifier
22338
- * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
22339
- */
22340
- sourceId: string;
22341
- /**
22342
- * @description Opaque public deposit destination identifier
22343
- * @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
22344
- */
22345
- destinationId: string;
22346
- /** @enum {string} */
22347
- status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
22348
- /** @enum {string} */
22349
- quoteType: "exact_input" | "exact_output";
22350
- /** @enum {string} */
22351
- priority: "normal" | "high";
22352
- feeRateBps: number;
22353
- principalAmountUsd: string;
22354
- expectedAssetAmount: string;
22355
- grossFeeUsd: string;
22356
- feeSubsidyUsd: string;
22357
- userFeeUsd: string;
22358
- totalDebitAmountUsd: string;
22359
- feeSubsidy: {
22360
- percentage: number;
22361
- percentageBps: number;
22362
- maxAmountUsd: string | null;
22363
- appliedAmountUsd: string;
22364
- } | null;
22365
- /**
22366
- * @description Blockchain network for the bound deposit destination
22367
- * @example solana
22368
- * @constant
22369
- */
22370
- network: "solana";
22371
- /**
22372
- * @description Asset sent to the deposit destination
22373
- * @example USDC
22374
- * @constant
22375
- */
22376
- asset: "USDC";
22377
- assetAddress: string;
22378
- /** @description Destination wallet address for the crypto release */
22379
- address: string;
22380
- /** @enum {string} */
22381
- debitStatus: "authorized" | "submitting" | "submitted" | "settled" | "returned" | "failed";
22382
- /** @enum {string} */
22383
- releaseStatus: "not_started" | "queued" | "partial" | "completed" | "failed";
22384
- /** @enum {string} */
22385
- releaseDecisionMode: "after_settlement" | "early_full" | "early_partial";
22386
- releasedAmountUsd: string;
22387
- confirmedReleasedAmountUsd: string;
22388
- exposureAmountUsd: string;
22389
- /** Format: date-time */
22390
- authorizedAt: string;
22391
- /** Format: date-time */
22392
- createdAt: string;
22393
- settledAt: string | null;
22394
- returnedAt: string | null;
22395
- completedAt: string | null;
22396
- returnCode: string | null;
22397
- returnReason: string | null;
22398
- debitFailureCode: string | null;
22399
- debitFailureReason: string | null;
22400
- releaseFailureCode: string | null;
22401
- releaseFailureReason: string | null;
22402
- payoutTxHash: string | null;
22403
- };
20902
+ "application/json": unknown;
22404
20903
  };
22405
20904
  };
22406
20905
  /** @description Response for status 401 */
@@ -22451,79 +20950,6 @@ interface operations {
22451
20950
  };
22452
20951
  };
22453
20952
  };
22454
- /** @description Response for status 403 */
22455
- 403: {
22456
- headers: {
22457
- [name: string]: unknown;
22458
- };
22459
- content: {
22460
- "application/json": {
22461
- /**
22462
- * @description A URI reference that identifies the problem type
22463
- * @default about:blank
22464
- * @example urn:problem-type:auth:unauthorized
22465
- * @example urn:problem-type:system:internal-error
22466
- */
22467
- type: string;
22468
- /**
22469
- * @description A short, human-readable summary of the problem type
22470
- * @example Unauthorized
22471
- * @example Internal Server Error
22472
- */
22473
- title: string;
22474
- /**
22475
- * @description The HTTP status code
22476
- * @example 400
22477
- * @example 401
22478
- * @example 404
22479
- * @example 500
22480
- */
22481
- status: number;
22482
- /** @description A human-readable explanation specific to this occurrence */
22483
- detail?: string;
22484
- /**
22485
- * @description A URI reference that identifies the specific occurrence
22486
- * @example /errors/1234567890
22487
- */
22488
- instance?: string;
22489
- };
22490
- };
22491
- };
22492
- /** @description Response for status 404 */
22493
- 404: {
22494
- headers: {
22495
- [name: string]: unknown;
22496
- };
22497
- content: {
22498
- "application/json": {
22499
- /**
22500
- * @description A URI reference that identifies the problem type
22501
- * @default about:blank
22502
- */
22503
- type: string;
22504
- /** @description A short, human-readable summary of the problem type */
22505
- title: string;
22506
- /**
22507
- * @description The HTTP status code
22508
- * @example 404
22509
- */
22510
- status: number;
22511
- /** @description A human-readable explanation specific to this occurrence */
22512
- detail?: string;
22513
- /** @description A URI reference that identifies the specific occurrence */
22514
- instance?: string;
22515
- /**
22516
- * @description The type of resource that was not found
22517
- * @example user
22518
- * @example account
22519
- * @example transaction
22520
- */
22521
- resourceType: string;
22522
- /** @description The identifier of the resource that was not found */
22523
- resourceId: string;
22524
- };
22525
- };
22526
- };
22527
20953
  /** @description Response for status 500 */
22528
20954
  500: {
22529
20955
  headers: {
@@ -22659,11 +21085,6 @@ interface operations {
22659
21085
  * @example fs_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
22660
21086
  */
22661
21087
  sourceId: string;
22662
- /**
22663
- * @description Opaque public deposit destination identifier
22664
- * @example dd_01JV7Q8M4Y8K6N2Z5P3R1T9W0X
22665
- */
22666
- destinationId: string;
22667
21088
  /** @enum {string} */
22668
21089
  status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
22669
21090
  /** @enum {string} */
@@ -22683,12 +21104,8 @@ interface operations {
22683
21104
  maxAmountUsd: string | null;
22684
21105
  appliedAmountUsd: string;
22685
21106
  } | null;
22686
- /**
22687
- * @description Blockchain network for the bound deposit destination
22688
- * @example solana
22689
- * @constant
22690
- */
22691
- network: "solana";
21107
+ /** @enum {string} */
21108
+ network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
22692
21109
  /**
22693
21110
  * @description Asset sent to the deposit destination
22694
21111
  * @example USDC
@@ -23579,6 +21996,7 @@ type CreateBankAccountInput = PathRequestBody<'/v1/bank-accounts/', 'post'>;
23579
21996
  type CreateBankAccountResponse = PathResponse<'/v1/bank-accounts/', 'post'>;
23580
21997
  type DeleteBankAccountResponse = PathResponse<'/v1/bank-accounts/{accountId}', 'delete'>;
23581
21998
  type LinkTokenResponse = PathResponse<'/v1/bank-accounts/link-token', 'post'>;
21999
+ type CreateLinkTokenRequest = PathRequestBody<'/v1/bank-accounts/link-token', 'post'>;
23582
22000
  type CompleteLinkingRequest = PathRequestBody<'/v1/bank-accounts/link-complete', 'post'>;
23583
22001
  type CompleteLinkingResponse = PathResponse<'/v1/bank-accounts/link-complete', 'post'>;
23584
22002
  declare class BankAccountService {
@@ -23792,7 +22210,7 @@ declare class BankAccountService {
23792
22210
  id: string;
23793
22211
  deleted: true;
23794
22212
  }>;
23795
- createLinkToken(): Promise<{
22213
+ createLinkToken(input?: CreateLinkTokenRequest): Promise<{
23796
22214
  linkToken: string;
23797
22215
  hostedLinkUrl: string | null;
23798
22216
  expiration: string;
@@ -25378,7 +23796,7 @@ declare class DepositService {
25378
23796
  maxAmountUsd: string | null;
25379
23797
  appliedAmountUsd: string;
25380
23798
  } | null;
25381
- network: "solana";
23799
+ network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
25382
23800
  asset: "USDC";
25383
23801
  assetAddress: string;
25384
23802
  destinationAddress: string;
@@ -25387,7 +23805,6 @@ declare class DepositService {
25387
23805
  create(input: CreateDepositRequest): Promise<{
25388
23806
  id: string;
25389
23807
  sourceId: string;
25390
- destinationId: string;
25391
23808
  status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
25392
23809
  quoteType: "exact_input" | "exact_output";
25393
23810
  priority: "normal" | "high";
@@ -25404,7 +23821,7 @@ declare class DepositService {
25404
23821
  maxAmountUsd: string | null;
25405
23822
  appliedAmountUsd: string;
25406
23823
  } | null;
25407
- network: "solana";
23824
+ network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
25408
23825
  asset: "USDC";
25409
23826
  assetAddress: string;
25410
23827
  address: string;
@@ -25438,6 +23855,11 @@ declare class FundingSourceService {
25438
23855
  id: string;
25439
23856
  bankAccountId: string;
25440
23857
  institutionName: string | null;
23858
+ institution: {
23859
+ name: string;
23860
+ logoUrl: string | null;
23861
+ primaryColor: string | null;
23862
+ } | null;
25441
23863
  accountNumberLast4: string | null;
25442
23864
  accountType: "checking" | "savings" | "business" | "unknown";
25443
23865
  status: "pending" | "active" | "review_required" | "ineligible" | "disabled";
@@ -25449,6 +23871,11 @@ declare class FundingSourceService {
25449
23871
  id: string;
25450
23872
  bankAccountId: string;
25451
23873
  institutionName: string | null;
23874
+ institution: {
23875
+ name: string;
23876
+ logoUrl: string | null;
23877
+ primaryColor: string | null;
23878
+ } | null;
25452
23879
  accountNumberLast4: string | null;
25453
23880
  accountType: "checking" | "savings" | "business" | "unknown";
25454
23881
  status: "pending" | "active" | "review_required" | "ineligible" | "disabled";
@@ -25496,7 +23923,6 @@ declare class SandboxService {
25496
23923
  createDepositWithReturn(input: CreateDepositWithReturnRequest): Promise<{
25497
23924
  id: string;
25498
23925
  sourceId: string;
25499
- destinationId: string;
25500
23926
  status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "failed";
25501
23927
  quoteType: "exact_input" | "exact_output";
25502
23928
  priority: "normal" | "high";
@@ -25513,7 +23939,7 @@ declare class SandboxService {
25513
23939
  maxAmountUsd: string | null;
25514
23940
  appliedAmountUsd: string;
25515
23941
  } | null;
25516
- network: "solana";
23942
+ network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
25517
23943
  asset: "USDC";
25518
23944
  assetAddress: string;
25519
23945
  address: string;