StarlingBank.Merchants (StarlingBank v1.0.0)

Copy Markdown View Source

Merchant enrichment data — merchant details and merchant location/branch details associated with card transactions.

Required scope: merchant:read.

Summary

Functions

get(merchant_uid, client \\ nil)

Fetches merchant details by merchant UID.

get_location(merchant_uid, merchant_location_uid, client \\ nil)

Fetches a specific merchant location (branch/outlet) by merchant and location UID.

Functions

get(merchant_uid, client \\ nil)

@spec get(String.t(), StarlingBank.Client.t() | keyword() | nil) ::
  {:ok, map()} | {:error, StarlingBank.Error.t()}

Fetches merchant details by merchant UID.

get_location(merchant_uid, merchant_location_uid, client \\ nil)

@spec get_location(String.t(), String.t(), StarlingBank.Client.t() | keyword() | nil) ::
  {:ok, map()} | {:error, StarlingBank.Error.t()}

Fetches a specific merchant location (branch/outlet) by merchant and location UID.