Skip to main content
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": "<string>",
      "address": "<string>",
      "city": "<string>",
      "region": "<string>",
      "country": "<string>",
      "postalCode": "<string>",
      "latitude": 123,
      "longitude": 123,
      "website": "<string>",
      "level": "corporation",
      "customAttributes": {}
    }
  ],
  "callbackUrl": "<string>"
}
'
{
  "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "batchSize": 2,
  "submittedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.spade.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
required

Body

application/json
​
merchants
object[]
required

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

Maximum array length: 50000
​
callbackUrl
string<url>

The URL to call when the batch job is complete.

Example:

"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
Example:

1

​
submittedAt
string<date-time>
required

Timestamp of when the batch was submitted

Example:

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