@spritz-finance/api-client 0.18.2 → 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -24310,6 +24310,14 @@ interface operations {
24310
24310
  * @enum {string|null}
24311
24311
  */
24312
24312
  failureReason: "verify_sms" | "documentary_verification" | "risk_check" | "kyc_check" | "address_invalid" | "selfie_check" | "watchlist_screening" | "vpn_detected" | "duplicate_identity" | null;
24313
+ /** @description Set only when failureReason is duplicate_identity and the matched account belongs to the same integrator and matched the user on government ID number, full name and date of birth; null otherwise, including duplicates matched on fewer of those or only on phone or address, and matches under another integrator. */
24314
+ duplicateIdentity: {
24315
+ /**
24316
+ * @description Masked email of the matched account, lowercased. Before any `+` tag, shows the first two and last two characters from 8 characters, the first and last from 5, otherwise the first only, with a fixed `****` between. A `+` tag and the domain are shown in full. The raw email is never returned.
24317
+ * @example ja****oe@gmail.com
24318
+ */
24319
+ maskedEmail: string;
24320
+ } | null;
24313
24321
  /**
24314
24322
  * @description ISO 3166-1 alpha-2 country code where user was verified
24315
24323
  * @example US
@@ -24700,6 +24708,14 @@ interface operations {
24700
24708
  * @enum {string|null}
24701
24709
  */
24702
24710
  failureReason: "verify_sms" | "documentary_verification" | "risk_check" | "kyc_check" | "address_invalid" | "selfie_check" | "watchlist_screening" | "vpn_detected" | "duplicate_identity" | null;
24711
+ /** @description Set only when failureReason is duplicate_identity and the matched account belongs to the same integrator and matched the user on government ID number, full name and date of birth; null otherwise, including duplicates matched on fewer of those or only on phone or address, and matches under another integrator. */
24712
+ duplicateIdentity: {
24713
+ /**
24714
+ * @description Masked email of the matched account, lowercased. Before any `+` tag, shows the first two and last two characters from 8 characters, the first and last from 5, otherwise the first only, with a fixed `****` between. A `+` tag and the domain are shown in full. The raw email is never returned.
24715
+ * @example ja****oe@gmail.com
24716
+ */
24717
+ maskedEmail: string;
24718
+ } | null;
24703
24719
  /**
24704
24720
  * @description ISO 3166-1 alpha-2 country code where user was verified
24705
24721
  * @example US
@@ -25189,6 +25205,14 @@ interface operations {
25189
25205
  * @enum {string|null}
25190
25206
  */
25191
25207
  failureReason: "verify_sms" | "documentary_verification" | "risk_check" | "kyc_check" | "address_invalid" | "selfie_check" | "watchlist_screening" | "vpn_detected" | "duplicate_identity" | null;
25208
+ /** @description Set only when failureReason is duplicate_identity and the matched account belongs to the same integrator and matched the user on government ID number, full name and date of birth; null otherwise, including duplicates matched on fewer of those or only on phone or address, and matches under another integrator. */
25209
+ duplicateIdentity: {
25210
+ /**
25211
+ * @description Masked email of the matched account, lowercased. Before any `+` tag, shows the first two and last two characters from 8 characters, the first and last from 5, otherwise the first only, with a fixed `****` between. A `+` tag and the domain are shown in full. The raw email is never returned.
25212
+ * @example ja****oe@gmail.com
25213
+ */
25214
+ maskedEmail: string;
25215
+ } | null;
25192
25216
  /**
25193
25217
  * @description ISO 3166-1 alpha-2 country code where user was verified
25194
25218
  * @example US
@@ -41887,6 +41911,49 @@ declare class BillService {
41887
41911
  add(institutionId: string, accountNumber: string, type?: BillType): Promise<CreateUSBill_addUSBill>;
41888
41912
  }
41889
41913
 
41914
+ type ComplianceRequirements = PathResponse<'/v1/users/me/compliance/requirements', 'get'>;
41915
+ type ComplianceRequirementField = ComplianceRequirements['fields'][number];
41916
+ type SubmitComplianceRequest = PathRequestBody<'/v1/users/me/compliance', 'post'>;
41917
+ type SubmitComplianceResponse = PathResponse<'/v1/users/me/compliance', 'post'>;
41918
+ declare class ComplianceService {
41919
+ private client;
41920
+ constructor(client: SpritzClient);
41921
+ /**
41922
+ * Fetch the additional compliance fields the authenticated user's region requires
41923
+ * (`GET /v1/users/me/compliance/requirements`).
41924
+ *
41925
+ * Users outside a regulated region get `required: false` with an empty `fields`
41926
+ * array. While `complete` is false, capabilities for the region are gated behind a
41927
+ * `regional_compliance` requirement on `user.getMe()`.
41928
+ */
41929
+ getRequirements(): Promise<{
41930
+ required: boolean;
41931
+ region: string | null;
41932
+ complete: boolean;
41933
+ deadline: string | null;
41934
+ fields: {
41935
+ field: string;
41936
+ status: "complete" | "missing";
41937
+ }[];
41938
+ }>;
41939
+ /**
41940
+ * Submit the regional compliance fields (`POST /v1/users/me/compliance`).
41941
+ *
41942
+ * All required fields must be supplied together: a partial submission is rejected
41943
+ * with field-level errors on `error.problem.errors` rather than being stored.
41944
+ * `placeOfBirth.country` and `nationalities` are ISO 3166-1 alpha-3 codes, and
41945
+ * `accountPurposeOther` is required when `accountPurpose` is `'other'`.
41946
+ *
41947
+ * `bridgeCustomerUpdated` is false when the user has not accepted the provider's
41948
+ * terms yet. The fields are stored and included when the customer is created, so
41949
+ * this is not a failure.
41950
+ */
41951
+ submit(input: SubmitComplianceRequest): Promise<{
41952
+ complianceFieldsComplete: boolean;
41953
+ bridgeCustomerUpdated: boolean;
41954
+ }>;
41955
+ }
41956
+
41890
41957
  interface CreateDebitCard_createDebitCard {
41891
41958
  __typename: 'DebitCard';
41892
41959
  id: string;
@@ -42259,6 +42326,8 @@ type SetAchDebitExposureCapResponse = PathResponse<'/v1/sandbox/ach-debit/exposu
42259
42326
  type LinkBankAccountRequest = PathRequestBody<'/v1/sandbox/bank-accounts/link', 'post'>;
42260
42327
  type LinkBankAccountResponse = PathResponse<'/v1/sandbox/bank-accounts/link', 'post'>;
42261
42328
  type DeleteFundingSourceResponse = PathResponse<'/v1/sandbox/funding-sources/{fundingSourceId}', 'delete'>;
42329
+ type SimulateAutoRampDepositRequest = PathRequestBody<'/v1/sandbox/auto-ramp-accounts/{id}/deposit', 'post'>;
42330
+ type SimulateAutoRampDepositResponse = PathResponse<'/v1/sandbox/auto-ramp-accounts/{id}/deposit', 'post'>;
42262
42331
  declare class SandboxService {
42263
42332
  private client;
42264
42333
  constructor(client: SpritzClient);
@@ -42481,6 +42550,42 @@ declare class SandboxService {
42481
42550
  id: string;
42482
42551
  deleted: true;
42483
42552
  }>;
42553
+ /**
42554
+ * Simulate a fiat deposit arriving in an auto-ramp account and settling to crypto
42555
+ * (`POST /v1/sandbox/auto-ramp-accounts/{id}/deposit`). This is the only way to make
42556
+ * an auto-ramp account settle in sandbox. The on-ramp it produces is an ordinary one:
42557
+ * follow `onRampId` with `onrampPayment.get()`.
42558
+ *
42559
+ * `amount` is in the account's own currency. Pass `settle: false` to leave the
42560
+ * deposit at `processing`, then pass the returned `depositId` back to advance that
42561
+ * same on-ramp. `gasFee` sets the network fee the provider reports (defaults to
42562
+ * `0.00`); `exchangeFee` sets the conversion fee, which is otherwise derived from the
42563
+ * provider's live bid/ask spread. Set both for a predictable fee breakdown.
42564
+ *
42565
+ * Only available in sandbox environments — returns 403 in production.
42566
+ */
42567
+ simulateAutoRampDeposit(accountId: string, input: SimulateAutoRampDepositRequest): Promise<{
42568
+ onRampId: string;
42569
+ depositId: string;
42570
+ status: "awaiting_payment" | "processing" | "partially_delivered" | "completed" | "cancelled" | "failed" | "reversed" | "refunded" | "in_review";
42571
+ input: {
42572
+ amount: string;
42573
+ currency: string;
42574
+ };
42575
+ fees: {
42576
+ total: string;
42577
+ currency: string;
42578
+ breakdown: {
42579
+ platform: string;
42580
+ exchange: string;
42581
+ network: string;
42582
+ };
42583
+ };
42584
+ output: {
42585
+ amount: string;
42586
+ token: string;
42587
+ };
42588
+ }>;
42484
42589
  }
42485
42590
 
42486
42591
  type OffRampRefundRequest = PathRequestBody<'/v1/off-ramps/{offRampId}/refund', 'post'>;
@@ -42527,6 +42632,205 @@ declare class OfframpService {
42527
42632
  }>;
42528
42633
  }
