Welcome
- Introduction
- Understanding enriched data
- Integrating
Enrichment Guides
- Overview
- Enhanced data fields
- Batch enrichment guide
Tooling Guides
- Merchant matching
- Merchant search guide
- Category personalization guide
Spade API
- 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
- POST
- Transfer Enrichment
- Feedback and Reporting
- Merchant Search
- Merchant Matching
- Category Personalization
More
- User experience
- Understanding match scores
- Glossary
- FAQ
Card Enrichment
Enrich a card transaction
When working with this endpoint, note that several of the input fields are optional (region, acquirerId, etc.). However, we strongly recommend including all of the fields that you have available. Some optional fields can substantially improve performance.
Take care to ensure you are using unaltered and correct data in each field. Some fields go by multiple names, so if you have any questions regarding integration please feel free to reach out.
Note that some response fields may not be included in your product package, please reach out with any questions.
POST
/
transactions
/
cards
/
enrich
Copy
Ask AI
curl --request POST \
--url https://east.sandbox.spade.com/transactions/cards/enrich \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"merchantName": "Amazon",
"userId": "user_id_123456789",
"cardId": "card_id_123456789",
"cardFirstSix": "123456",
"cardLastFour": "7890",
"transactionId": "transaction_id_123456789",
"acquirerId": "000000000123456",
"amount": "25.23",
"currencyCode": "USD",
"occurredAt": "2022-06-15 18:27:51Z",
"categoryCode": "5812",
"categoryType": "MCC",
"location": {
"address": "1234 W 5th Ave Suite 100",
"city": "New York",
"region": "NY",
"country": "USA",
"postalCode": "10001",
"latitude": 45,
"longitude": 120
},
"customAttributes": {
"custom_attribute_1": "value_1",
"custom_attribute_2": "value_2"
}
}'
Copy
Ask AI
{
"transactionInfo": {
"transferInfo": null,
"isAccountVerification": false,
"isPeerToPeer": false,
"isDigitalWallet": false,
"type": "spending",
"subType": null,
"display": {
"name": "Amazon",
"categoryName": "Online Marketplace",
"graphic": "https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png",
"graphicSource": "counterparty"
},
"thirdParties": [
{
"id": "ac48cef2-0d7f-4159-865e-e92b152262bc",
"name": "Paypal",
"type": "payment_processor",
"logo": "https://v1.spadeapi.com/logos/verified/paypal.png?size=large"
}
],
"spendingInfo": {
"channel": {
"value": "digital"
}
},
"atmInfo": null,
"transactionId": "transaction_id_123456789",
"recurrenceInfo": {
"intervalType": "weekly",
"intervalDays": 30,
"nextPaymentExpected": "2024-08-07",
"recentRecurrences": [
[
"<any>"
]
]
}
},
"enrichmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"counterparty": [
{
"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,
"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
}
],
"logo": "https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png",
"phoneNumber": "+18664862360",
"website": "www.amazon.com",
"possibleCounterpartyAlternate": {
"id": "49fd51a1-5a19-3e5d-8d28-eb056ecf8939",
"similarity": 80
}
}
],
"customAttributes": {
"custom_attribute_1": "value_1",
"custom_attribute_2": "value_2"
}
}
Authorizations
Body
application/json
Response
200
application/json
Successful operation
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://east.sandbox.spade.com/transactions/cards/enrich \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"merchantName": "Amazon",
"userId": "user_id_123456789",
"cardId": "card_id_123456789",
"cardFirstSix": "123456",
"cardLastFour": "7890",
"transactionId": "transaction_id_123456789",
"acquirerId": "000000000123456",
"amount": "25.23",
"currencyCode": "USD",
"occurredAt": "2022-06-15 18:27:51Z",
"categoryCode": "5812",
"categoryType": "MCC",
"location": {
"address": "1234 W 5th Ave Suite 100",
"city": "New York",
"region": "NY",
"country": "USA",
"postalCode": "10001",
"latitude": 45,
"longitude": 120
},
"customAttributes": {
"custom_attribute_1": "value_1",
"custom_attribute_2": "value_2"
}
}'
Copy
Ask AI
{
"transactionInfo": {
"transferInfo": null,
"isAccountVerification": false,
"isPeerToPeer": false,
"isDigitalWallet": false,
"type": "spending",
"subType": null,
"display": {
"name": "Amazon",
"categoryName": "Online Marketplace",
"graphic": "https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png",
"graphicSource": "counterparty"
},
"thirdParties": [
{
"id": "ac48cef2-0d7f-4159-865e-e92b152262bc",
"name": "Paypal",
"type": "payment_processor",
"logo": "https://v1.spadeapi.com/logos/verified/paypal.png?size=large"
}
],
"spendingInfo": {
"channel": {
"value": "digital"
}
},
"atmInfo": null,
"transactionId": "transaction_id_123456789",
"recurrenceInfo": {
"intervalType": "weekly",
"intervalDays": 30,
"nextPaymentExpected": "2024-08-07",
"recentRecurrences": [
[
"<any>"
]
]
}
},
"enrichmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"counterparty": [
{
"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,
"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
}
],
"logo": "https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png",
"phoneNumber": "+18664862360",
"website": "www.amazon.com",
"possibleCounterpartyAlternate": {
"id": "49fd51a1-5a19-3e5d-8d28-eb056ecf8939",
"similarity": 80
}
}
],
"customAttributes": {
"custom_attribute_1": "value_1",
"custom_attribute_2": "value_2"
}
}
Assistant
Responses are generated using AI and may contain mistakes.