interface-forge - v2.5.0
    Preparing search index...

    Class FinanceModule

    Module to generate finance and money related entries.

    For a random amount, use amount().

    For traditional bank accounts, use: accountNumber(), accountName(), bic(), iban(), pin() and routingNumber().

    For credit card related methods, use: creditCardNumber(), creditCardCVV(), creditCardIssuer(), transactionDescription() and transactionType().

    For blockchain related methods, use: bitcoinAddress(), ethereumAddress() and litecoinAddress().

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    faker

    Methods

    accountName accountNumber amount bic bitcoinAddress creditCardCVV creditCardIssuer creditCardNumber currency currencyCode currencyName currencyNumericCode currencySymbol ethereumAddress iban litecoinAddress maskedNumber pin routingNumber transactionDescription transactionType

    Constructors

    Properties

    faker: Faker

    Methods

    • Generates a random account name.

      Returns string

      faker.finance.accountName() // 'Personal Loan Account'

      2.0.1

    • Generates a random account number.

      Parameters

      • Optionallength: number

        The length of the account number. Defaults to 8.

      Returns string

      faker.string.numeric(): For generating the number with greater control.

      faker.finance.accountNumber() // '92842238'
      faker.finance.accountNumber(5) // '32564'

      8.0.0

    • Generates a random account number.

      Parameters

      • Optionaloptions: { length?: number }

        An options object.

        • Optionallength?: number

          The length of the account number.

          8

      Returns string

      faker.string.numeric(): For generating the number with greater control.

      faker.finance.accountNumber() // '92842238'
      faker.finance.accountNumber({ length: 5 }) // '32564'

      8.0.0

    • Generates a random account number.

      Parameters

      • OptionaloptionsOrLength: number | { length?: number }

        An options object or the length of the account number.

        • number
        • { length?: number }
          • Optionallength?: number

            The length of the account number.

            8

      Returns string

      faker.string.numeric(): For generating the number with greater control.

      faker.finance.accountNumber() // '92842238'
      faker.finance.accountNumber(5) // '28736'
      faker.finance.accountNumber({ length: 5 }) // '32564'

      8.0.0

    • Generates a random amount between the given bounds (inclusive).

      Parameters

      • Optionaloptions: {
            autoFormat?: boolean;
            dec?: number;
            max?: number;
            min?: number;
            symbol?: string;
        }

        An options object.

        • OptionalautoFormat?: boolean

          If true this method will use Number.toLocaleString(). Otherwise it will use Number.toFixed().

          false
        • Optionaldec?: number

          The number of decimal places for the amount.

          2
        • Optionalmax?: number

          The upper bound for the amount.

          1000
        • Optionalmin?: number

          The lower bound for the amount.

          0
        • Optionalsymbol?: string

          The symbol used to prefix the amount.

          ''

      Returns string

      faker.number.float(): For generating the amount with greater control.

      faker.finance.amount() // '617.87'
      faker.finance.amount({ min: 5, max: 10 }) // '5.53'
      faker.finance.amount({ min: 5, max: 10, dec: 0 }) // '8'
      faker.finance.amount({ min: 5, max: 10, dec: 2, symbol: '$' }) // '$5.85'
      faker.finance.amount({ min: 5, max: 10, dec: 5, symbol: '', autoFormat: true }) // '9,75067'

      2.0.1

    • Generates a random SWIFT/BIC code based on the ISO-9362 format.

      Parameters

      • Optionaloptions: { includeBranchCode?: boolean }

        Options object.

        • OptionalincludeBranchCode?: boolean

          Whether to include a three-digit branch code at the end of the generated code.

          faker.datatype.boolean()

      Returns string

      faker.finance.bic() // 'WYAUPGX1'
      faker.finance.bic({ includeBranchCode: true }) // 'KCAUPGR1432'
      faker.finance.bic({ includeBranchCode: false }) // 'XDAFQGT7'

      4.0.0

    • Generates a random Bitcoin address.

      Parameters

      • Optionaloptions: {
            network?: "mainnet" | "testnet";
            type?: "legacy" | "segwit" | "bech32" | "taproot";
        }

        An optional options object.

        • Optionalnetwork?: "mainnet" | "testnet"

          The bitcoin network ('mainnet' or 'testnet').

          'mainnet'
        • Optionaltype?: "legacy" | "segwit" | "bech32" | "taproot"

          The bitcoin address type ('legacy', 'sewgit', 'bech32' or 'taproot').

          faker.helpers.arrayElement(['legacy','sewgit','bech32','taproot'])

      Returns string

      faker.finance.bitcoinAddress() // '1TeZEFLmGPLEQrSRdAcnZLoWwYeiHwmRog'
      faker.finance.bitcoinAddress({ type: 'bech32' }) // 'bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4'
      faker.finance.bitcoinAddress({ type: 'bech32', network: 'testnet' }) // 'tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx'

      3.1.0

    • Generates a random credit card CVV.

      Returns string

      faker.finance.creditCardCVV() // '506'

      5.0.0

    • Returns a random credit card issuer.

      Returns string

      faker.finance.creditCardIssuer() // 'discover'

      6.3.0

    • Generates a random credit card number.

      Parameters

      • Optionalissuer: string

        The name of the issuer (case-insensitive) or the format used to generate one.

      Returns string

      faker.finance.creditCardNumber() // '4427163488662'
      faker.finance.creditCardNumber('visa') // '4882664999007'
      faker.finance.creditCardNumber('63[7-9]#-####-####-###L') // '6375-3265-4676-6646'

      5.0.0

    • Generates a random credit card number.

      Parameters

      • Optionaloptions: { issuer?: string }

        An options object.

        • Optionalissuer?: string

          The name of the issuer (case-insensitive) or the format used to generate one.

          ''

      Returns string

      faker.finance.creditCardNumber() // '4427163488662'
      faker.finance.creditCardNumber({ issuer: 'visa' }) // '4882664999007'
      faker.finance.creditCardNumber({ issuer: '63[7-9]#-####-####-###L' }) // '6375-3265-4676-6646'

      5.0.0

    • Generates a random credit card number.

      Parameters

      • Optionaloptions: string | { issuer?: string }

        An options object, the issuer or a custom format.

        • string
        • { issuer?: string }
          • Optionalissuer?: string

            The name of the issuer (case-insensitive) or the format used to generate one.

            ''

      Returns string

      faker.finance.creditCardNumber() // '4427163488662'
      faker.finance.creditCardNumber({ issuer: 'visa' }) // '4882664999007'
      faker.finance.creditCardNumber({ issuer: '63[7-9]#-####-####-###L' }) // '6375-3265-4676-6646'
      faker.finance.creditCardNumber('visa') // '1226423499765'

      5.0.0

    • Returns a random currency object, containing code, name, symbol, and numericCode properties.

      Returns Currency

      • faker.finance.currencyCode(): For generating specifically the currency code.
      • faker.finance.currencyName(): For generating specifically the currency name.
      • faker.finance.currencySymbol(): For generating specifically the currency symbol.
      • faker.finance.currencyNumericCode(): For generating specifically the currency numeric code.
      faker.finance.currency() // { code: 'USD', name: 'US Dollar', symbol: '$', numericCode: '840' }

      8.0.0

    • Returns a random currency code. (The short text/abbreviation for the currency (e.g. US Dollar -> USD))

      Returns string

      faker.finance.currencyCode() // 'USD'

      2.0.1

    • Returns a random currency name.

      Returns string

      faker.finance.currencyName() // 'US Dollar'

      2.0.1

    • Returns a random currency numeric code. (The ISO 4217 numerical code for a currency (e.g. US Dollar -> 840 ))

      Returns string

      faker.finance.currencyNumericCode() // '840'

      9.6.0

    • Returns a random currency symbol.

      Returns string

      faker.finance.currencySymbol() // '$'

      2.0.1

    • Creates a random, non-checksum Ethereum address.

      To generate a checksummed Ethereum address (with specific per character casing), wrap this method in a custom method and use third-party libraries to transform the result.

      Returns string

      faker.finance.ethereumAddress() // '0xf03dfeecbafc5147241cc4c4ca20b3c9dfd04c4a'

      5.0.0

    • Generates a random IBAN.

      Please note that the generated IBAN might be invalid due to randomly generated bank codes/other country specific validation rules.

      Parameters

      • Optionaloptions: { countryCode?: string; formatted?: boolean }

        An options object.

        • OptionalcountryCode?: string

          The country code from which you want to generate an IBAN, if none is provided a random country will be used.

        • Optionalformatted?: boolean

          Return a formatted version of the generated IBAN.

          false

      Returns string

      Will throw an error if the passed country code is not supported.

      faker.finance.iban() // 'TR736918640040966092800056'
      faker.finance.iban({ formatted: true }) // 'FR20 8008 2330 8984 74S3 Z620 224'
      faker.finance.iban({ formatted: true, countryCode: 'DE' }) // 'DE84 1022 7075 0900 1170 01'

      4.0.0

    • Generates a random Litecoin address.

      Returns string

      faker.finance.litecoinAddress() // 'MoQaSTGWBRXkWfyxKbNKuPrAWGELzcW'

      5.0.0

    • Generates a random masked number.

      Parameters

      • Optionallength: number

        The length of the unmasked number. Defaults to 4.

      Returns string

      faker.finance.maskedNumber() // '(...9711)'
      faker.finance.maskedNumber(3) // '(...342)'

      8.0.0

      Use faker.finance.iban().replace(/(?<=.{4})\w(?=.{2})/g, '*') or a similar approach instead.

    • Generates a random masked number.

      Parameters

      • Optionaloptions: { ellipsis?: boolean; length?: number; parens?: boolean }

        An options object.

        • Optionalellipsis?: boolean

          Whether to prefix the numbers with an ellipsis.

          true
        • Optionallength?: number

          The length of the unmasked number.

          4
        • Optionalparens?: boolean

          Whether to use surrounding parenthesis.

          true

      Returns string

      faker.finance.maskedNumber() // '(...9711)'
      faker.finance.maskedNumber({ length: 3 }) // '(...342)'
      faker.finance.maskedNumber({ length: 3, parens: false }) // '...236'
      faker.finance.maskedNumber({ length: 3, parens: false, ellipsis: false }) // '298'

      8.0.0

      Use faker.finance.iban().replace(/(?<=.{4})\w(?=.{2})/g, '*') or a similar approach instead.

    • Generates a random masked number.

      Parameters

      • OptionaloptionsOrLength: number | { ellipsis?: boolean; length?: number; parens?: boolean }

        An options object or the length of the unmask number.

        • number
        • { ellipsis?: boolean; length?: number; parens?: boolean }
          • Optionalellipsis?: boolean

            Whether to prefix the numbers with an ellipsis.

            true
          • Optionallength?: number

            The length of the unmasked number.

            4
          • Optionalparens?: boolean

            Whether to use surrounding parenthesis.

            true

      Returns string

      faker.finance.maskedNumber() // '(...9711)'
      faker.finance.maskedNumber(3) // '(...342)'
      faker.finance.maskedNumber({ length: 3 }) // '(...342)'
      faker.finance.maskedNumber({ length: 3, parens: false }) // '...236'
      faker.finance.maskedNumber({ length: 3, parens: false, ellipsis: false }) // '298'

      8.0.0

      Use faker.finance.iban().replace(/(?<=.{4})\w(?=.{2})/g, '*') or a similar approach instead.

    • Generates a random PIN number.

      Parameters

      • Optionallength: number

        The length of the PIN to generate. Defaults to 4.

      Returns string

      Will throw an error if length is less than 1.

      faker.string.numeric(): For generating the pin with greater control.

      faker.finance.pin() // '5067'
      faker.finance.pin(6) // '213789'

      6.2.0

    • Generates a random PIN number.

      Parameters

      • Optionaloptions: { length?: number }

        An options object.

        • Optionallength?: number

          The length of the PIN to generate.

          4

      Returns string

      Will throw an error if length is less than 1.

      faker.string.numeric(): For generating the pin with greater control.

      faker.finance.pin() // '5067'
      faker.finance.pin({ length: 6 }) // '213789'

      6.2.0

    • Generates a random PIN number.

      Parameters

      • Optionaloptions: number | { length?: number }

        An options object or the length of the PIN.

        • number
        • { length?: number }
          • Optionallength?: number

            The length of the PIN to generate.

            4

      Returns string

      Will throw an error if length is less than 1.

      faker.string.numeric(): For generating the pin with greater control.

      faker.finance.pin() // '5067'
      faker.finance.pin({ length: 6 }) // '213789'
      faker.finance.pin(6) // '213789'

      6.2.0

    • Generates a random routing number.

      Returns string

      faker.finance.routingNumber() // '522814402'

      5.0.0

    • Generates a random transaction description.

      Returns string

      faker.finance.transactionDescription()
      // 'payment transaction at Emard LLC using card ending with ****9187 for HNL 506.57 in account ***2584.'

      5.1.0

    • Returns a random transaction type.

      Returns string

      faker.finance.transactionType() // 'payment'

      2.0.1

    Settings

    Member Visibility

    On This Page

    Overview
    Constructors
    Properties
    Methods