42529
42634
 
42635
+ type CreateOffRampQuoteRequest = PathRequestBody<'/v1/off-ramp-quotes/', 'post'>;
42636
+ type OffRampQuote = PathResponse<'/v1/off-ramp-quotes/', 'post'>;
42637
+ type OffRampQuoteTransactionRequest = PathRequestBody<'/v1/off-ramp-quotes/{quoteId}/transaction', 'post'>;
42638
+ type OffRampQuoteTransaction = PathResponse<'/v1/off-ramp-quotes/{quoteId}/transaction', 'post'>;
42639
+ type SubmitOffRampQuoteRequest = PathRequestBody<'/v1/off-ramp-quotes/{quoteId}/submit', 'post'>;
42640
+ declare class OffRampQuoteService {
42641
+ private client;
42642
+ constructor(client: SpritzClient);
42643
+ /**
42644
+ * Create a quote to convert crypto to fiat (`POST /v1/off-ramp-quotes/`).
42645
+ *
42646
+ * Check `fulfillment` on the response for the next step: `sign_transaction` means
42647
+ * call `getTransaction`, sign and broadcast; `send_to_address` means send exactly
42648
+ * `sendTo.amount` to `sendTo.address` before `sendTo.expiresAt`.
42649
+ *
42650
+ * `amountMode` defaults to `output`, which fixes the destination fiat amount. EUR
42651
+ * destinations require `input`: `amount` is then the exact USD value collected and
42652
+ * `output.amount` is an estimate (`output.estimated` is `true`).
42653
+ *
42654
+ * `tokenAddress` is optional in the type but required on every chain except
42655
+ * Bitcoin and Dash; a request without it is rejected with a 400.
42656
+ *
42657
+ * **This endpoint does not support an idempotency key.** A retry creates a second
42658
+ * quote. A quote that is never funded ends as `expired`.
42659
+ */
42660
+ create(input: CreateOffRampQuoteRequest): Promise<{
42661
+ id: string;
42662
+ fulfillment: "sign_transaction" | "send_to_address";
42663
+ status: "created" | "transaction_pending" | "transaction_failed" | "insufficient_funds" | "confirmed" | "completed" | "expired" | "failed" | "refunded";
42664
+ createdAt: string;
42665
+ input: {
42666
+ amount: string;
42667
+ currency: "USD";
42668
+ tokenAddress: string;
42669
+ chain: "ethereum" | "polygon" | "arbitrum" | "base" | "optimism" | "avalanche" | "binance-smart-chain" | "solana" | "bitcoin" | "dash" | "tron" | "sui" | "hyperevm" | "monad" | "sonic" | "unichain";
42670
+ };
42671
+ output: {
42672
+ amount: string;
42673
+ currency: string;
42674
+ rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
42675
+ accountId: string;
42676
+ estimated: boolean;
42677
+ exchangeRate: {
42678
+ baseCurrency: "USD";
42679
+ quoteCurrency: string;
42680
+ rate: string;
42681
+ } | null;
42682
+ };
42683
+ fees: {
42684
+ amount: string;
42685
+ currency: "USD";
42686
+ };
42687
+ sendTo: {
42688
+ address: string;
42689
+ amount: string;
42690
+ token: string;
42691
+ expiresAt: string;
42692
+ } | null;
42693
+ confirmation: {
42694
+ transactionHash: string;
42695
+ explorerUrl: string;
42696
+ } | null;
42697
+ offRampId: string | null;
42698
+ }>;
42699
+ get(quoteId: string): Promise<{
42700
+ id: string;
42701
+ fulfillment: "sign_transaction" | "send_to_address";
42702
+ status: "created" | "transaction_pending" | "transaction_failed" | "insufficient_funds" | "confirmed" | "completed" | "expired" | "failed" | "refunded";
42703
+ createdAt: string;
42704
+ input: {
42705
+ amount: string;
42706
+ currency: "USD";
42707
+ tokenAddress: string;
42708
+ chain: "ethereum" | "polygon" | "arbitrum" | "base" | "optimism" | "avalanche" | "binance-smart-chain" | "solana" | "bitcoin" | "dash" | "tron" | "sui" | "hyperevm" | "monad" | "sonic" | "unichain";
42709
+ };
42710
+ output: {
42711
+ amount: string;
42712
+ currency: string;
42713
+ rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
42714
+ accountId: string;
42715
+ estimated: boolean;
42716
+ exchangeRate: {
42717
+ baseCurrency: "USD";
42718
+ quoteCurrency: string;
42719
+ rate: string;
42720
+ } | null;
42721
+ };
42722
+ fees: {
42723
+ amount: string;
42724
+ currency: "USD";
42725
+ };
42726
+ sendTo: {
42727
+ address: string;
42728
+ amount: string;
42729
+ token: string;
42730
+ expiresAt: string;
42731
+ } | null;
42732
+ confirmation: {
42733
+ transactionHash: string;
42734
+ explorerUrl: string;
42735
+ } | null;
42736
+ offRampId: string | null;
42737
+ }>;
42738
+ /**
42739
+ * Get the transaction to sign for a `sign_transaction` quote
42740
+ * (`POST /v1/off-ramp-quotes/{quoteId}/transaction`).
42741
+ *
42742
+ * Branch on `type`: `evm` returns `contractAddress`, `calldata` and `value` to build the
42743
+ * transaction; `solana` and `sui` return a base64 `transactionSerialized` to sign as-is.
42744
+ * Nothing is stored: it only prepares the transaction.
42745
+ *
42746
+ * Solana and Sui transactions are built for `senderAddress`, so pass it on those chains.
42747
+ * `feePayer` is Solana only and defaults to `senderAddress`. The body is always sent,
42748
+ * as `{}` when `input` is omitted.
42749
+ *
42750
+ * Throws a `BadRequestError` (400) with problem code `sender_address_required` on a
42751
+ * Solana or Sui quote without `senderAddress`, and an `UnprocessableEntityError` (422)
42752
+ * on a `send_to_address` quote (Bitcoin, Dash, Tron), which has no transaction to sign.
42753
+ */
42754
+ getTransaction(quoteId: string, input?: OffRampQuoteTransactionRequest): Promise<{
42755
+ type: "evm";
42756
+ chain: string;
42757
+ inputToken: string;
42758
+ outputToken: string;
42759
+ requiredTokenInput: string;
42760
+ contractAddress: string;
42761
+ calldata: string;
42762
+ method: string;
42763
+ value: string | null;
42764
+ } | {
42765
+ type: "solana";
42766
+ chain: string;
42767
+ inputToken: string;
42768
+ outputToken: string;
42769
+ requiredTokenInput: string;
42770
+ recipientAddress: string;
42771
+ transactionSerialized: string;
42772
+ } | {
42773
+ type: "sui";
42774
+ chain: string;
42775
+ inputToken: string;
42776
+ outputToken: string;
42777
+ requiredTokenInput: string;
42778
+ recipientAddress: string;
42779
+ transactionSerialized: string;
42780
+ }>;
42781
+ /**
42782
+ * Report the on-chain transaction broadcast for a quote
42783
+ * (`POST /v1/off-ramp-quotes/{quoteId}/submit`).
42784
+ *
42785
+ * Optional: the chain watcher detects the transaction on its own. Reporting it moves
42786
+ * the quote to `transaction_pending` without waiting for the watcher; `confirmed` still
42787
+ * comes from the chain. Works for both fulfillment types. `offRampId` on the response
42788
+ * can still be `null`: read the quote again with `get` to pick it up.
42789
+ *
42790
+ * Safe to retry with the same hash, including after a timeout. Throws a
42791
+ * `BadRequestError` (400) when a different hash is already on record for the quote.
42792
+ */
42793
+ submit(quoteId: string, input: SubmitOffRampQuoteRequest): Promise<{
42794
+ id: string;
42795
+ fulfillment: "sign_transaction" | "send_to_address";
42796
+ status: "created" | "transaction_pending" | "transaction_failed" | "insufficient_funds" | "confirmed" | "completed" | "expired" | "failed" | "refunded";
42797
+ createdAt: string;
42798
+ input: {
42799
+ amount: string;
42800
+ currency: "USD";
42801
+ tokenAddress: string;
42802
+ chain: "ethereum" | "polygon" | "arbitrum" | "base" | "optimism" | "avalanche" | "binance-smart-chain" | "solana" | "bitcoin" | "dash" | "tron" | "sui" | "hyperevm" | "monad" | "sonic" | "unichain";
42803
+ };
42804
+ output: {
42805
+ amount: string;
42806
+ currency: string;
42807
+ rail: "ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit";
42808
+ accountId: string;
42809
+ estimated: boolean;
42810
+ exchangeRate: {
42811
+ baseCurrency: "USD";
42812
+ quoteCurrency: string;
42813
+ rate: string;
42814
+ } | null;
42815
+ };
42816
+ fees: {
42817
+ amount: string;
42818
+ currency: "USD";
42819
+ };
42820
+ sendTo: {
42821
+ address: string;
42822
+ amount: string;
42823
+ token: string;
42824
+ expiresAt: string;
42825
+ } | null;
42826
+ confirmation: {
42827
+ transactionHash: string;
42828
+ explorerUrl: string;
42829
+ } | null;
42830
+ offRampId: string | null;
42831
+ }>;
42832
+ }
42833
+
42530
42834
  interface CreateOnrampPayment_createOnrampPayment_depositInstructions {
42531
42835
  __typename: 'OnrampPaymentDepositInstructions';
42532
42836
  amount: number;
@@ -42738,6 +43042,149 @@ declare class VirtualAccountsService {
42738
43042
  create(input: CreateVirtualAccountInput): Promise<CreateVirtualAccount_createVirtualAccount>;
42739
43043
  }
42740
43044
 
43045
+ type AutoRampAccountList = PathResponse<'/v1/auto-ramp-accounts/', 'get'>;
43046
+ type AutoRampAccount = AutoRampAccountList[number];
43047
+ type CreateAutoRampAccountRequest = PathRequestBody<'/v1/auto-ramp-accounts/', 'post'>;
43048
+ type AutoRampAccountEstimate = PathResponse<'/v1/auto-ramp-accounts/{id}/estimate', 'get'>;
43049
+ declare class AutoRampAccountService {
43050
+ private client;
43051
+ constructor(client: SpritzClient);
43052
+ list(): Promise<{
43053
+ id: string;
43054
+ depositInstructions: {
43055
+ bankName: string;
43056
+ bankAddress: string;
43057
+ paymentRails: string[];
43058
+ type: "us";
43059
+ bankRoutingNumber: string;
43060
+ bankAccountNumber: string;
43061
+ } | {
43062
+ bankName: string;
43063
+ bankAddress: string;
43064
+ paymentRails: string[];
43065
+ type: "iban";
43066
+ iban: string;
43067
+ bic?: string;
43068
+ };
43069
+ network: string;
43070
+ address: string;
43071
+ token: string;
43072
+ currency: string;
43073
+ status: "active" | "inactive";
43074
+ createdAt: string;
43075
+ }[]>;
43076
+ get(accountId: string): Promise<{
43077
+ id: string;
43078
+ depositInstructions: {
43079
+ bankName: string;
43080
+ bankAddress: string;
43081
+ paymentRails: string[];
43082
+ type: "us";
43083
+ bankRoutingNumber: string;
43084
+ bankAccountNumber: string;
43085
+ } | {
43086
+ bankName: string;
43087
+ bankAddress: string;
43088
+ paymentRails: string[];
43089
+ type: "iban";
43090
+ iban: string;
43091
+ bic?: string;
43092
+ };
43093
+ network: string;
43094
+ address: string;
43095
+ token: string;
43096
+ currency: string;
43097
+ status: "active" | "inactive";
43098
+ createdAt: string;
43099
+ }>;
43100
+ /**
43101
+ * Create an auto-ramp account (`POST /v1/auto-ramp-accounts/`): a virtual bank
43102
+ * account in the user's name that converts fiat deposits to `token` and sends them
43103
+ * to `address` on `network`.
43104
+ *
43105
+ * Branch on `depositInstructions.type` in the response: `us` carries routing and
43106
+ * account numbers, `iban` carries the IBAN and BIC for SEPA. Confirm `status` is
43107
+ * `active` before telling a user to deposit.
43108
+ *
43109
+ * The address must be valid for the network, and the network/token pair must be
43110
+ * supported in the user's region; otherwise a `BadRequestError` (400) names the
43111
+ * `field` (`address` or `network`).
43112
+ *
43113
+ * **This endpoint does not support an idempotency key.** After a timeout or lost
43114
+ * reply, call `list()` and look for the account before creating it again.
43115
+ *
43116
+ * This is the REST replacement for the legacy GraphQL `virtualAccounts.create()`.
43117
+ */
43118
+ create(input: CreateAutoRampAccountRequest): Promise<{
43119
+ id: string;
43120
+ depositInstructions: {
43121
+ bankName: string;
43122
+ bankAddress: string;
43123
+ paymentRails: string[];
43124
+ type: "us";
43125
+ bankRoutingNumber: string;
43126
+ bankAccountNumber: string;
43127
+ } | {
43128
+ bankName: string;
43129
+ bankAddress: string;
43130
+ paymentRails: string[];
43131
+ type: "iban";
43132
+ iban: string;
43133
+ bic?: string;
43134
+ };
43135
+ network: string;
43136
+ address: string;
43137
+ token: string;
43138
+ currency: string;
43139
+ status: "active" | "inactive";
43140
+ createdAt: string;
43141
+ }>;
43142
+ /**
43143
+ * Estimate what depositing `amount` into this account is expected to cost
43144
+ * (`GET /v1/auto-ramp-accounts/{id}/estimate`). `amount` is a decimal string in the
43145
+ * account's own currency, e.g. `'2525.00'`.
43146
+ *
43147
+ * An estimate, not a quote: no rate is locked. The fee is this account's, so do not
43148
+ * reuse an estimate across accounts. `fees.maximum` and `output.minimum` are omitted
43149
+ * until enough deposits have settled on the network; do not promise a user a
43150
+ * ceiling or a floor when they are absent.
43151
+ *
43152
+ * When no estimate can be produced, branch on `error.problem.code`:
43153
+ * `rate_unavailable` (503, transient: retry), `unsupported_currency_pair` (400,
43154
+ * permanent) or `exchange_rate_provider_error` (502).
43155
+ */
43156
+ estimate(accountId: string, amount: string): Promise<{
43157
+ input: {
43158
+ amount: string;
43159
+ currency: string;
43160
+ };
43161
+ fees: {
43162
+ total: string;
43163
+ currency: string;
43164
+ breakdown: {
43165
+ platform: string;
43166
+ exchange: string;
43167
+ network: string;
43168
+ };
43169
+ estimated: ("platform" | "exchange" | "network")[];
43170
+ maximum?: string;
43171
+ networkFeeSamples: number;
43172
+ };
43173
+ output: {
43174
+ amount: string;
43175
+ minimum?: string;
43176
+ token: string;
43177
+ network: string;
43178
+ address: string;
43179
+ };
43180
+ rate: {
43181
+ value: string;
43182
+ source: "provider" | "peg";
43183
+ asOf: string;
43184
+ };
43185
+ }>;
43186
+ }
43187
+
42741
43188
  interface PaymentLimitsResponse {
42742
43189
  perTransaction: number;
42743
43190
  dailyLimit: number;
@@ -42789,6 +43236,33 @@ declare class PaymentRequestService {
42789
43236
  }>;
42790
43237
  }
42791
43238
 
43239
+ type AcceptTermsRequest = PathRequestBody<'/v1/users/me/terms', 'post'>;
43240
+ type AcceptTermsResponse = PathResponse<'/v1/users/me/terms', 'post'>;
43241
+ declare class TermsService {
43242
+ private client;
43243
+ constructor(client: SpritzClient);
43244
+ /**
43245
+ * Record acceptance of the terms a capability requires (`POST /v1/users/me/terms`).
43246
+ *
43247
+ * `agreementId` is the signed agreement id the user obtained from the provider's
43248
+ * hosted flow, whose URL is the `actionUrl` of the outstanding `terms_acceptance`
43249
+ * requirement on `user.getMe()`. It is opaque: the platform resolves which provider
43250
+ * it belongs to.
43251
+ *
43252
+ * Branch on `termsAccepted`: it is `true` when the agreement was recorded and terms
43253
+ * are now accepted.
43254
+ *
43255
+ * **This endpoint does not accept an idempotency key.** If a request times out, call
43256
+ * `user.getMe()` and check whether the `terms_acceptance` requirement is still
43257
+ * outstanding before submitting again.
43258
+ *
43259
+ * This is the REST replacement for the legacy GraphQL `onramp.acceptTermsOfService()`.
43260
+ */
43261
+ accept(input: AcceptTermsRequest): Promise<{
43262
+ termsAccepted: boolean;
43263
+ }>;
43264
+ }
43265
+
42792
43266
  interface GetVerificationParams_getVerificationParams {
42793
43267
  __typename: 'VerificationParams';
42794
43268
  inquiryId: string;
@@ -42895,6 +43369,17 @@ interface AuthorizeApiKeyParams {
42895
43369
  declare class UserService {
42896
43370
  private client;
42897
43371
  constructor(client: SpritzClient);
43372
+ /**
43373
+ * Create a user under the integrator and return their API key.
43374
+ *
43375
+ * With integrator HMAC credentials (`integrationKey` + `integratorSecret`, as issued
43376
+ * by the Developer Console) this calls `POST /v1/integrator/users` on the REST API.
43377
+ * Without a secret it uses the legacy `/users/integration` route, which does not
43378
+ * accept Developer Console credentials.
43379
+ *
43380
+ * On the REST route an email that already exists is rejected with a `ConflictError`
43381
+ * (409); use Spritz Connect to have that user authorize the integrator instead.
43382
+ */
42898
43383
  createUser(args: CreateUserParams): Promise<CreateUserResponse>;
42899
43384
  create(args: CreateUserParams): Promise<CreateUserResponse>;
42900
43385
  requestApiKey(email: string): Promise<RequestApiKeyResponse>;
@@ -42919,6 +43404,9 @@ declare class UserService {
42919
43404
  verification: {
42920
43405
  status: "not_started" | "verified" | "failed" | "disabled" | "retry" | "under_review";
42921
43406
  failureReason: "verify_sms" | "documentary_verification" | "risk_check" | "kyc_check" | "address_invalid" | "selfie_check" | "watchlist_screening" | "vpn_detected" | "duplicate_identity" | null;
43407
+ duplicateIdentity: {
43408
+ maskedEmail: string;
43409
+ } | null;
42922
43410
  country: string | null;
42923
43411
  requirement?: {
42924
43412
  type: "identity_verification" | "terms_acceptance" | "additional_verification" | "document_submission" | "region_restriction" | "regional_compliance";
@@ -43157,6 +43645,8 @@ declare class SpritzApiClient {
43157
43645
  private client;
43158
43646
  user: UserService;
43159
43647
  verification: VerificationService;
43648
+ compliance: ComplianceService;
43649
+ terms: TermsService;
43160
43650
  bankAccount: BankAccountService;
43161
43651
  debitCard: DebitCardService;
43162
43652
  deposit: DepositService;
@@ -43168,7 +43658,9 @@ declare class SpritzApiClient {
43168
43658
  onrampPayment: OnrampPaymentService;
43169
43659
  onramp: OnrampService;
43170
43660
  offramp: OfframpService;
43661
+ offRampQuote: OffRampQuoteService;
43171
43662
  virtualAccounts: VirtualAccountsService;
43663
+ autoRampAccount: AutoRampAccountService;
43172
43664
  virtualCard: VirtualCardService;
43173
43665
  bill: BillService;
43174
43666
  institution: InstitutionService;
@@ -43329,4 +43821,4 @@ declare function hasProblemCode<T extends string>(error: unknown, code: T): erro
43329
43821
  };
43330
43822
 
43331
43823
  export { APIConnectionError, APIConnectionTimeoutError, APIError, APIUserAbortError, AmountMode, AuthenticationError, BadRequestError, BankAccountSubType, BankAccountType, BillType, CardFeatureType, ConflictError, DebitCardNetwork, Environment, InternalServerError, NotFoundError, OfframpFeatureType, OnrampFeatureType, PayableAccountType, PaymentDeliveryMethod, PaymentNetwork, DirectPaymentStatus as PaymentRequestStatus, PaymentStatus, PermissionDeniedError, RateLimitError, RequirementType, SpritzApiClient, SpritzApiError, UnprocessableEntityError, VirtualCardType, hasProblemCode, hasProblemType, isAPIError, onrampSupportedTokens };
43332
- export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitEligibilityRequest, AchDebitEligibilityResponse, AchDebitExposureResponse, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, BankAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BankAccountList, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, CreateBankAccountInput, CreateBankAccountResponse, CreateDepositOptions, CreateDepositRequest, CreateDepositWithReturnRequest, CreateDepositWithReturnResponse, CreateDirectPaymentInput, CreateOnrampPaymentInput, CreatePaymentRequestInput, CreateVirtualAccountInput, CreateWebhookParams, CurrentUser, CurrentUser_me, CurrentUser_verification, CurrentUser_verification_identity, CurrentUser_verification_identity_verificationMetadata, CurrentUser_verification_identity_verificationMetadata_details, DebitCardFragment, DebitCardInput, DeleteBankAccountResponse, DeleteFundingSourceResponse, Deposit, DepositListQuery, DepositListResponse, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkBankAccountRequest, LinkBankAccountResponse, LinkTokenResponse, OffRampRefundRequest, OffRampRefundResponse, OnRamp, OnRampDetail, OnRampListQuery, OnRampListResponse, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PathParams, PathQuery, PathRequestBody, PathResponse, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentFragment_transaction, PaymentLimits, PaymentLimitsResponse, PaymentLimitsVariables, PaymentLimits_paymentLimits, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, PrepareDepositRequest, PrepareDepositResponse, PrepareDepositWithProgramControlRequest, PrepareDepositWithProgramControlResponse, ProblemDetails, ProblemFieldError, ProblemSuggestedAction, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, SetAchDebitExposureCapRequest, SetAchDebitExposureCapResponse, TokenBalanceFragment, UpdateWebhookParams, UpdateWebhookSecretResponse, UserAccess, UserAccessCapabilities, UserAccess_bridgeUser, UserAccess_me, UserAccess_verification, UserAccess_verification_identity, UserAccess_verification_identity_verificationMetadata, UserAccess_verification_identity_verificationMetadata_details, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, UserProfile, UserVerification, UserVerification_verification, UserVerification_verification_identity, UserVerification_verification_identity_user, UserVerification_verification_identity_verificationMetadata, UserVerification_verification_identity_verificationMetadata_details, UserVirtualDebitCard, UserVirtualDebitCard_virtualDebitCard, UserVirtualDebitCard_virtualDebitCard_billingInfo, UserVirtualDebitCard_virtualDebitCard_billingInfo_address, UserVirtualDebitCard_virtualDebitCard_paymentAddresses, VerificationFragment, VerificationFragment_identity, VerificationFragment_identity_verificationMetadata, VerificationFragment_identity_verificationMetadata_details, VerificationSession, VirtualAccountFragment, VirtualAccountFragment_depositInstructions, VirtualAccounts, VirtualAccounts_virtualAccounts, VirtualAccounts_virtualAccounts_depositInstructions, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances, WebhookEvent };
43824
+ export type { AcceptTermsRequest, AcceptTermsResponse, AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitEligibilityRequest, AchDebitEligibilityResponse, AchDebitExposureResponse, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, AutoRampAccount, AutoRampAccountEstimate, AutoRampAccountList, BankAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BankAccountList, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, ComplianceRequirementField, ComplianceRequirements, CreateAutoRampAccountRequest, CreateBankAccountInput, CreateBankAccountResponse, CreateDepositOptions, CreateDepositRequest, CreateDepositWithReturnRequest, CreateDepositWithReturnResponse, CreateDirectPaymentInput, CreateOffRampQuoteRequest, CreateOnrampPaymentInput, CreatePaymentRequestInput, CreateVirtualAccountInput, CreateWebhookParams, CurrentUser, CurrentUser_me, CurrentUser_verification, CurrentUser_verification_identity, CurrentUser_verification_identity_verificationMetadata, CurrentUser_verification_identity_verificationMetadata_details, DebitCardFragment, DebitCardInput, DeleteBankAccountResponse, DeleteFundingSourceResponse, Deposit, DepositListQuery, DepositListResponse, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkBankAccountRequest, LinkBankAccountResponse, LinkTokenResponse, OffRampQuote, OffRampQuoteTransaction, OffRampQuoteTransactionRequest, OffRampRefundRequest, OffRampRefundResponse, OnRamp, OnRampDetail, OnRampListQuery, OnRampListResponse, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PathParams, PathQuery, PathRequestBody, PathResponse, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentFragment_transaction, PaymentLimits, PaymentLimitsResponse, PaymentLimitsVariables, PaymentLimits_paymentLimits, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, PrepareDepositRequest, PrepareDepositResponse, PrepareDepositWithProgramControlRequest, PrepareDepositWithProgramControlResponse, ProblemDetails, ProblemFieldError, ProblemSuggestedAction, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, SetAchDebitExposureCapRequest, SetAchDebitExposureCapResponse, SimulateAutoRampDepositRequest, SimulateAutoRampDepositResponse, SubmitComplianceRequest, SubmitComplianceResponse, SubmitOffRampQuoteRequest, TokenBalanceFragment, UpdateWebhookParams, UpdateWebhookSecretResponse, UserAccess, UserAccessCapabilities, UserAccess_bridgeUser, UserAccess_me, UserAccess_verification, UserAccess_verification_identity, UserAccess_verification_identity_verificationMetadata, UserAccess_verification_identity_verificationMetadata_details, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, UserProfile, UserVerification, UserVerification_verification, UserVerification_verification_identity, UserVerification_verification_identity_user, UserVerification_verification_identity_verificationMetadata, UserVerification_verification_identity_verificationMetadata_details, UserVirtualDebitCard, UserVirtualDebitCard_virtualDebitCard, UserVirtualDebitCard_virtualDebitCard_billingInfo, UserVirtualDebitCard_virtualDebitCard_billingInfo_address, UserVirtualDebitCard_virtualDebitCard_paymentAddresses, VerificationFragment, VerificationFragment_identity, VerificationFragment_identity_verificationMetadata, VerificationFragment_identity_verificationMetadata_details, VerificationSession, VirtualAccountFragment, VirtualAccountFragment_depositInstructions, VirtualAccounts, VirtualAccounts_virtualAccounts, VirtualAccounts_virtualAccounts_depositInstructions, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances, WebhookEvent };