@maxio-com/advanced-billing-sdk/src/models/subscriptionGroupBankAccount.ts

Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments.

/**
 * AdvancedBilling
 *
 * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import { expandoObject, optional, Schema, string } from '../schema';
import {
  BankAccountHolderType,
  bankAccountHolderTypeSchema,
} from './bankAccountHolderType';
import { BankAccountType, bankAccountTypeSchema } from './bankAccountType';
import { BankAccountVault, bankAccountVaultSchema } from './bankAccountVault';
import { PaymentType, paymentTypeSchema } from './paymentType';

export interface SubscriptionGroupBankAccount {
  /** (Required when creating a subscription with ACH or GoCardless) The name of the bank where the customer’s account resides */
  bankName?: string;
  /** (Required when creating a subscription with ACH. Required when creating a subscription with GoCardless and bank_iban is blank) The customerʼs bank account number */
  bankAccountNumber?: string;
  /** (Required when creating a subscription with ACH. Optional when creating a subscription with GoCardless). The routing number of the bank. It becomes bank_code while passing via GoCardless API */
  bankRoutingNumber?: string;
  /** (Optional when creating a subscription with GoCardless). International Bank Account Number. Alternatively, local bank details can be provided */
  bankIban?: string;
  /** (Optional when creating a subscription with GoCardless) Branch code. Alternatively, an IBAN can be provided */
  bankBranchCode?: string;
  /** Defaults to checking */
  bankAccountType?: BankAccountType;
  /** Defaults to personal */
  bankAccountHolderType?: BankAccountHolderType;
  paymentType?: PaymentType;
  billingAddress?: string;
  billingCity?: string;
  billingState?: string;
  billingZip?: string;
  billingCountry?: string;
  chargifyToken?: string;
  /** The vault that stores the payment profile with the provided vault_token. Use `bogus` for testing. */
  currentVault?: BankAccountVault;
  gatewayHandle?: string;
  [key: string]: unknown;
}

export const subscriptionGroupBankAccountSchema: Schema<SubscriptionGroupBankAccount> = expandoObject(
  {
    bankName: ['bank_name', optional(string())],
    bankAccountNumber: ['bank_account_number', optional(string())],
    bankRoutingNumber: ['bank_routing_number', optional(string())],
    bankIban: ['bank_iban', optional(string())],
    bankBranchCode: ['bank_branch_code', optional(string())],
    bankAccountType: ['bank_account_type', optional(bankAccountTypeSchema)],
    bankAccountHolderType: [
      'bank_account_holder_type',
      optional(bankAccountHolderTypeSchema),
    ],
    paymentType: ['payment_type', optional(paymentTypeSchema)],
    billingAddress: ['billing_address', optional(string())],
    billingCity: ['billing_city', optional(string())],
    billingState: ['billing_state', optional(string())],
    billingZip: ['billing_zip', optional(string())],
    billingCountry: ['billing_country', optional(string())],
    chargifyToken: ['chargify_token', optional(string())],
    currentVault: ['current_vault', optional(bankAccountVaultSchema)],
    gatewayHandle: ['gateway_handle', optional(string())],
  }
);