The following outlines the major concepts you will encounter while integrating with the Spade Card Transaction Enrichment API. Our goal is to enrich your transactions with high quality data, providing as much insight and clarity as possible.
counterparty
is represented as a list, typically this list will contain a single matched counterparty, however in a small percentage of cases, multiple results may be returned if there is a lower degree of certainty.
For large merchants, a counterparty can be thought of as a brand, e.g. all Starbucks locations fall under the same counterparty regardless of which location you purchase from.
Accompanying a matched counterparty is a match_score
which represents how strongly correlated the returned counterparty with the transaction (see Match Score section for more details).
Additionally, regardless of the counterparty results, we may also return third parties (see below).
locationId
, which is a unique id for that specific location. e.g. each Starbucks shop will have a different locationId
.
As with counterparties, we return a list of possible locations. This list can currently contain up to one location.
Retail
is the most general industry. Moving down the tree, we see that General Goods
is the sub-industry of Retail
to which Walmart belongs (notice that it is more specific). Other sub-industries of Retail
include Gas Stations
, Pharmacies
, and Office Supplies
.
Moving down the tree further, we see that Department Stores
is the sub-industry of General Goods
to which Walmart belongs (notice that this is yet more specific). Other sub-industries of General Goods
include Discount Stores
, Flea Markets
, and Pawn Shops
.
To obtain a full list of industries, please reach out to sales@spade.com.
merchantName
or city
fields.
thirdParties
field. We will also attempt to match on a counterparty – however, different third parties provide varying levels of information on counterparties in their transactions. When we are able to identify a counterparty or clean the text sufficiently, we will return that information in the counterparty object in addition to the third party object.
In implementation, we recommend always checking the third party field, even if no counterparty ID is returned, as there may be cases where only the third party is identified (e.g., for UberEats or other food delivery services).