@spritz-finance/api-client 0.7.0 → 0.8.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.
@@ -23484,8 +23484,7 @@ interface operations {
23484
23484
  }
23485
23485
 
23486
23486
  type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
23487
- /** Extract the 200 JSON response body for a path + method */
23488
- type PathResponse<P extends keyof paths, M extends HttpMethod & keyof paths[P]> = paths[P][M] extends {
23487
+ type Extract200<P extends keyof paths, M extends HttpMethod & keyof paths[P]> = paths[P][M] extends {
23489
23488
  responses: {
23490
23489
  200: {
23491
23490
  content: {
@@ -23494,6 +23493,17 @@ type PathResponse<P extends keyof paths, M extends HttpMethod & keyof paths[P]>
23494
23493
  };
23495
23494
  };
23496
23495
  } ? R : never;
23496
+ type Extract201<P extends keyof paths, M extends HttpMethod & keyof paths[P]> = paths[P][M] extends {
23497
+ responses: {
23498
+ 201: {
23499
+ content: {
23500
+ 'application/json': infer R;
23501
+ };
23502
+ };
23503
+ };
23504
+ } ? R : never;
23505
+ /** Extract the success (200/201) JSON response body for a path + method */
23506
+ type PathResponse<P extends keyof paths, M extends HttpMethod & keyof paths[P]> = Extract200<P, M> extends never ? Extract201<P, M> : Extract200<P, M> | Extract201<P, M>;
23497
23507
  /** Extract the JSON request body for a path + method */
23498
23508
  type PathRequestBody<P extends keyof paths, M extends HttpMethod & keyof paths[P]> = paths[P][M] extends {
23499
23509
  requestBody: {
@@ -23563,6 +23573,303 @@ declare class AchDebitReturnService {
23563
23573
  }>;
23564
23574
  }
23565
23575
 
23576
+ type BankAccount = PathResponse<'/v1/bank-accounts/', 'get'>[number];
23577
+ type BankAccountList = PathResponse<'/v1/bank-accounts/', 'get'>;
23578
+ type CreateBankAccountInput = PathRequestBody<'/v1/bank-accounts/', 'post'>;
23579
+ type CreateBankAccountResponse = PathResponse<'/v1/bank-accounts/', 'post'>;
23580
+ type DeleteBankAccountResponse = PathResponse<'/v1/bank-accounts/{accountId}', 'delete'>;
23581
+ type LinkTokenResponse = PathResponse<'/v1/bank-accounts/link-token', 'post'>;
23582
+ type CompleteLinkingRequest = PathRequestBody<'/v1/bank-accounts/link-complete', 'post'>;
23583
+ type CompleteLinkingResponse = PathResponse<'/v1/bank-accounts/link-complete', 'post'>;
23584
+ declare class BankAccountService {
23585
+ private client;
23586
+ constructor(client: SpritzClient);
23587
+ list(): Promise<({
23588
+ id: string;
23589
+ status: "active" | "pending" | "inactive" | "rejected";
23590
+ accountHolderName: string;
23591
+ institution?: {
23592
+ name: string;
23593
+ logo?: string;
23594
+ };
23595
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23596
+ label?: string;
23597
+ createdAt: string;
23598
+ fundingSourceId: string | null;
23599
+ type: "us";
23600
+ currency: "USD";
23601
+ accountNumberLast4: string;
23602
+ routingNumberLast4: string;
23603
+ accountSubtype?: "checking" | "savings";
23604
+ } | {
23605
+ id: string;
23606
+ status: "active" | "pending" | "inactive" | "rejected";
23607
+ accountHolderName: string;
23608
+ institution?: {
23609
+ name: string;
23610
+ logo?: string;
23611
+ };
23612
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23613
+ label?: string;
23614
+ createdAt: string;
23615
+ fundingSourceId: string | null;
23616
+ type: "ca";
23617
+ currency: "CAD";
23618
+ accountNumberLast4: string;
23619
+ institutionNumber: string;
23620
+ transitNumberLast3: string;
23621
+ accountSubtype?: "checking" | "savings";
23622
+ } | {
23623
+ id: string;
23624
+ status: "active" | "pending" | "inactive" | "rejected";
23625
+ accountHolderName: string;
23626
+ institution?: {
23627
+ name: string;
23628
+ logo?: string;
23629
+ };
23630
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23631
+ label?: string;
23632
+ createdAt: string;
23633
+ fundingSourceId: string | null;
23634
+ type: "uk";
23635
+ currency: "GBP";
23636
+ accountNumberLast4: string;
23637
+ sortCode: string;
23638
+ } | {
23639
+ id: string;
23640
+ status: "active" | "pending" | "inactive" | "rejected";
23641
+ accountHolderName: string;
23642
+ institution?: {
23643
+ name: string;
23644
+ logo?: string;
23645
+ };
23646
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23647
+ label?: string;
23648
+ createdAt: string;
23649
+ fundingSourceId: string | null;
23650
+ type: "iban";
23651
+ currency: "USD" | "CAD" | "EUR" | "GBP";
23652
+ ibanLast4: string;
23653
+ bic?: string;
23654
+ })[]>;
23655
+ get(accountId: string): Promise<{
23656
+ id: string;
23657
+ status: "active" | "pending" | "inactive" | "rejected";
23658
+ accountHolderName: string;
23659
+ institution?: {
23660
+ name: string;
23661
+ logo?: string;
23662
+ };
23663
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23664
+ label?: string;
23665
+ createdAt: string;
23666
+ fundingSourceId: string | null;
23667
+ type: "us";
23668
+ currency: "USD";
23669
+ accountNumberLast4: string;
23670
+ routingNumberLast4: string;
23671
+ accountSubtype?: "checking" | "savings";
23672
+ } | {
23673
+ id: string;
23674
+ status: "active" | "pending" | "inactive" | "rejected";
23675
+ accountHolderName: string;
23676
+ institution?: {
23677
+ name: string;
23678
+ logo?: string;
23679
+ };
23680
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23681
+ label?: string;
23682
+ createdAt: string;
23683
+ fundingSourceId: string | null;
23684
+ type: "ca";
23685
+ currency: "CAD";
23686
+ accountNumberLast4: string;
23687
+ institutionNumber: string;
23688
+ transitNumberLast3: string;
23689
+ accountSubtype?: "checking" | "savings";
23690
+ } | {
23691
+ id: string;
23692
+ status: "active" | "pending" | "inactive" | "rejected";
23693
+ accountHolderName: string;
23694
+ institution?: {
23695
+ name: string;
23696
+ logo?: string;
23697
+ };
23698
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23699
+ label?: string;
23700
+ createdAt: string;
23701
+ fundingSourceId: string | null;
23702
+ type: "uk";
23703
+ currency: "GBP";
23704
+ accountNumberLast4: string;
23705
+ sortCode: string;
23706
+ } | {
23707
+ id: string;
23708
+ status: "active" | "pending" | "inactive" | "rejected";
23709
+ accountHolderName: string;
23710
+ institution?: {
23711
+ name: string;
23712
+ logo?: string;
23713
+ };
23714
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23715
+ label?: string;
23716
+ createdAt: string;
23717
+ fundingSourceId: string | null;
23718
+ type: "iban";
23719
+ currency: "USD" | "CAD" | "EUR" | "GBP";
23720
+ ibanLast4: string;
23721
+ bic?: string;
23722
+ }>;
23723
+ create(input: CreateBankAccountInput): Promise<{
23724
+ id: string;
23725
+ status: "active" | "pending" | "inactive" | "rejected";
23726
+ accountHolderName: string;
23727
+ institution?: {
23728
+ name: string;
23729
+ logo?: string;
23730
+ };
23731
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23732
+ label?: string;
23733
+ createdAt: string;
23734
+ fundingSourceId: string | null;
23735
+ type: "us";
23736
+ currency: "USD";
23737
+ accountNumberLast4: string;
23738
+ routingNumberLast4: string;
23739
+ accountSubtype?: "checking" | "savings";
23740
+ } | {
23741
+ id: string;
23742
+ status: "active" | "pending" | "inactive" | "rejected";
23743
+ accountHolderName: string;
23744
+ institution?: {
23745
+ name: string;
23746
+ logo?: string;
23747
+ };
23748
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23749
+ label?: string;
23750
+ createdAt: string;
23751
+ fundingSourceId: string | null;
23752
+ type: "ca";
23753
+ currency: "CAD";
23754
+ accountNumberLast4: string;
23755
+ institutionNumber: string;
23756
+ transitNumberLast3: string;
23757
+ accountSubtype?: "checking" | "savings";
23758
+ } | {
23759
+ id: string;
23760
+ status: "active" | "pending" | "inactive" | "rejected";
23761
+ accountHolderName: string;
23762
+ institution?: {
23763
+ name: string;
23764
+ logo?: string;
23765
+ };
23766
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23767
+ label?: string;
23768
+ createdAt: string;
23769
+ fundingSourceId: string | null;
23770
+ type: "uk";
23771
+ currency: "GBP";
23772
+ accountNumberLast4: string;
23773
+ sortCode: string;
23774
+ } | {
23775
+ id: string;
23776
+ status: "active" | "pending" | "inactive" | "rejected";
23777
+ accountHolderName: string;
23778
+ institution?: {
23779
+ name: string;
23780
+ logo?: string;
23781
+ };
23782
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23783
+ label?: string;
23784
+ createdAt: string;
23785
+ fundingSourceId: string | null;
23786
+ type: "iban";
23787
+ currency: "USD" | "CAD" | "EUR" | "GBP";
23788
+ ibanLast4: string;
23789
+ bic?: string;
23790
+ }>;
23791
+ delete(accountId: string): Promise<{
23792
+ id: string;
23793
+ deleted: true;
23794
+ }>;
23795
+ createLinkToken(): Promise<{
23796
+ linkToken: string;
23797
+ hostedLinkUrl: string | null;
23798
+ expiration: string;
23799
+ requestId: string;
23800
+ }>;
23801
+ completeLinking(input: CompleteLinkingRequest): Promise<{
23802
+ bankAccounts: ({
23803
+ id: string;
23804
+ status: "active" | "pending" | "inactive" | "rejected";
23805
+ accountHolderName: string;
23806
+ institution?: {
23807
+ name: string;
23808
+ logo?: string;
23809
+ };
23810
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23811
+ label?: string;
23812
+ createdAt: string;
23813
+ fundingSourceId: string | null;
23814
+ type: "us";
23815
+ currency: "USD";
23816
+ accountNumberLast4: string;
23817
+ routingNumberLast4: string;
23818
+ accountSubtype?: "checking" | "savings";
23819
+ } | {
23820
+ id: string;
23821
+ status: "active" | "pending" | "inactive" | "rejected";
23822
+ accountHolderName: string;
23823
+ institution?: {
23824
+ name: string;
23825
+ logo?: string;
23826
+ };
23827
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23828
+ label?: string;
23829
+ createdAt: string;
23830
+ fundingSourceId: string | null;
23831
+ type: "ca";
23832
+ currency: "CAD";
23833
+ accountNumberLast4: string;
23834
+ institutionNumber: string;
23835
+ transitNumberLast3: string;
23836
+ accountSubtype?: "checking" | "savings";
23837
+ } | {
23838
+ id: string;
23839
+ status: "active" | "pending" | "inactive" | "rejected";
23840
+ accountHolderName: string;
23841
+ institution?: {
23842
+ name: string;
23843
+ logo?: string;
23844
+ };
23845
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23846
+ label?: string;
23847
+ createdAt: string;
23848
+ fundingSourceId: string | null;
23849
+ type: "uk";
23850
+ currency: "GBP";
23851
+ accountNumberLast4: string;
23852
+ sortCode: string;
23853
+ } | {
23854
+ id: string;
23855
+ status: "active" | "pending" | "inactive" | "rejected";
23856
+ accountHolderName: string;
23857
+ institution?: {
23858
+ name: string;
23859
+ logo?: string;
23860
+ };
23861
+ supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
23862
+ label?: string;
23863
+ createdAt: string;
23864
+ fundingSourceId: string | null;
23865
+ type: "iban";
23866
+ currency: "USD" | "CAD" | "EUR" | "GBP";
23867
+ ibanLast4: string;
23868
+ bic?: string;
23869
+ })[];
23870
+ }>;
23871
+ }
23872
+
23566
23873
  declare enum AccountSyncStatus {
23567
23874
  Active = "Active",
23568
23875
  Error = "Error",
@@ -23716,47 +24023,6 @@ interface PaymentLimitsInput {
23716
24023
  type?: string | null;
23717
24024
  }
23718
24025
 
23719
- interface CreateBankAccount_createBankAccount_bankAccountDetails_CanadianBankAccountDetails {
23720
- __typename: 'CanadianBankAccountDetails' | 'UKBankAccountDetails' | 'IBANBankAccountDetails';
23721
- }
23722
- interface CreateBankAccount_createBankAccount_bankAccountDetails_USBankAccountDetails {
23723
- __typename: 'USBankAccountDetails';
23724
- routingNumber: string;
23725
- }
23726
- type CreateBankAccount_createBankAccount_bankAccountDetails = CreateBankAccount_createBankAccount_bankAccountDetails_CanadianBankAccountDetails | CreateBankAccount_createBankAccount_bankAccountDetails_USBankAccountDetails;
23727
- interface CreateBankAccount_createBankAccount_dataSync {
23728
- __typename: 'AccountDataSync';
23729
- lastSync: any | null;
23730
- syncStatus: AccountSyncStatus | null;
23731
- }
23732
- interface CreateBankAccount_createBankAccount_institution {
23733
- __typename: 'BankAccountInstitution' | 'BillInstitution';
23734
- id: string;
23735
- name: string;
23736
- logo: string | null;
23737
- }
23738
- interface CreateBankAccount_createBankAccount {
23739
- __typename: 'BankAccount';
23740
- id: string;
23741
- name: string | null;
23742
- userId: string;
23743
- country: string;
23744
- currency: string;
23745
- payable: boolean;
23746
- originator: PayableAccountOriginator;
23747
- type: PayableAccountType;
23748
- createdAt: any;
23749
- accountNumber: string;
23750
- bankAccountType: BankAccountType;
23751
- bankAccountSubType: BankAccountSubType;
23752
- holder: string;
23753
- email: string | null;
23754
- ownedByUser: boolean;
23755
- bankAccountDetails: CreateBankAccount_createBankAccount_bankAccountDetails | null;
23756
- dataSync: CreateBankAccount_createBankAccount_dataSync | null;
23757
- institution: CreateBankAccount_createBankAccount_institution | null;
23758
- }
23759
-
23760
24026
  interface AccountPayments_paymentsForAccount_transaction {
23761
24027
  __typename: 'BlockchainTransaction';
23762
24028
  hash: string;
@@ -24912,52 +25178,65 @@ interface WalletTokenBalancesVariables {
24912
25178
  network?: string | null;
24913
25179
  }
24914
25180
 
24915
- interface DeletePayableAccount_deletePayableAccount_DebitCard_dataSync {
25181
+ interface CreateUSBill_addUSBill_billAccountDetails {
25182
+ __typename: 'BillAccountDetails';
25183
+ balance: number | null;
25184
+ amountDue: number | null;
25185
+ openedAt: any | null;
25186
+ lastPaymentAmount: number | null;
25187
+ lastPaymentDate: any | null;
25188
+ nextPaymentDueDate: any | null;
25189
+ nextPaymentMinimumAmount: number | null;
25190
+ lastStatementBalance: number | null;
25191
+ remainingStatementBalance: number | null;
25192
+ }
25193
+ interface CreateUSBill_addUSBill_dataSync {
24916
25194
  __typename: 'AccountDataSync';
24917
25195
  lastSync: any | null;
24918
25196
  syncStatus: AccountSyncStatus | null;
24919
25197
  }
24920
- interface DeletePayableAccount_deletePayableAccount_DebitCard_institution {
25198
+ interface CreateUSBill_addUSBill_institution {
24921
25199
  __typename: 'BankAccountInstitution' | 'BillInstitution';
24922
25200
  id: string;
24923
25201
  name: string;
24924
25202
  logo: string | null;
24925
25203
  }
24926
- interface DeletePayableAccount_deletePayableAccount_DebitCard {
24927
- __typename: 'DebitCard' | 'DigitalAccount' | 'OneTimePayment';
25204
+ interface CreateUSBill_addUSBill_paymentAddresses {
25205
+ __typename: 'PaymentAddress';
25206
+ network: string;
25207
+ address: string;
25208
+ }
25209
+ interface CreateUSBill_addUSBill {
25210
+ __typename: 'Bill';
24928
25211
  id: string;
24929
25212
  name: string | null;
24930
25213
  userId: string;
24931
25214
  country: string;
24932
25215
  currency: string;
24933
- payable: boolean;
24934
25216
  originator: PayableAccountOriginator;
24935
- type: PayableAccountType;
25217
+ payable: boolean;
25218
+ verifying: boolean;
25219
+ billType: BillType;
24936
25220
  createdAt: any;
24937
- dataSync: DeletePayableAccount_deletePayableAccount_DebitCard_dataSync | null;
24938
- institution: DeletePayableAccount_deletePayableAccount_DebitCard_institution | null;
25221
+ billAccountDetails: CreateUSBill_addUSBill_billAccountDetails | null;
25222
+ dataSync: CreateUSBill_addUSBill_dataSync | null;
25223
+ institution: CreateUSBill_addUSBill_institution | null;
25224
+ paymentAddresses: CreateUSBill_addUSBill_paymentAddresses[];
24939
25225
  }
24940
- interface DeletePayableAccount_deletePayableAccount_BankAccount_dataSync {
25226
+
25227
+ interface DeletePayableAccount_deletePayableAccount_DebitCard_dataSync {
24941
25228
  __typename: 'AccountDataSync';
24942
25229
  lastSync: any | null;
24943
25230
  syncStatus: AccountSyncStatus | null;
24944
25231
  }
24945
- interface DeletePayableAccount_deletePayableAccount_BankAccount_institution {
25232
+ interface DeletePayableAccount_deletePayableAccount_DebitCard_institution {
24946
25233
  __typename: 'BankAccountInstitution' | 'BillInstitution';
24947
25234
  id: string;
24948
25235
  name: string;
24949
25236
  logo: string | null;
24950
25237
  }
24951
- interface DeletePayableAccount_deletePayableAccount_BankAccount_bankAccountDetails_CanadianBankAccountDetails {
24952
- __typename: 'CanadianBankAccountDetails' | 'UKBankAccountDetails' | 'IBANBankAccountDetails';
24953
- }
24954
- interface DeletePayableAccount_deletePayableAccount_BankAccount_bankAccountDetails_USBankAccountDetails {
24955
- __typename: 'USBankAccountDetails';
24956
- routingNumber: string;
24957
- }
24958
- type DeletePayableAccount_deletePayableAccount_BankAccount_bankAccountDetails = DeletePayableAccount_deletePayableAccount_BankAccount_bankAccountDetails_CanadianBankAccountDetails | DeletePayableAccount_deletePayableAccount_BankAccount_bankAccountDetails_USBankAccountDetails;
24959
- interface DeletePayableAccount_deletePayableAccount_BankAccount {
24960
- __typename: 'BankAccount';
25238
+ interface DeletePayableAccount_deletePayableAccount_DebitCard {
25239
+ __typename: 'DebitCard' | 'DigitalAccount' | 'OneTimePayment';
24961
25240
  id: string;
24962
25241
  name: string | null;
24963
25242
  userId: string;
@@ -24967,15 +25246,8 @@ interface DeletePayableAccount_deletePayableAccount_BankAccount {
24967
25246
  originator: PayableAccountOriginator;
24968
25247
  type: PayableAccountType;
24969
25248
  createdAt: any;
24970
- dataSync: DeletePayableAccount_deletePayableAccount_BankAccount_dataSync | null;
24971
- institution: DeletePayableAccount_deletePayableAccount_BankAccount_institution | null;
24972
- accountNumber: string;
24973
- bankAccountType: BankAccountType;
24974
- bankAccountSubType: BankAccountSubType;
24975
- holder: string;
24976
- email: string | null;
24977
- ownedByUser: boolean;
24978
- bankAccountDetails: DeletePayableAccount_deletePayableAccount_BankAccount_bankAccountDetails | null;
25249
+ dataSync: DeletePayableAccount_deletePayableAccount_DebitCard_dataSync | null;
25250
+ institution: DeletePayableAccount_deletePayableAccount_DebitCard_institution | null;
24979
25251
  }
24980
25252
  interface DeletePayableAccount_deletePayableAccount_Bill_dataSync {
24981
25253
  __typename: 'AccountDataSync';
@@ -25021,197 +25293,6 @@ interface DeletePayableAccount_deletePayableAccount_Bill {
25021
25293
  interface RenameBankAccount_renamePayableAccount_Bill {
25022
25294
  __typename: 'Bill' | 'DebitCard' | 'DigitalAccount' | 'OneTimePayment' | 'VirtualCard';
25023
25295
  }
25024
- interface RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails_CanadianBankAccountDetails {
25025
- __typename: 'CanadianBankAccountDetails' | 'UKBankAccountDetails' | 'IBANBankAccountDetails';
25026
- }
25027
- interface RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails_USBankAccountDetails {
25028
- __typename: 'USBankAccountDetails';
25029
- routingNumber: string;
25030
- }
25031
- type RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails = RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails_CanadianBankAccountDetails | RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails_USBankAccountDetails;
25032
- interface RenameBankAccount_renamePayableAccount_BankAccount_institution {
25033
- __typename: 'BankAccountInstitution' | 'BillInstitution';
25034
- id: string;
25035
- name: string;
25036
- logo: string | null;
25037
- country: string;
25038
- currency: string;
25039
- }
25040
- interface RenameBankAccount_renamePayableAccount_BankAccount_paymentAddresses {
25041
- __typename: 'PaymentAddress';
25042
- network: string;
25043
- address: string;
25044
- }
25045
- interface RenameBankAccount_renamePayableAccount_BankAccount {
25046
- __typename: 'BankAccount';
25047
- id: string;
25048
- name: string | null;
25049
- userId: string;
25050
- country: string;
25051
- currency: string;
25052
- createdAt: any;
25053
- type: PayableAccountType;
25054
- accountNumber: string;
25055
- bankAccountType: BankAccountType;
25056
- bankAccountSubType: BankAccountSubType;
25057
- email: string | null;
25058
- ownedByUser: boolean;
25059
- bankAccountDetails: RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails | null;
25060
- deliveryMethods: PaymentDeliveryMethod[];
25061
- institution: RenameBankAccount_renamePayableAccount_BankAccount_institution | null;
25062
- paymentAddresses: RenameBankAccount_renamePayableAccount_BankAccount_paymentAddresses[];
25063
- }
25064
-
25065
- type LinkTokenResponse = PathResponse<'/v1/bank-accounts/link-token', 'post'>;
25066
- type CompleteLinkingRequest = PathRequestBody<'/v1/bank-accounts/link-complete', 'post'>;
25067
- type BaseBankAccountInput = Omit<BankAccountInput, 'details' | 'type'>;
25068
- type UsBankAccountInput = BaseBankAccountInput & {
25069
- routingNumber: string;
25070
- };
25071
- type CaBankAccountInput = BaseBankAccountInput & {
25072
- transitNumber: string;
25073
- institutionNumber: string;
25074
- };
25075
- type IbanAccountInput = BaseBankAccountInput;
25076
- type UKBankAccountInput = BaseBankAccountInput & {
25077
- sortCode: string;
25078
- };
25079
- type CreateInputMapping$1 = {
25080
- [BankAccountType.USBankAccount]: UsBankAccountInput;
25081
- [BankAccountType.CABankAccount]: CaBankAccountInput;
25082
- [BankAccountType.IbanAccount]: IbanAccountInput;
25083
- [BankAccountType.UKBankAccount]: UKBankAccountInput;
25084
- };
25085
- declare class BankAccountService {
25086
- private client;
25087
- constructor(client: SpritzClient);
25088
- list(): Promise<UserBankAccounts_bankAccounts[]>;
25089
- rename(accountId: string, name: string): Promise<RenameBankAccount_renamePayableAccount_BankAccount>;
25090
- delete(accountId: string): Promise<DeletePayableAccount_deletePayableAccount_BankAccount>;
25091
- createLinkToken(): Promise<{
25092
- linkToken: string;
25093
- hostedLinkUrl: string | null;
25094
- expiration: string;
25095
- requestId: string;
25096
- }>;
25097
- completeLinking(input: CompleteLinkingRequest): Promise<{
25098
- bankAccounts: ({
25099
- id: string;
25100
- status: "active" | "pending" | "inactive" | "rejected";
25101
- accountHolderName: string;
25102
- institution?: {
25103
- name: string;
25104
- logo?: string;
25105
- };
25106
- supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
25107
- label?: string;
25108
- createdAt: string;
25109
- fundingSourceId: string | null;
25110
- type: "us";
25111
- currency: "USD";
25112
- accountNumberLast4: string;
25113
- routingNumberLast4: string;
25114
- accountSubtype?: "checking" | "savings";
25115
- } | {
25116
- id: string;
25117
- status: "active" | "pending" | "inactive" | "rejected";
25118
- accountHolderName: string;
25119
- institution?: {
25120
- name: string;
25121
- logo?: string;
25122
- };
25123
- supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
25124
- label?: string;
25125
- createdAt: string;
25126
- fundingSourceId: string | null;
25127
- type: "ca";
25128
- currency: "CAD";
25129
- accountNumberLast4: string;
25130
- institutionNumber: string;
25131
- transitNumberLast3: string;
25132
- accountSubtype?: "checking" | "savings";
25133
- } | {
25134
- id: string;
25135
- status: "active" | "pending" | "inactive" | "rejected";
25136
- accountHolderName: string;
25137
- institution?: {
25138
- name: string;
25139
- logo?: string;
25140
- };
25141
- supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
25142
- label?: string;
25143
- createdAt: string;
25144
- fundingSourceId: string | null;
25145
- type: "uk";
25146
- currency: "GBP";
25147
- accountNumberLast4: string;
25148
- sortCode: string;
25149
- } | {
25150
- id: string;
25151
- status: "active" | "pending" | "inactive" | "rejected";
25152
- accountHolderName: string;
25153
- institution?: {
25154
- name: string;
25155
- logo?: string;
25156
- };
25157
- supportedRails: ("ach_standard" | "ach_same_day" | "rtp" | "wire" | "eft" | "sepa" | "faster_payments" | "push_to_card" | "bill_pay" | "card_deposit")[];
25158
- label?: string;
25159
- createdAt: string;
25160
- fundingSourceId: string | null;
25161
- type: "iban";
25162
- currency: "USD" | "CAD" | "EUR" | "GBP";
25163
- ibanLast4: string;
25164
- bic?: string;
25165
- })[];
25166
- }>;
25167
- create<T extends BankAccountType>(type: T, input: CreateInputMapping$1[T]): Promise<CreateBankAccount_createBankAccount>;
25168
- }
25169
-
25170
- interface CreateUSBill_addUSBill_billAccountDetails {
25171
- __typename: 'BillAccountDetails';
25172
- balance: number | null;
25173
- amountDue: number | null;
25174
- openedAt: any | null;
25175
- lastPaymentAmount: number | null;
25176
- lastPaymentDate: any | null;
25177
- nextPaymentDueDate: any | null;
25178
- nextPaymentMinimumAmount: number | null;
25179
- lastStatementBalance: number | null;
25180
- remainingStatementBalance: number | null;
25181
- }
25182
- interface CreateUSBill_addUSBill_dataSync {
25183
- __typename: 'AccountDataSync';
25184
- lastSync: any | null;
25185
- syncStatus: AccountSyncStatus | null;
25186
- }
25187
- interface CreateUSBill_addUSBill_institution {
25188
- __typename: 'BankAccountInstitution' | 'BillInstitution';
25189
- id: string;
25190
- name: string;
25191
- logo: string | null;
25192
- }
25193
- interface CreateUSBill_addUSBill_paymentAddresses {
25194
- __typename: 'PaymentAddress';
25195
- network: string;
25196
- address: string;
25197
- }
25198
- interface CreateUSBill_addUSBill {
25199
- __typename: 'Bill';
25200
- id: string;
25201
- name: string | null;
25202
- userId: string;
25203
- country: string;
25204
- currency: string;
25205
- originator: PayableAccountOriginator;
25206
- payable: boolean;
25207
- verifying: boolean;
25208
- billType: BillType;
25209
- createdAt: any;
25210
- billAccountDetails: CreateUSBill_addUSBill_billAccountDetails | null;
25211
- dataSync: CreateUSBill_addUSBill_dataSync | null;
25212
- institution: CreateUSBill_addUSBill_institution | null;
25213
- paymentAddresses: CreateUSBill_addUSBill_paymentAddresses[];
25214
- }
25215
25296
 
25216
25297
  declare class BillService {
25217
25298
  private client;
@@ -26082,4 +26163,4 @@ declare class InternalServerError extends APIError {
26082
26163
  }
26083
26164
 
26084
26165
  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 };
26085
- export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CategoryAccess, ClientOptions, CompleteLinkingRequest, CreateDepositRequest, CreateDepositWithReturnRequest, CreateDepositWithReturnResponse, CreateDirectPaymentInput, CreateOnrampPaymentInput, CreatePaymentRequestInput, CreateVirtualAccountInput, CreateWebhookParams, CurrentUser, CurrentUser_me, CurrentUser_verification, CurrentUser_verification_identity, CurrentUser_verification_identity_verificationMetadata, CurrentUser_verification_identity_verificationMetadata_details, DebitCardFragment, DebitCardInput, Deposit, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkTokenResponse, OnRamp, OnRampDetail, OnRampListQuery, OnRampListResponse, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PathParams, PathQuery, PathRequestBody, PathResponse, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentFragment_transaction, PaymentLimits, PaymentLimitsResponse, PaymentLimitsVariables, PaymentLimits_paymentLimits, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, PrepareDepositRequest, PrepareDepositResponse, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, TokenBalanceFragment, UpdateWebhookParams, UpdateWebhookSecretResponse, UserAccess, UserAccessCapabilities, UserAccess_bridgeUser, UserAccess_me, UserAccess_verification, UserAccess_verification_identity, UserAccess_verification_identity_verificationMetadata, UserAccess_verification_identity_verificationMetadata_details, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, UserVerification, UserVerification_verification, UserVerification_verification_identity, UserVerification_verification_identity_user, UserVerification_verification_identity_verificationMetadata, UserVerification_verification_identity_verificationMetadata_details, UserVirtualDebitCard, UserVirtualDebitCard_virtualDebitCard, UserVirtualDebitCard_virtualDebitCard_billingInfo, UserVirtualDebitCard_virtualDebitCard_billingInfo_address, UserVirtualDebitCard_virtualDebitCard_paymentAddresses, VerificationFragment, VerificationFragment_identity, VerificationFragment_identity_verificationMetadata, VerificationFragment_identity_verificationMetadata_details, VirtualAccountFragment, VirtualAccountFragment_depositInstructions, VirtualAccounts, VirtualAccounts_virtualAccounts, VirtualAccounts_virtualAccounts_depositInstructions, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances, WebhookEvent };
26166
+ export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, AchDebitReturn, AchDebitReturnListQuery, AchDebitReturnListResponse, BankAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BankAccountList, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, BypassKycRequest, CategoryAccess, ClientOptions, CompleteLinkingRequest, CompleteLinkingResponse, CreateBankAccountInput, CreateBankAccountResponse, CreateDepositRequest, CreateDepositWithReturnRequest, CreateDepositWithReturnResponse, CreateDirectPaymentInput, CreateOnrampPaymentInput, CreatePaymentRequestInput, CreateVirtualAccountInput, CreateWebhookParams, CurrentUser, CurrentUser_me, CurrentUser_verification, CurrentUser_verification_identity, CurrentUser_verification_identity_verificationMetadata, CurrentUser_verification_identity_verificationMetadata_details, DebitCardFragment, DebitCardInput, DeleteBankAccountResponse, Deposit, FullBridgeUser, FundingSource, FundingSourceDepositLimits, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, IntegratorWebhook, KycStatus, LinkTokenResponse, OnRamp, OnRampDetail, OnRampListQuery, OnRampListResponse, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PathParams, PathQuery, PathRequestBody, PathResponse, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentFragment_transaction, PaymentLimits, PaymentLimitsResponse, PaymentLimitsVariables, PaymentLimits_paymentLimits, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, PrepareDepositRequest, PrepareDepositResponse, Requirement, operations as RestApiOperations, paths as RestApiPaths, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, TokenBalanceFragment, UpdateWebhookParams, UpdateWebhookSecretResponse, UserAccess, UserAccessCapabilities, UserAccess_bridgeUser, UserAccess_me, UserAccess_verification, UserAccess_verification_identity, UserAccess_verification_identity_verificationMetadata, UserAccess_verification_identity_verificationMetadata_details, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, UserVerification, UserVerification_verification, UserVerification_verification_identity, UserVerification_verification_identity_user, UserVerification_verification_identity_verificationMetadata, UserVerification_verification_identity_verificationMetadata_details, UserVirtualDebitCard, UserVirtualDebitCard_virtualDebitCard, UserVirtualDebitCard_virtualDebitCard_billingInfo, UserVirtualDebitCard_virtualDebitCard_billingInfo_address, UserVirtualDebitCard_virtualDebitCard_paymentAddresses, VerificationFragment, VerificationFragment_identity, VerificationFragment_identity_verificationMetadata, VerificationFragment_identity_verificationMetadata_details, VirtualAccountFragment, VirtualAccountFragment_depositInstructions, VirtualAccounts, VirtualAccounts_virtualAccounts, VirtualAccounts_virtualAccounts_depositInstructions, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances, WebhookEvent };