Carbon Drop 3: Webhooks, Reports and Account APIs

Real-time Events and Webhooks

Carbon now supports terminal-level events and order-level webhooks, giving developers live visibility into what’s happening across their environment.

These events are dispatched in sync with other Surfboard services, so your systems receive updates at the exact same time as Surfboard’s internal infrastructure — ensuring real-time parity across terminals, orders, and partner systems.

One highlight is NFC tag reads, perfect for building physical-to-digital journeys, loyalty flows, or staff presence tracking.

{
  "eventType": "nfc.tags.read",
  "metadata": {
    "eventId": "evt_89ad12",
    "created": 1731159048,
    "retryAttempt": 0,
    "webhookEventId": "wh_0082",
  },
  "data": {
     "merchantId": "MER-0001",
     "terminalId": "TERM-9002",
     "orderId": "ORD-7777",
     "tags": [{ "sessionId": "SES-1234", "tagId": "TAG-AFC091" }]
   }
}

{
  "eventType": "nfc.tags.read",
  "data": { ..., "tags": [{ "sessionId": "SES-1234", "tagId": "TAG-AFC091" }]}
}

SFTP Reports and Notifications

The new SFTP Reports API automates financial reporting and data delivery for Business Intelligence and analytics.

Partners and merchants can schedule transaction reports to their own SFTP servers daily, weekly, or monthly, enabling end-to-end data synchronization with finance, analytics, or warehouse systems.

Subscribe to Notifications

POST /partners/:partnerId/notifications/reports

POST /merchants/:merchantId/notifications/reports

Example: Invoice distribution inside createOrder

{
   "event": "transaction.report",
   "sftpInfo": {
     "hostName": "sftp.merchant.io",
     "userName": "merchant_user",
     "port": 22,
     "hostKey": "sftp.merchant.io",
     "remoteDir": "/reports",
     "separator": "COMMA" | "SEMICOLON" | "PIPE" | "TAB"
   } 
}

Account Creation APIs

Finally. Account creation is now fully API-driven. Partners and merchants can create user accounts programmatically, assigning roles and permissions on the fly.

Create new users

POST /partners/:partnerId/accounts

POST /merchants/:merchantId/accounts

🤝 These same flows will be available directly in the Partner and Merchant Portals, so user management can be handled via API or no-code interface.

{
   "email": "jesus@priskus.com",
   "role": "admin"
}

Lastly, Merchant Configuration API

The Merchant Configuration API gives partners and merchants instant control over operational settings and UI behavior.

Examples include:

→ Displaying aggregate sales on merchant dashboards

→ Enabling receipt-to-text for SMS digital receipts

→ Setting cut-off times for settlements and reports

… and a lot more.

This enables self-service configuration at scale. From terminal options to omni-payment capabilities, with no waiting or support tickets.