POST
/
transactions
/
transfers
/
enrich
Enrich a transfer transaction
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"
  }
}'
{
  "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": "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",
    "riskInsights": {
      "irregularWebPresenceDetected": false,
      "negativeOnlineSentiment": false,
      "highRiskEntity": false,
      "riskyIndustry": false,
      "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": "704bbd58-fb12-4bdb-9aae-2786704ea92a",
    "name": "Roblox",
    "url": "https://play.google.com/store/apps/details?id=com.roblox.client",
    "logo": "https://static.v2.spadeapi.com/logos/58c03a73629c46b8aa4c1e15cb4f0d0b/light.png",
    "developerName": "Roblox Corporation",
    "developerId": "704bbd58-fb12-4bdb-9aae-2786704ea92a",
    "category": "Auto and Transportation",
    "hasGamblingOrRewards": false,
    "hasSimulatedGambling": false,
    "ageRating": "Teen"
  },
  "customAttributes": {
    "custom_attribute_1": "value_1",
    "custom_attribute_2": "value_2"
  }
}

Authorizations

​
X-Api-Key
string
header
required

Body

application/json
​
userId
string
required

Anonymous ID representing your user. This will be used for summary features, and recurrence flagging purposes.

Maximum length: 512
Examples:

"user_id_123456789"

​
transactionType
string
required

The type of this transaction. By default, the accepted types include ACH_WITHDRAWAL and ACH_DEPOSIT; however, this endpoint also supports a variety of other transfer types, depending on your use case and the data you have available. Please contact your Spade representative if you would like further information about supported transaction types.

Maximum length: 32
Examples:

"ACH_WITHDRAWAL"

"ACH_DEPOSIT"

​
description
string
required

The 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...

Maximum length: 1024
Examples:

"AMAZON CORP SYF PAYMNT"

​
amount
required

Value of the transaction in the given currency. Negative values indicate incoming money.

Examples:

"283.78"

​
currencyCode
string
required
Maximum length: 16
Examples:

"USD"

​
occurredAt
string<date-time>
required

The time the transaction occurred. Formatted as an ISO 8601 date time.

Examples:

"2022-06-15 18:27:51Z"

​
accountId
string

Anonymous ID representing the account of the user (NOT the account number).

Maximum length: 512
Examples:

"account_id_123456789"

​
transactionId
string

Your ID representing this transaction

Maximum length: 512
Examples:

"transaction_id_123456789"

​
transactionTypeDescription
string

A description of the transactionType. This field is intended for systems in which the transactionType is a numeric code. In these cases, transactionTypeDescription should be the human-readable description of the transactionType.

Maximum length: 64
Examples:

"ACH Withdrawal"

"ACH Deposit"

​
alternateDescription
string

An alternate transaction description, if available. This will often be a string containing the name of the merchant or institution involved in the transaction. Note that this field is optional and may or may not be available in your system. Please contact your Spade representative if you have any questions about field mappings.

Maximum length: 1024
Examples:

"AMAZON CORP"

​
memo
string

The transaction memo, if your system contains an additional field beyond the description and alternateDescription fields. Note that this field is optional and may or may not be available in your system. Please contact your Spade representative if you have any questions about field mappings.

Maximum length: 1024
Examples:

"100 PUBLIC SQUARE CLEVELAND OH"

​
direction
enum<string>

The direction of the transaction.

Available options:
CREDIT,
DEBIT
Examples:

"CREDIT"

"DEBIT"

​
customAttributes
object

A 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.

Examples:
{
  "custom_attribute_1": "value_1",
  "custom_attribute_2": "value_2"
}

Response

Successful operation

​
transactionInfo
object
​
counterparty
object[]

An array of counterparties matched to the transaction, ordered by descending match score.

​
enrichmentId
string<uuid>

Our ID representing the enrichment, not to be confused with your provided transactionId.

​
mobileAppInfo
object | null

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.

​
customAttributes
object

A dictionary containing the custom attributes that were included in the enrichment request (if any).

Examples:
{
  "custom_attribute_1": "value_1",
  "custom_attribute_2": "value_2"
}