Skip to content
SMBcrmSMBcrm Developers

Orders & Transactions

Orders and transactions are the payment records in your SMBcrm account. Use them to reconcile revenue, look up a customer’s purchases, and audit individual charges. Both are read-only here.

Base URL: https://services.smbcrm.com · Version header: v3 · Scopes: payments/orders.readonly, payments/transactions.readonly. See Scopes.

Orders

Section titled “Orders”
GET/payments/orders

List orders in your account.

scope payments/orders.readonlyauth Location token or PIT

altId is required. Filter with paymentStatus (paid, unpaid, refunded, partially_paid), contactId, startAt/endAt, and page with limit/offset.

Terminal window
curl "https://services.smbcrm.com/payments/orders?altId=<location_id>&altType=location&limit=20" \
  -H "Authorization: Bearer <token>" \
  -H "Version: v3"
200 OK
{
  "data": [
    {
      "_id": "<order_id>",
      "altId": "<location_id>",
      "altType": "location",
      "contactId": "<contact_id>",
      "contactName": "Jordan Lee",
      "amount": 149,
      "currency": "USD",
      "status": "completed",
      "createdAt": "2026-07-08T15:04:00.000Z"
    }
  ],
  "totalCount": 1
}
GET/payments/orders/{orderId}

Get a single order by ID.

scope payments/orders.readonlyauth Location token or PIT
Terminal window
curl "https://services.smbcrm.com/payments/orders/<order_id>?altId=<location_id>&altType=location" \
  -H "Authorization: Bearer <token>" \
  -H "Version: v3"
200 OK
{
  "_id": "<order_id>",
  "altId": "<location_id>",
  "altType": "location",
  "contactId": "<contact_id>",
  "amount": 149,
  "currency": "USD",
  "status": "completed",
  "amountSummary": { "subtotal": 149, "discount": 0 },
  "source": { "type": "funnel", "id": "<funnel_id>", "name": "Checkout" },
  "createdAt": "2026-07-08T15:04:00.000Z"
}

Transactions

Section titled “Transactions”
GET/payments/transactions

List payment transactions in your account.

scope payments/transactions.readonlyauth Location token or PIT

altId and altType are both required. Narrow with contactId, subscriptionId, startAt/endAt, and page with limit/offset.

Terminal window
curl "https://services.smbcrm.com/payments/transactions?altId=<location_id>&altType=location&limit=20" \
  -H "Authorization: Bearer <token>" \
  -H "Version: v3"
200 OK
{
  "data": [
    {
      "_id": "<transaction_id>",
      "altId": "<location_id>",
      "altType": "location",
      "contactId": "<contact_id>",
      "amount": 149,
      "currency": "USD",
      "entityType": "invoice",
      "entityId": "<invoice_id>",
      "amountRefunded": 0,
      "createdAt": "2026-07-08T15:04:00.000Z"
    }
  ],
  "totalCount": 1
}
GET/payments/transactions/{transactionId}

Get a single transaction by ID.

scope payments/transactions.readonlyauth Location token or PIT
Terminal window
curl "https://services.smbcrm.com/payments/transactions/<transaction_id>?altId=<location_id>&altType=location" \
  -H "Authorization: Bearer <token>" \
  -H "Version: v3"
Section titled “Related”