Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Learning Center
  • Back to home
  • Dynamic values Modules
  • Airline
  • Animal
  • Color
  • Commerce
  • Company
  • Database
  • Datatype
  • Date
  • Finance
  • Food
  • Git
  • Hacker
  • Helpers
  • Image
  • Internet
  • Location
  • Lorem
  • Music
  • Number
  • Person
  • Phone
  • Science
  • String
  • System
  • Vehicle
  • Word
  1. Learning Center

Finance

Module to generate finance and money related entries.
Overview
For a random amount, use {{$finance.amount}}.
For traditional bank accounts, use: {{$finance.accountNumber}}, {{$finance.accountName}}, {{$finance.bic}}, {{$finance.iban}}, {{$finance.pin}} and {{$finance.routingNumber}}.
For credit card related methods, use: {{$finance.creditCardNumber}}, {{$finance.creditCardCVV}}, {{$finance.creditCardIssuer}}, {{$finance.transactionDescription}} and {{$finance.transactionType}}.
For blockchain related methods, use: {{$finance.bitcoinAddress}}, {{$finance.ethereumAddress}} and {{$finance.litecoinAddress}}.

accountName#

Generates a random account name.
Returns: string
Examples

accountNumber#

Generates a random account number.
Parameters
NameTypeDefaultDescription
lengthnumber8The length of the account number.
Returns: string
Examples

amount#

Generates a random amount between the given bounds (inclusive).
Parameters
NameTypeDefaultDescription
autoFormatbooleanfalse
decnumber2The number of decimal places for the amount.
maxnumber1000The upper bound for the amount.
minnumber0The lower bound for the amount.
symbolstring''The symbol used to prefix the amount.
Returns: string
Examples

bic#

Generates a random SWIFT/BIC code based on the ISO-9362 format.
Parameters
NameTypeDefaultDescription
includeBranchCodeboolean{{$datatype.boolean}}Whether to include a three-digit branch code at the end of the generated code.
Returns: string
Examples

bitcoinAddress#

Generates a random Bitcoin address.
Parameters
NameTypeDefaultDescription
network'mainnet' | 'testnet'mainnetThe bitcoin network ('mainnet' or 'testnet').
type'legacy' | 'segwit' | 'bech32' | 'taproot'| faker.helpers.arrayElement(['legacy','sewgit','bech32','taproot'])The bitcoin address type ('legacy', 'sewgit', 'bech32' or 'taproot').
Returns: string
Examples

creditCardCVV#

Generates a random credit card CVV.
Returns: string
Examples

creditCardIssuer#

Returns a random credit card issuer.
Returns: string
Examples

creditCardNumber#

Generates a random credit card number.
Parameters
NameTypeDefaultDescription
issuerstring The name of the issuer (case-insensitive) or the format used to generate one.
Returns: string
Examples

currencyCode#

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

currencyName#

Returns a random currency name.
Returns: string
Examples

currencySymbol#

Returns a random currency symbol.
Returns: string
Examples

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.
Returns: string
Examples

iban#

Generates a random iban.
Parameters
NameTypeDefaultDescription
countryCodestringThe country code from which you want to generate an IBAN, if none is provided a random country will be used.
formattedbooleanfalseReturn a formatted version of the generated IBAN.
Returns: string
Examples

maskedNumber#

Generates a random masked number.
Parameters
NameTypeDefaultDescription
ellipsisbooleantrueWhether to prefix the numbers with an ellipsis.
lengthnumber4The length of the unmasked number.
parensbooleantrueWhether to use surrounding parenthesis.
Returns: string
Examples

pin#

Generates a random PIN number.
Parameters
NameTypeDefaultDescription
lengthnumber4The length of the PIN to generate.
Returns: string
Examples

routingNumber#

Generates a random routing number.
Returns: string
Examples

transactionDescription#

Generates a random transaction description.
Returns: string
Examples

transactionType#

Returns a random transaction type.
Returns: string
Examples
Previous
Date
Next
Food
Built with