Enrich a batch of universal transactions

curl --request POST \
  --url https://east.sandbox.spade.com/batches/transactions/universal/enrich \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "transactions": [
    {
      "userId": "<string>",
      "transactionId": "transaction_id_123456789",
      "description": "<string>",
      "amount": 123,
      "currencyCode": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "accountId": "<string>",
      "direction": "CREDIT",
      "customAttributes": {}
    }
  ],
  "callbackUrl": "<string>"
}
'

{
  "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "batchSize": 2,
  "submittedAt": "2023-11-07T05:31:56Z"
}

POST

batches

transactions

universal

enrich

Enrich a batch of universal transactions

curl --request POST \
  --url https://east.sandbox.spade.com/batches/transactions/universal/enrich \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "transactions": [
    {
      "userId": "<string>",
      "transactionId": "transaction_id_123456789",
      "description": "<string>",
      "amount": 123,
      "currencyCode": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "accountId": "<string>",
      "direction": "CREDIT",
      "customAttributes": {}
    }
  ],
  "callbackUrl": "<string>"
}
'

{
  "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "batchSize": 2,
  "submittedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-Api-Key

string

header

required

Body

application/json

transactions

object[]

required

An array of transactions to enrich. Each transaction must have a unique transactionId. Maximum 50,000 transactions.

Maximum array length: 50000

Show child attributes

transactions.userId

string

required

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

Maximum string length: 512

transactions.transactionId

string

required

Your ID representing this transaction Your ID representing this transaction. Required for batch requests.

Maximum string length: 512

Example:

"transaction_id_123456789"

transactions.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 string length: 1024

transactions.amount

required

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

transactions.currencyCode

string

required

Maximum string length: 16

transactions.occurredAt

string<date-time>

required

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

transactions.accountId

string

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

Maximum string length: 512

transactions.direction

enum<string>

The direction of the transaction. Will take precedence over the direction inferred from the amount field.

Available options:

CREDIT,

DEBIT

Maximum string length: 8

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

Show child attributes

transactions.customAttributes.{key}

string

Maximum string length: 250

callbackUrl

string<url>

The URL to call when the batch job is complete.

Response

Successful operation

batchId

string<uuid>

required

Unique identifier for the batch job

status

enum<string>

required

Current status of the batch job

Available options:

pending,

running,

completed,

failed

batchSize

integer

required

Number of transactions in the batch

Required range: x >= 1

submittedAt

string<date-time>

required

Timestamp of when the batch was submitted

Enrich a universal transaction Get the results of a batch universal enrichment job

⌘I

Card Enrichment

Transfer Enrichment

Universal Enrichment

Feedback and Reporting

Merchant Search

Merchant Matching

Category Personalization

Enrich a batch of universal transactions

Authorizations

Body

Response