MoneyHub.GlobalCounterparties (MoneyHub v1.0.0)

Copy Markdown View Source

Global counterparties: Moneyhub's shared, user-independent reference database of known merchants/businesses, as distinct from MoneyHub.Counterparties (counterparties seen in a specific user's transaction history).

Useful for typeahead/search when building a payee picker, or for enriching data without a user-level token.

Summary

Functions

Searches the global counterparty database.

Types

counterparty()

@type counterparty() :: map()

Functions

list(config, token, opts \\ [])

@spec list(MoneyHub.Config.t(), String.t(), keyword()) ::
  {:ok, [counterparty()]} | {:error, MoneyHub.Error.t()}

Searches the global counterparty database.

Options

  • :query - free-text search term (e.g. a merchant name).
  • :limit - maximum number of results.