Create intake vortex merchant sync

Join Vortex merchant-statement analysis (measured card volume, fees, effective rate — first-party TPV) onto Pile customers. Matches on explicit customerId, customFields.externalMerchantRef, externalId “vortex-merchant:<ref>”, contact email, or case-insensitive business name; creates a customer when nothing matches. Writes the measured figures to customFields (incl. the canonical monthly_card_volume_cents), stamps the join key on the merchant’s intake document when one exists, records a high-confidence revenue_estimate signal, and re-ranks. Pass merchants inline or an operator key to pull /v1/operator/merchant-statements.

POST/workspaces/{organizationId}/intake/vortex-merchants/sync

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Request body

application/json

merchantsobject[]

Show properties

Array of object

externalMerchantRefstringrequired

min length 1

customerIdstring | null

businessNamestring | null

contactEmailstring | null

monthlyVolumeCentsnumberrequired

totalFeesCentsnumber | null

effectiveRateBpsnumber | null

transactionCountnumber | null

avgTicketCentsnumber | null

statementPeriodstring | null

processorstring | null

vortexOperatorKeystring

Responses

200

Vortex merchants synced

syncedintegerrequired

createdintegerrequired

updatedintegerrequired

customersobject[]required

Show properties

Array of object

idstringrequired

namestringrequired

externalMerchantRefstringrequired

measuredMonthlyVolumeCentsnumber | nullrequired

effectiveRateBpsnumber | nullrequired

scorenumber | nullrequired

400

Invalid request

502

Vortex API fetch failed

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Bodyapplication/json

Request body

Request

curl -X POST 'https://pile.nyc/workspaces/string/intake/vortex-merchants/sync' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "merchants": [
    {
      "externalMerchantRef": "string",
      "customerId": "string",
      "businessName": "string",
      "contactEmail": "string",
      "monthlyVolumeCents": 0,
      "totalFeesCents": 0,
      "effectiveRateBps": 0,
      "transactionCount": 0,
      "avgTicketCents": 0,
      "statementPeriod": "string",
      "processor": "string"
    }
  ],
  "vortexOperatorKey": "string"
}'

const response = await fetch("https://pile.nyc/workspaces/string/intake/vortex-merchants/sync", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"merchants\": [\n    {\n      \"externalMerchantRef\": \"string\",\n      \"customerId\": \"string\",\n      \"businessName\": \"string\",\n      \"contactEmail\": \"string\",\n      \"monthlyVolumeCents\": 0,\n      \"totalFeesCents\": 0,\n      \"effectiveRateBps\": 0,\n      \"transactionCount\": 0,\n      \"avgTicketCents\": 0,\n      \"statementPeriod\": \"string\",\n      \"processor\": \"string\"\n    }\n  ],\n  \"vortexOperatorKey\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/intake/vortex-merchants/sync",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"merchants\": [\n    {\n      \"externalMerchantRef\": \"string\",\n      \"customerId\": \"string\",\n      \"businessName\": \"string\",\n      \"contactEmail\": \"string\",\n      \"monthlyVolumeCents\": 0,\n      \"totalFeesCents\": 0,\n      \"effectiveRateBps\": 0,\n      \"transactionCount\": 0,\n      \"avgTicketCents\": 0,\n      \"statementPeriod\": \"string\",\n      \"processor\": \"string\"\n    }\n  ],\n  \"vortexOperatorKey\": \"string\"\n}",
)

Response

{
  "synced": 0,
  "created": 0,
  "updated": 0,
  "customers": [
    {
      "id": "string",
      "name": "string",
      "externalMerchantRef": "string",
      "measuredMonthlyVolumeCents": 0,
      "effectiveRateBps": 0,
      "score": 0
    }
  ]
}