Skip to main content

finance Domain

The finance domain maps domain keywords to underlying faker implementations.

Faker Documentation​

Methods​

finance.accountName​

Generates a random account name.

No parameters.

Examples:

finance.accountName()

Example return values:

  • "Savings Account"
  • "Home Loan Account"

finance.accountNumber​

Generates a random account number.

ArgTypeRequiredDescription
lengthnumbernoDesired length of the generated value.

Examples:

finance.accountNumber()
finance.accountNumber(length=1)

Example return values:

  • "49018866"
  • "60456794"

finance.amount​

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

ArgTypeRequiredDescription
autoFormatbooleannoIf true this method will use Number.toLocaleString(). Otherwise it will use Number.toFixed().
decnumbernoThe number of decimal places for the amount.
maxnumbernoThe upper bound for the amount.
minnumbernoThe lower bound for the amount.
symbolstringnoThe symbol used to prefix the amount.

Examples:

finance.amount()
finance.amount(autoFormat=true, dec=1, max=1, min=1, symbol="$")

Example return values:

  • "149.16"
  • "691.98"

finance.bic​

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

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

Examples:

finance.bic()
finance.bic(includeBranchCode=true)

Example return values:

  • "JAHFCDRAXXX"
  • "HDJFBRUQ"

finance.bitcoinAddress​

Generates a random Bitcoin address.

No parameters.

Examples:

finance.bitcoinAddress()

Example return values:

  • "bc1pzsw5kl430n3mlhd5snxf8jsn8w8pkn5szswd2vdgswryyd6reuhljezh79"
  • "bc1y7ndstl65j0lqw6zn65e7c2aglznrqyect4sejh"

finance.creditCardCVV​

Generates a random credit card CVV.

No parameters.

Examples:

finance.creditCardCVV()

Example return values:

  • "642"
  • "505"

finance.creditCardIssuer​

Returns a random credit card issuer.

No parameters.

Examples:

finance.creditCardIssuer()

Example return values:

  • "diners_club"
  • "discover"

finance.creditCardNumber​

Generates a random credit card number.

ArgTypeRequiredDescription
issuerstringnoIssuer or provider value used to constrain generated output.

Examples:

finance.creditCardNumber()
finance.creditCardNumber(issuer="visa")

Example return values:

  • "4253595338386"
  • "3680-760929-2509"

finance.currency​

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

No parameters.

Examples:

finance.currency()

Example return values:

  • {"name":"Pakistan Rupee","code":"PKR","symbol":"₨","numericCode":"586"}
  • {"name":"Bahraini Dinar","code":"BHD","symbol":"","numericCode":"048"}

finance.currencyCode​

Returns a random currency code.

No parameters.

Examples:

finance.currencyCode()

Example return values:

  • "HNL"
  • "VND"

finance.currencyName​

Returns a random currency name.

No parameters.

Examples:

finance.currencyName()

Example return values:

  • "Tugrik"
  • "Lilangeni"

finance.currencyNumericCode​

Returns a random currency numeric code.

No parameters.

Examples:

finance.currencyNumericCode()

Example return values:

  • "784"

finance.currencySymbol​

Returns a random currency symbol.

No parameters.

Examples:

finance.currencySymbol()

Example return values:

  • "₨"
  • "kr"

finance.ethereumAddress​

Creates a random, non-checksum Ethereum address.

No parameters.

Examples:

finance.ethereumAddress()

Example return values:

  • "0x607cf8c49d90bd4d367fd5dc2fc4af6bebdedf17"
  • "0xff0d2ab192cfbeb8ebcd74c4306eceb3f150ae70"

finance.iban​

Generates a random IBAN.

ArgTypeRequiredDescription
countryCodestringnoThe country code from which you want to generate an IBAN, if none is provided a random country will be used.
formattedbooleannoReturn a formatted version of the generated IBAN.

Examples:

finance.iban()
finance.iban(countryCode="GB", formatted=true)

Example return values:

  • "IE60XZAD39998435857068"
  • "NO1827072008009"

finance.litecoinAddress​

Generates a random Litecoin address.

No parameters.

Examples:

finance.litecoinAddress()

Example return values:

  • "Mx5xmnGzMKFjCoEa4sP7AtsMHWMqY1M7a"
  • "MUt8eNXLSYpeiDoKiTof8BetGJpuM"

finance.maskedNumber​

Generates a random masked number.

ArgTypeRequiredDescription
lengthnumbernoDesired length of the generated value.

Examples:

finance.maskedNumber()
finance.maskedNumber(length=1)

Example return values:

  • "(...0214)"
  • "(...5189)"

finance.pin​

Generates a random PIN number.

ArgTypeRequiredDescription
lengthnumbernoDesired length of the generated value.

Examples:

finance.pin()
finance.pin(length=1)

Example return values:

  • "3243"
  • "9247"

finance.routingNumber​

Generates a random routing number.

No parameters.

Examples:

finance.routingNumber()

Example return values:

  • "128948329"
  • "799587533"

finance.transactionDescription​

Generates a random transaction description.

No parameters.

Examples:

finance.transactionDescription()

Example return values:

  • "Your deposit of YER 512.78 at Schoen and Sons was successful. Charged via card ****1684 to account ***5866."
  • "payment at Gislason, Herzog and Ankunding with a card ending in ****9045 for PYG 683.99 from account ***3048."

finance.transactionType​

Returns a random transaction type.

No parameters.

Examples:

finance.transactionType()

Example return values:

  • "deposit"
  • "payment"