Skip to main content
POST
/
batches
/
transactions
/
cards
/
enrich
/
parse
Enrich a batch of card transactions with DE43 data
curl --request POST \
  --url https://east.sandbox.spade.com/batches/transactions/cards/enrich/parse \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "transactions": [
    {
      "userId": "<string>",
      "transactionId": "transaction_id_123456789",
      "amount": 123,
      "currencyCode": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "categoryCode": "<string>",
      "location": {
        "country": "<string>",
        "address": "<string>",
        "city": "<string>",
        "region": "<string>",
        "postalCode": "<string>",
        "latitude": 123,
        "longitude": 123
      },
      "de43": "<string>",
      "merchantName": "<string>",
      "organizationId": "<string>",
      "programId": "<string>",
      "cardId": "<string>",
      "cardFirstSix": "<string>",
      "cardLastFour": "<string>",
      "acquirerId": "<string>",
      "customAttributes": {}
    }
  ],
  "callbackUrl": "<string>"
}
'
{
  "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batchSize": 2,
  "submittedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
synchronous
boolean
default:false

When true, returns enriched results inline in the response instead of a batchId. Microbatches are capped to ensure timely processing. See the Microbatch enrichment guide for details.

Body

application/json
​
transactions
object[]
required

An array of transactions with de43's to parse and enrich. Each transaction must have a unique transactionId. Maximum 50,000 transactions.

Maximum array length: 50000
​
callbackUrl
string<url>

The URL to call when the batch job is complete.

Example:

"https://example.com/callback"

Callbacks

POST
{$request.body#/callbackUrl}batchStatusCallback

Body

application/json
​
batchId
string<uuid>
required

Unique identifier for the batch job

​
status
enum<string>
required

Final status of the batch job

Available options:
completed,
failed

Response

Your server returns this code if it accepts the 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
Example:

1

​
submittedAt
string<date-time>
required

Timestamp of when the batch was submitted

Example:

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