Card Enrichment
- POSTEnrich a card transaction
- POSTEnrich a card transaction with an unparsed de43
- POSTEnrich a card transaction (deprecated)deprecated
- POSTEnrich a card transaction with an unparsed de43 (deprecated)deprecated
- POSTEnrich a batch of card transactions
- POSTEnrich a batch of card transactions with DE43 data
- GETGet the results of a batch card enrichment job
- GETGet the status of a batch card enrichment job
Transfer Enrichment
Universal Enrichment
Feedback and Reporting
Merchant Search
Merchant Matching
Category Personalization
- GETGet all default and custom integration-level categories
- POSTCreate a custom integration-level category
- DELDelete all custom integration-level categories
- DELDelete a custom integration-level category
- GETGet all integration-level counterparty category personalizations
- PUTCreate an integration-level counterparty category personalization
- DELDelete all integration-level counterparty category personalizations
- DELDelete a counterparty category personalization
- GETGet categories
- POSTCreate a custom user-level category
- DELDelete all custom user-level categories
- DELDelete a custom user-level category
- GETGet all user-level counterparty category personalizations
- PUTCreate a user-level counterparty category personalization
- DELDelete all user-level counterparty category personalizations
- DELDelete a user-level counterparty category personalization
curl --request POST \
--url https://east.sandbox.spade.com/transactions/universal/enrich \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"userId": "<string>",
"description": "<string>",
"amount": 123,
"currencyCode": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"accountId": "<string>",
"transactionId": "<string>",
"direction": "CREDIT",
"customAttributes": {}
}
'{
"transactionInfo": {
"type": "spending",
"subType": null,
"spendingInfo": null,
"thirdParties": [
{
"id": "ac48cef2-0d7f-4159-865e-e92b152262bc",
"name": "Paypal",
"type": "payment_processor",
"logo": "https://static.v2.spadeapi.com/logos/9063bc0f0a3f4b1fbf644f9862e17002/light.png",
"website": "https://www.paypal.com/"
}
],
"recurrenceInfo": null,
"display": {
"name": "<string>",
"categoryName": "<string>",
"graphic": "<string>",
"graphicSource": "<string>"
},
"transferInfo": {
"direction": "outgoing",
"transferMethod": "ach",
"transferType": "external",
"isAdjustmentOrRefund": true
},
"atmInfo": {
"sponsorName": "<string>",
"ownerName": "<string>"
},
"isAccountVerification": true,
"isPeerToPeer": true,
"isDigitalWallet": true,
"transactionId": "<string>",
"riskInsights": {
"irregularWebPresenceDetected": true,
"negativeOnlineSentiment": true,
"highRiskEntity": true,
"riskyIndustry": true,
"cardAcceptanceHistory": "extensive"
}
},
"counterparty": [
{
"location": [
{
"id": "fdf79470-3deb-4638-956a-6859e473b9d8",
"address": "1234 W 5th Ave Suite 100",
"addressLine1": "1234 W 5th Ave",
"addressLine2": "Suite 100",
"city": "New York",
"region": "NY",
"country": "USA",
"postalCode": "10001",
"latitude": 45,
"longitude": 120,
"phoneNumber": "+18664862360",
"matchScore": 93.5
}
],
"possibleCounterpartyAlternate": null,
"id": "704bbd58-fb12-4bdb-9aae-2786704ea92a",
"name": "Amazon",
"legalName": "Amazon Inc.",
"industry": [
{
"id": "011-000-000-000",
"name": "Retail",
"icon": "https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png"
}
],
"matchScore": 93.5,
"logo": "https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png",
"phoneNumber": "+18664862360",
"website": "https://www.amazon.com"
}
],
"enrichmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mobileAppInfo": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>",
"logo": "<string>",
"developerName": "<string>",
"developerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "<string>",
"hasGamblingOrRewards": true,
"hasSimulatedGambling": true,
"ageRating": "<string>"
},
"customAttributes": {}
}Enrich a universal transaction
Enrich any type of transaction such as an aggregator transaction, card transaction, ACH withdrawal, ACH deposit, or wire transfer.
Note that universal enrichment is currently in beta, please reach out to [email protected] to request access.
curl --request POST \
--url https://east.sandbox.spade.com/transactions/universal/enrich \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"userId": "<string>",
"description": "<string>",
"amount": 123,
"currencyCode": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"accountId": "<string>",
"transactionId": "<string>",
"direction": "CREDIT",
"customAttributes": {}
}
'{
"transactionInfo": {
"type": "spending",
"subType": null,
"spendingInfo": null,
"thirdParties": [
{
"id": "ac48cef2-0d7f-4159-865e-e92b152262bc",
"name": "Paypal",
"type": "payment_processor",
"logo": "https://static.v2.spadeapi.com/logos/9063bc0f0a3f4b1fbf644f9862e17002/light.png",
"website": "https://www.paypal.com/"
}
],
"recurrenceInfo": null,
"display": {
"name": "<string>",
"categoryName": "<string>",
"graphic": "<string>",
"graphicSource": "<string>"
},
"transferInfo": {
"direction": "outgoing",
"transferMethod": "ach",
"transferType": "external",
"isAdjustmentOrRefund": true
},
"atmInfo": {
"sponsorName": "<string>",
"ownerName": "<string>"
},
"isAccountVerification": true,
"isPeerToPeer": true,
"isDigitalWallet": true,
"transactionId": "<string>",
"riskInsights": {
"irregularWebPresenceDetected": true,
"negativeOnlineSentiment": true,
"highRiskEntity": true,
"riskyIndustry": true,
"cardAcceptanceHistory": "extensive"
}
},
"counterparty": [
{
"location": [
{
"id": "fdf79470-3deb-4638-956a-6859e473b9d8",
"address": "1234 W 5th Ave Suite 100",
"addressLine1": "1234 W 5th Ave",
"addressLine2": "Suite 100",
"city": "New York",
"region": "NY",
"country": "USA",
"postalCode": "10001",
"latitude": 45,
"longitude": 120,
"phoneNumber": "+18664862360",
"matchScore": 93.5
}
],
"possibleCounterpartyAlternate": null,
"id": "704bbd58-fb12-4bdb-9aae-2786704ea92a",
"name": "Amazon",
"legalName": "Amazon Inc.",
"industry": [
{
"id": "011-000-000-000",
"name": "Retail",
"icon": "https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png"
}
],
"matchScore": 93.5,
"logo": "https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png",
"phoneNumber": "+18664862360",
"website": "https://www.amazon.com"
}
],
"enrichmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mobileAppInfo": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>",
"logo": "<string>",
"developerName": "<string>",
"developerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "<string>",
"hasGamblingOrRewards": true,
"hasSimulatedGambling": true,
"ageRating": "<string>"
},
"customAttributes": {}
}Authorizations
Body
Anonymous ID representing your user. This will be used for summary features, and recurrence flagging purposes.
512The full transaction description. Typically, this will be a string containing the name of the merchant or institution involved in the transaction plus information related to the type of transaction such as "ACCT VERIFY", "WEB PMT", "ETRANSFER", etc...
1024Value of the transaction in the given currency. Negative values indicate incoming money.
16The time the transaction occurred. Formatted as an ISO 8601 date time.
Anonymous ID representing the account of the user (NOT the account number).
512Your ID representing this transaction
512The direction of the transaction. Will take precedence over the direction inferred from the amount field.
CREDIT, DEBIT 8A dictionary containing custom attributes that you would like to be returned in the response.
Please ensure this object does not contain any PII.
Restrictions include: customAttributes must be an object, up 30 custom attributes are allowed, each key must be a string <= 40 characters in length, and each value must be a string <= 250 characters in length.
Show child attributes
Show child attributes
250Response
Successful operation
Show child attributes
Show child attributes
The main type of the transaction. For card transactions, the type is always "spending".
account_verification, atm, debt, fee, income, other_money_movement, reimbursement, spending "spending"
The more specific type of the transaction, if applicable. For card transactions, the subType is always null.
alimony_or_child_support, atm, bnpl, business, cash_advance, deposit, disbursements, earned_income, government_benefits, insurance, investment, nsf, other, overdraft, payment, payout, rental, retirement, tax_refund, transfer, withdrawal null
Additional information about transactions whose type is "spending". This field is null for other types of transactions.
null
An array of third parties involved in the transaction, when applicable. Entities such as Toast, Square, Uber Eats, Doordash, etc. will appear here.
Show child attributes
Show child attributes
"ac48cef2-0d7f-4159-865e-e92b152262bc"
"Paypal"
bnpl, delivery_service, payment_processor, platform "payment_processor"
Third party logo. Third party logo.
"https://static.v2.spadeapi.com/logos/9063bc0f0a3f4b1fbf644f9862e17002/light.png"
Third party website. Third party website.
"https://www.paypal.com/"
A recurring transaction is a repeated payment pattern to a counterparty, based on periodicty and amount. Premium Spade Signal available depending on your product package.
Show child attributes
Show child attributes
Recurrence cadence.
weekly, biweekly, monthly, quarterly, annually Number of days between recurrences.
Next expected payment date.
Array of recent recurrence objects, null if no recurrence exists.
null
An object containing display information for the transaction. The fields in this object are pulled from other parts of the enrichment and surfaced here for convenience.
Show child attributes
Show child attributes
The best name for display.
The best category name for display.
The best graphic for display. Depending on the data available, this will be either a) the counterparty logo, b) the third party logo, or c) the category icon.
The field from which the graphic was sourced. This will be either counterparty, third_party, or category.
Additional information about transfers. This field is null for card transactions.
Show child attributes
Show child attributes
The transfer direction.
outgoing, incoming The transfer method.
ach, cash, check, intrabank, rtp, unknown, wire The transfer type. "external" indicates that money is being sent to an external counterparty. "internal" indicates that money is being moved between accounts owned by the same entity.
external, internal, unknown Whether the transfer is an adjustment or refund.
Additional information about ATM transactions. This field is null for other types of transactions.
Whether the transfer is an account verification. Currently only available for transfers.
Whether the transaction is a peer-to-peer transaction. Currently only available for transfers.
Whether the transaction involves a digital wallet. Currently only available for transfers.
Your ID representing this transaction. This ID exactly matches the transactionId you provided in your enrichment request.
Risk insights provide visibility into the potential risk of a transaction and the merchants involved. Premium Spade Signal available depending on your product package.
Show child attributes
Show child attributes
Has engaged in deceptive online practices or has irregular website structure or content.
Negative online consumer feedback associated with the counterparty.
The counterparty is known to engage in fraudulent practices.
Industry is correlated with increased disputes (based on Spade industries).
Counterparties with lower levels of card acceptance history have a higher likelihood of chargebacks or fraudulent activity.
extensive, established, stable, limited, very_limited, null An array of counterparties matched to the transaction, ordered by descending match score.
Show child attributes
Show child attributes
An array of locations matched to the transaction (and associated with this counterparty). Can currently contain only one location. This is a premium Spade field available depending on your product package.
An array of locations matched to the transaction (and associated with this counterparty). Can currently contain only one location. This is a premium Spade field available depending on your product package.
Show child attributes
Show child attributes
A unique identifier for this location. A unique identifier for this location. A unique identifier for this location.
"fdf79470-3deb-4638-956a-6859e473b9d8"
Street number, name, and any secondary address information. Street number, name, and any secondary address information. Street number, name, and any secondary address information.
"1234 W 5th Ave Suite 100"
Street number and name. Street number and name. Street number and name.
"1234 W 5th Ave"
Secondary address information. Secondary address information. Secondary address information.
"Suite 100"
"New York"
Two letter region code. Two letter region code. Two letter region code.
"NY"
Three letter country code. Three letter country code. Three letter country code.
"USA"
Location postal code or zip code. Location postal code or zip code. Location postal code or zip code.
"10001"
Location latitude. Location latitude. Location latitude.
45
Location longitude. Location longitude. Location longitude.
120
Location phone number. This is a premium Spade field available depending on your product package. Location phone number. This is a premium Spade field available depending on your product package. Location phone number. This is a premium Spade field available depending on your product package.
"+18664862360"
The matchScore predicts how well a transaction matches a Location in our records. If no Location was found, the matchScore is set to null. Scores range between 0.00 and 100.0. Generally, a higher matchScore indicates a better match between a transaction and a Location. This is a premium Spade field available depending on your product package.
The matchScore predicts how well a transaction matches a Location in our records. If no Location was found, the matchScore is set to null. Scores range between 0.00 and 100.0. Generally, a higher matchScore indicates a better match between a transaction and a Location. This is a premium Spade field available depending on your product package.
The matchScore predicts how well a transaction matches a Location in our records. If no Location was found, the matchScore is set to null. Scores range between 0.00 and 100.0. Generally, a higher matchScore indicates a better match between a transaction and a Location. This is a premium Spade field available depending on your product package.
93.5
The possible alternate counterparty object represents a counterparty that may be matched to this transaction in other enrichment requests. Premium Spade Field available depending on your product package.
The possible alternate counterparty object represents a counterparty that may be matched to this transaction in other enrichment requests. Premium Spade Field available depending on your product package.
Show child attributes
Show child attributes
The ID of the alternate counterparty.
The ID of the alternate counterparty.
"49fd51a1-5a19-3e5d-8d28-eb056ecf8939"
The similarity score indicates how closely this alternate counterparty matches the main counterparty. The score is a value between 0.0 and 100.0, where 100.0 is an exact match.
The similarity score indicates how closely this alternate counterparty matches the main counterparty. The score is a value between 0.0 and 100.0, where 100.0 is an exact match.
80
null
A unique identifier for this counterparty, regardless of specific location. A unique identifier for this counterparty, regardless of specific location.
"704bbd58-fb12-4bdb-9aae-2786704ea92a"
Counterparty name. Counterparty name.
"Amazon"
Counterparty legal name. This is a premium Spade field available depending on your product package. Counterparty legal name. This is a premium Spade field available depending on your product package.
"Amazon Inc."
Array with increasingly specific category information. Array with increasingly specific category information.
The matchScore predicts how well a transaction matches a Counterparty in our records. If no Counterparty was found, the matchScore is set to null. Otherwise, scores range between 50.00 and 100.00. We filter out results below this range to make sure that only high quality matches are returned. Generally, the higher the matchScore is the better the match between a transaction and a Counterparty. When multiple Counterparties match a transaction, matches are returned in decreasing order of matchScore. This is a premium Spade field available depending on your product package.
The matchScore predicts how well a transaction matches a Counterparty in our records. If no Counterparty was found, the matchScore is set to null. Otherwise, scores range between 50.00 and 100.00. We filter out results below this range to make sure that only high quality matches are returned. Generally, the higher the matchScore is the better the match between a transaction and a Counterparty. When multiple Counterparties match a transaction, matches are returned in decreasing order of matchScore. This is a premium Spade field available depending on your product package.
93.5
Counterparty logo. This is a premium Spade field available depending on your product package. Counterparty logo. This is a premium Spade field available depending on your product package.
"https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png"
Counterparty phone number. This is a premium Spade field available depending on your product package. Counterparty phone number. This is a premium Spade field available depending on your product package.
"+18664862360"
Counterparty website. This is a premium Spade field available depending on your product package. Counterparty website. This is a premium Spade field available depending on your product package.
"https://www.amazon.com"
Our ID representing the enrichment, not to be confused with your provided transactionId.
The mobile app information for the transaction. This object is only non-null if the transaction was matched to a mobile app.
This is a premium Spade field available depending on your product package.
Show child attributes
Show child attributes
A unique identifier for this mobile app.
The name of the mobile app.
The URL of the mobile app in the app store.
The URL of the mobile app's logo.
The name of the developer of the mobile app.
The ID of the developer of the mobile app.
The category of the mobile app. The possible values are:
- Auto and Transportation
- Creative and Design
- Education and Parenting
- Entertainment and Media
- Finance and Business
- Games
- Health and Lifestyle
- Shopping and Marketplaces
- Social and Communication
- Travel and Events
- Utility and Tools
Whether the mobile app has gambling or cash rewards.
Whether the mobile app has simulated gambling.
The age rating of the mobile app. The possible values are:
- Children
- Teen
- Adult