@spritz-finance/api-client 0.14.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/dist/spritz-api-client.cjs +61 -61
- package/dist/spritz-api-client.d.ts +111 -2
- package/dist/spritz-api-client.mjs +61 -61
- package/package.json +1 -1
|
@@ -41162,7 +41162,9 @@ declare class DebitCardService {
|
|
|
41162
41162
|
type PrepareDepositRequest = PathRequestBody<'/v1/deposits/direct/prepare', 'post'>;
|
|
41163
41163
|
type PrepareDepositResponse = PathResponse<'/v1/deposits/direct/prepare', 'post'>;
|
|
41164
41164
|
type CreateDepositRequest = PathRequestBody<'/v1/deposits/direct', 'post'>;
|
|
41165
|
-
type Deposit = PathResponse<'/v1/deposits/
|
|
41165
|
+
type Deposit = PathResponse<'/v1/deposits/{depositId}', 'get'>;
|
|
41166
|
+
type DepositListResponse = PathResponse<'/v1/deposits/', 'get'>;
|
|
41167
|
+
type DepositListQuery = PathQuery<'/v1/deposits/', 'get'>;
|
|
41166
41168
|
/**
|
|
41167
41169
|
* `idempotencyKey` is required by `POST /v1/deposits/direct`: persist one
|
|
41168
41170
|
* unique key per deposit intent before calling `create`, and reuse the exact
|
|
@@ -41259,6 +41261,113 @@ declare class DepositService {
|
|
|
41259
41261
|
releaseFailureReason: string | null;
|
|
41260
41262
|
payoutTxHash: string | null;
|
|
41261
41263
|
}>;
|
|
41264
|
+
/**
|
|
41265
|
+
* Lists the authenticated user's deposits, newest first.
|
|
41266
|
+
*
|
|
41267
|
+
* The endpoint is user-scoped: reconciling an integrator-wide backlog means
|
|
41268
|
+
* iterating your own user roster and authorizing each user's read. Page with
|
|
41269
|
+
* `cursor`, driven by `nextCursor`/`hasMore` on the response.
|
|
41270
|
+
*/
|
|
41271
|
+
list(query?: DepositListQuery): Promise<{
|
|
41272
|
+
data: {
|
|
41273
|
+
id: string;
|
|
41274
|
+
sourceId: string;
|
|
41275
|
+
onRampId: string | null;
|
|
41276
|
+
status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "refunded" | "failed";
|
|
41277
|
+
quoteType: "exact_input" | "exact_output";
|
|
41278
|
+
requestedPriority: "normal" | "high";
|
|
41279
|
+
priority: "normal" | "high";
|
|
41280
|
+
feeRateBps: number;
|
|
41281
|
+
principalAmountUsd: string;
|
|
41282
|
+
instantPortionUsd: string;
|
|
41283
|
+
settlementPortionUsd: string;
|
|
41284
|
+
expectedAssetAmount: string;
|
|
41285
|
+
grossFeeUsd: string;
|
|
41286
|
+
publishedFeeUsd: string;
|
|
41287
|
+
regularPublishedFeeUsd: string;
|
|
41288
|
+
instantPublishedFeeUsd: string;
|
|
41289
|
+
feeSubsidyUsd: string;
|
|
41290
|
+
userFeeUsd: string;
|
|
41291
|
+
totalDebitAmountUsd: string;
|
|
41292
|
+
feeSubsidy: {
|
|
41293
|
+
percentage: number;
|
|
41294
|
+
percentageBps: number;
|
|
41295
|
+
maxAmountUsd: string | null;
|
|
41296
|
+
appliedAmountUsd: string;
|
|
41297
|
+
} | null;
|
|
41298
|
+
network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
|
|
41299
|
+
asset: "USDC";
|
|
41300
|
+
assetAddress: string;
|
|
41301
|
+
address: string;
|
|
41302
|
+
debitStatus: "authorized" | "submitting" | "submitted" | "settled" | "returned" | "failed";
|
|
41303
|
+
releaseStatus: "not_started" | "queued" | "partial" | "completed" | "failed";
|
|
41304
|
+
releaseDecisionMode: "after_settlement" | "early_full" | "early_partial";
|
|
41305
|
+
releasedAmountUsd: string;
|
|
41306
|
+
confirmedReleasedAmountUsd: string;
|
|
41307
|
+
authorizedAt: string;
|
|
41308
|
+
createdAt: string;
|
|
41309
|
+
settledAt: string | null;
|
|
41310
|
+
returnedAt: string | null;
|
|
41311
|
+
completedAt: string | null;
|
|
41312
|
+
returnCode: string | null;
|
|
41313
|
+
returnReason: string | null;
|
|
41314
|
+
debitFailureCode: string | null;
|
|
41315
|
+
debitFailureReason: string | null;
|
|
41316
|
+
releaseFailureCode: string | null;
|
|
41317
|
+
releaseFailureReason: string | null;
|
|
41318
|
+
payoutTxHash: string | null;
|
|
41319
|
+
}[];
|
|
41320
|
+
hasMore: boolean;
|
|
41321
|
+
nextCursor: string | null;
|
|
41322
|
+
}>;
|
|
41323
|
+
get(depositId: string): Promise<{
|
|
41324
|
+
id: string;
|
|
41325
|
+
sourceId: string;
|
|
41326
|
+
onRampId: string | null;
|
|
41327
|
+
status: "authorized" | "processing" | "partially_released" | "completed" | "returned" | "refunded" | "failed";
|
|
41328
|
+
quoteType: "exact_input" | "exact_output";
|
|
41329
|
+
requestedPriority: "normal" | "high";
|
|
41330
|
+
priority: "normal" | "high";
|
|
41331
|
+
feeRateBps: number;
|
|
41332
|
+
principalAmountUsd: string;
|
|
41333
|
+
instantPortionUsd: string;
|
|
41334
|
+
settlementPortionUsd: string;
|
|
41335
|
+
expectedAssetAmount: string;
|
|
41336
|
+
grossFeeUsd: string;
|
|
41337
|
+
publishedFeeUsd: string;
|
|
41338
|
+
regularPublishedFeeUsd: string;
|
|
41339
|
+
instantPublishedFeeUsd: string;
|
|
41340
|
+
feeSubsidyUsd: string;
|
|
41341
|
+
userFeeUsd: string;
|
|
41342
|
+
totalDebitAmountUsd: string;
|
|
41343
|
+
feeSubsidy: {
|
|
41344
|
+
percentage: number;
|
|
41345
|
+
percentageBps: number;
|
|
41346
|
+
maxAmountUsd: string | null;
|
|
41347
|
+
appliedAmountUsd: string;
|
|
41348
|
+
} | null;
|
|
41349
|
+
network: "solana" | "ethereum" | "polygon" | "base" | "avalanche" | "arbitrum";
|
|
41350
|
+
asset: "USDC";
|
|
41351
|
+
assetAddress: string;
|
|
41352
|
+
address: string;
|
|
41353
|
+
debitStatus: "authorized" | "submitting" | "submitted" | "settled" | "returned" | "failed";
|
|
41354
|
+
releaseStatus: "not_started" | "queued" | "partial" | "completed" | "failed";
|
|
41355
|
+
releaseDecisionMode: "after_settlement" | "early_full" | "early_partial";
|
|
41356
|
+
releasedAmountUsd: string;
|
|
41357
|
+
confirmedReleasedAmountUsd: string;
|
|
41358
|
+
authorizedAt: string;
|
|
41359
|
+
createdAt: string;
|
|
41360
|
+
settledAt: string | null;
|
|
41361
|
+
returnedAt: string | null;
|
|
41362
|
+
completedAt: string | null;
|
|
41363
|
+
returnCode: string | null;
|
|
41364
|
+
returnReason: string | null;
|
|
41365
|
+
debitFailureCode: string | null;
|
|
41366
|
+
debitFailureReason: string | null;
|
|
41367
|
+
releaseFailureCode: string | null;
|
|
41368
|
+
releaseFailureReason: string | null;
|
|
41369
|
+
payoutTxHash: string | null;
|
|
41370
|
+
}>;
|
|
41262
41371
|
}
|
|
41263
41372
|
|
|
41264
41373
|
type FundingSource = PathResponse<'/v1/funding-sources/', 'get'>[number];
|
|
@@ -42177,4 +42286,4 @@ declare class InternalServerError extends APIError {
|
|
|
42177
42286
|
}
|
|
42178
42287
|
|
|
42179
42288
|
export { APIConnectionError, APIConnectionTimeoutError, APIError, APIUserAbortError, AmountMode, AuthenticationError, BadRequestError, BankAccountSubType, BankAccountType, BillType, CardFeatureType, ConflictError, DebitCardNetwork, Environment, InternalServerError, NotFoundError, OfframpFeatureType, OnrampFeatureType, PayableAccountType, PaymentDeliveryMethod, PaymentNetwork, DirectPaymentStatus as PaymentRequestStatus, PaymentStatus, PermissionDeniedError, RateLimitError, RequirementType, SpritzApiClient, SpritzApiError, UnprocessableEntityError, VirtualCardType, onrampSupportedTokens };
|
|
42180
|
-
export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, BankAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BankAccountList, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, CreateBankAccountInput, CreateBankAccountResponse, 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, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkTokenResponse, OffRampRefundRequest, OffRampRefundResponse, OnRamp, OnRampDetail, OnRampListQuery, OnRampListResponse, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PathParams, PathQuery, PathRequestBody, PathResponse, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentFragment_transaction, PaymentLimits, PaymentLimitsResponse, PaymentLimitsVariables, PaymentLimits_paymentLimits, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, PrepareDepositRequest, PrepareDepositResponse, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, TokenBalanceFragment, UpdateWebhookParams, UpdateWebhookSecretResponse, UserAccess, UserAccessCapabilities, UserAccess_bridgeUser, UserAccess_me, UserAccess_verification, UserAccess_verification_identity, UserAccess_verification_identity_verificationMetadata, UserAccess_verification_identity_verificationMetadata_details, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, 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 };
|
|
42289
|
+
export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, BankAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BankAccountList, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, CreateBankAccountInput, CreateBankAccountResponse, 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, LinkTokenResponse, OffRampRefundRequest, OffRampRefundResponse, OnRamp, OnRampDetail, OnRampListQuery, OnRampListResponse, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PathParams, PathQuery, PathRequestBody, PathResponse, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentFragment_transaction, PaymentLimits, PaymentLimitsResponse, PaymentLimitsVariables, PaymentLimits_paymentLimits, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, PrepareDepositRequest, PrepareDepositResponse, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, TokenBalanceFragment, UpdateWebhookParams, UpdateWebhookSecretResponse, UserAccess, UserAccessCapabilities, UserAccess_bridgeUser, UserAccess_me, UserAccess_verification, UserAccess_verification_identity, UserAccess_verification_identity_verificationMetadata, UserAccess_verification_identity_verificationMetadata_details, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, 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 };
|