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": "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"
      }
    }
  ],
  "callbackUrl": "https://example.com/callback"
}'
{
  "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "batchSize": 1,
  "submittedAt": "2024-11-21T20:07:20.213660Z"
}

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 length: 50000
​
callbackUrl
string<url>

The URL to call when the batch job is complete.

Examples:

"https://example.com/callback"

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
Examples:

1

​
submittedAt
string<date-time>
required

Timestamp of when the batch was submitted

Examples:

"2024-11-21T20:07:20.213660Z"