Finance

Module to generate finance and money related entries.

Overview

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().

accountName

Generates a random account name.

Available since v2.0.1

Returns: string

function accountName(): string;
faker.finance.accountName() // 'Personal Loan Account'

Source

• View Source

accountNumber

Generates a random account number.

Available since v8.0.0

Parameters

Name	Type	Default	Description
optionsOrLength?	number | { ... }		An options object or the length of the account number.
optionsOrLength.length?	number	8	The length of the account number.

Returns: string

function accountNumber(
    optionsOrLength?:
      | number
      | {
          length?: number;
        }
  ): string;
faker.finance.accountNumber() // 92842238
faker.finance.accountNumber(5) // 28736
faker.finance.accountNumber({ length: 5 }) // 32564

Source

• View Source

amount

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

Available since v2.0.1

Parameters

Name	Type	Default	Description
options	{ ... }	{}	An options object.
options.autoFormat?	boolean	false	If true this method will use Number.toLocaleString(). Otherwise it will use Number.toFixed().
options.dec?	number	2	The number of decimal places for the amount.
options.max?	number	1000	The upper bound for the amount.
options.min?	number	0	The lower bound for the amount.
options.symbol?	string	''	The symbol used to prefix the amount.

Returns: string

function amount(
    options: {
      min?: number;
      max?: number;
      dec?: number;
      symbol?: string;
      autoFormat?: boolean;
    } = {}
  ): string;
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'

Source

• View Source

bic

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

Available since v4.0.0

Parameters

Name	Type	Default	Description
options	{ ... }	{}	Options object.
options.includeBranchCode?	boolean	faker.datatype.boolean()	Whether to include a three-digit branch code at the end of the generated code.

Returns: string

function bic(
    options: {
      includeBranchCode?: boolean;
    } = {}
  ): string;
faker.finance.bic() // 'WYAUPGX1'
faker.finance.bic({ includeBranchCode: true }) // 'KCAUPGR1432'
faker.finance.bic({ includeBranchCode: false }) // 'XDAFQGT7'

Source

• View Source

bitcoinAddress

Generates a random Bitcoin address.

Available since v3.1.0

Returns: string

function bitcoinAddress(): string;
faker.finance.bitcoinAddress() // '3ySdvCkTLVy7gKD4j6JfSaf5d'

Source

• View Source

creditCardCVV

Generates a random credit card CVV.

Available since v5.0.0

Returns: string

function creditCardCVV(): string;
faker.finance.creditCardCVV() // '506'

Source

• View Source

creditCardIssuer

Returns a random credit card issuer.

Available since v6.3.0

Returns: string

function creditCardIssuer(): string;
faker.finance.creditCardIssuer() // 'discover'

Source

• View Source

creditCardNumber

Generates a random credit card number.

Available since v5.0.0

Parameters

Name	Type	Default	Description
options?	string | { ... }	{}	An options object, the issuer or a custom format.
options.issuer?	string	''	The name of the issuer (case-insensitive) or the format used to generate one.

Returns: string

function creditCardNumber(
    options?:
      | string
      | {
          issuer?: string;
        }
  ): 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'

Source

• View Source

currency

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

Available since v8.0.0

Returns: Currency

function currency(): Currency;
faker.finance.currency() // { code: 'USD', name: 'US Dollar', symbol: '$' }

See Also

• 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.

Source

• View Source

currencyCode

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

Available since v2.0.1

Returns: string

function currencyCode(): string;
faker.finance.currencyCode() // 'USD'

Source

• View Source

currencyName

Returns a random currency name.

Available since v2.0.1

Returns: string

function currencyName(): string;
faker.finance.currencyName() // 'US Dollar'

Source

• View Source

currencySymbol

Returns a random currency symbol.

Available since v2.0.1

Returns: string

function currencySymbol(): string;
faker.finance.currencySymbol() // '$'

Source

• View Source

ethereumAddress

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.

Available since v5.0.0

Returns: string

function ethereumAddress(): string;
faker.finance.ethereumAddress() // '0xf03dfeecbafc5147241cc4c4ca20b3c9dfd04c4a'

Source

• View Source

iban

Generates a random iban.

Available since v4.0.0

Parameters

Name	Type	Default	Description
options	{ ... }	{}	An options object.
options.countryCode?	string		The country code from which you want to generate an IBAN, if none is provided a random country will be used.
options.formatted?	boolean	false	Return a formatted version of the generated IBAN.

Returns: string

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

function iban(
    options: {
      formatted?: boolean;
      countryCode?: string;
    } = {}
  ): string;
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'

Source

• View Source

litecoinAddress

Generates a random Litecoin address.

Available since v5.0.0

Returns: string

function litecoinAddress(): string;
faker.finance.litecoinAddress() // 'MoQaSTGWBRXkWfyxKbNKuPrAWGELzcW'

Source

• View Source

maskedNumber

Generates a random masked number.

Available since v8.0.0

Parameters

Name	Type	Default	Description
optionsOrLength?	number | { ... }		An options object or the length of the unmask number.
optionsOrLength.ellipsis?	boolean	true	Whether to prefix the numbers with an ellipsis.
optionsOrLength.length?	number	4	The length of the unmasked number.
optionsOrLength.parens?	boolean	true	Whether to use surrounding parenthesis.

Returns: string

function maskedNumber(
    optionsOrLength?:
      | number
      | {
          length?: number;
          parens?: boolean;
          ellipsis?: boolean;
        }
  ): 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'

Source

• View Source

pin

Generates a random PIN number.

Available since v6.2.0

Parameters

Name	Type	Default	Description
options?	number | { ... }	{}	An options object or the length of the PIN.
options.length?	number	4	The length of the PIN to generate.

Returns: string

Throws: Will throw an error if length is less than 1.

function pin(
    options?:
      | number
      | {
          length?: number;
        }
  ): string;
faker.finance.pin() // '5067'
faker.finance.pin({ length: 6 }) // '213789'
faker.finance.pin(6) // '213789'

Source

• View Source

routingNumber

Generates a random routing number.

Available since v5.0.0

Returns: string

function routingNumber(): string;
faker.finance.routingNumber() // '522814402'

Source

• View Source

transactionDescription

Generates a random transaction description.

Available since v5.1.0

Returns: string

function transactionDescription(): string;
faker.finance.transactionDescription()
// 'invoice transaction at Kilback - Durgan using card ending with ***(...4316) for UAH 783.82 in account ***16168663'

Source

• View Source

transactionType

Returns a random transaction type.

Available since v2.0.1

Returns: string

function transactionType(): string;
faker.finance.transactionType() // 'payment'

Source

• View Source