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
- Transfer Enrichment
- Feedback and Reporting
- Merchant Search
- Merchant Matching
- Category Personalization
More
- User experience
- Understanding match scores
- Glossary
- FAQ
Transfer Enrichment
Enrich a transfer transaction
Enrich a transfer transaction such as an ACH withdrawal, ACH deposit, or wire transfer.
When using this endpoint, take care to ensure you are using unaltered and correct data in each field.
Note that transfers enrichment is currently private, please reach out to sales@spade.com to request access.
POST
/
transactions
/
transfers
/
enrich
Copy
Ask AI
curl --request POST \
--url https://east.sandbox.spade.com/transactions/transfers/enrich \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"userId": "user_id_123456789",
"accountId": "account_id_123456789",
"transactionId": "transaction_id_123456789",
"transactionType": "ACH_WITHDRAWAL",
"transactionTypeDescription": "ACH Withdrawal",
"description": "AMAZON CORP SYF PAYMNT",
"alternateDescription": "AMAZON CORP",
"memo": "100 PUBLIC SQUARE CLEVELAND OH",
"amount": "283.78",
"currencyCode": "USD",
"occurredAt": "2022-06-15 18:27:51Z",
"direction": "CREDIT",
"customAttributes": {
"custom_attribute_1": "value_1",
"custom_attribute_2": "value_2"
}
}'
Copy
Ask AI
{
"transactionInfo": {
"type": "spending",
"subType": null,
"spendingInfo": null,
"thirdParties": [
{
"id": "ac48cef2-0d7f-4159-865e-e92b152262bc",
"name": "Paypal",
"type": "payment_processor",
"logo": "https://v1.spadeapi.com/logos/verified/paypal.png?size=large"
}
],
"recurrenceInfo": null,
"display": {
"name": "Amazon",
"categoryName": "Online Marketplace",
"graphic": "https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png",
"graphicSource": "counterparty"
},
"transferInfo": {
"direction": "outgoing",
"transferMethod": "ach",
"transferType": "external",
"isAdjustmentOrRefund": false
},
"atmInfo": null,
"isAccountVerification": false,
"isPeerToPeer": false,
"isDigitalWallet": false,
"transactionId": "transaction_id_123456789"
},
"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": "www.amazon.com"
}
],
"enrichmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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/transfers/enrich \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"userId": "user_id_123456789",
"accountId": "account_id_123456789",
"transactionId": "transaction_id_123456789",
"transactionType": "ACH_WITHDRAWAL",
"transactionTypeDescription": "ACH Withdrawal",
"description": "AMAZON CORP SYF PAYMNT",
"alternateDescription": "AMAZON CORP",
"memo": "100 PUBLIC SQUARE CLEVELAND OH",
"amount": "283.78",
"currencyCode": "USD",
"occurredAt": "2022-06-15 18:27:51Z",
"direction": "CREDIT",
"customAttributes": {
"custom_attribute_1": "value_1",
"custom_attribute_2": "value_2"
}
}'
Copy
Ask AI
{
"transactionInfo": {
"type": "spending",
"subType": null,
"spendingInfo": null,
"thirdParties": [
{
"id": "ac48cef2-0d7f-4159-865e-e92b152262bc",
"name": "Paypal",
"type": "payment_processor",
"logo": "https://v1.spadeapi.com/logos/verified/paypal.png?size=large"
}
],
"recurrenceInfo": null,
"display": {
"name": "Amazon",
"categoryName": "Online Marketplace",
"graphic": "https://static.v2.spadeapi.com/logos/de33f8973bc934c5b368a5b27155db02/light.png",
"graphicSource": "counterparty"
},
"transferInfo": {
"direction": "outgoing",
"transferMethod": "ach",
"transferType": "external",
"isAdjustmentOrRefund": false
},
"atmInfo": null,
"isAccountVerification": false,
"isPeerToPeer": false,
"isDigitalWallet": false,
"transactionId": "transaction_id_123456789"
},
"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": "www.amazon.com"
}
],
"enrichmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customAttributes": {
"custom_attribute_1": "value_1",
"custom_attribute_2": "value_2"
}
}
Assistant
Responses are generated using AI and may contain mistakes.