POST
/
batches
/
merchants
/
match
Match a batch of merchants
curl --request POST \
  --url https://east.sandbox.spade.com/batches/merchants/match \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "merchants": [
    {
      "requestId": "<string>",
      "merchantName": "Amazon",
      "address": "123 Main St",
      "city": "New York",
      "region": "NY",
      "country": "USA",
      "postalCode": "10001",
      "latitude": 37.774929,
      "longitude": -90.412702,
      "website": "https://www.amazon.com",
      "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
​
merchants
object[]
required

An array of merchants to match. Maximum 50,000 merchants.

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"