BucksBox Developer DocsBucksBox Developer Docs
Getting Started
Merchant API
Partner API
SDK
GitHub
Getting Started
Merchant API
Partner API
SDK
GitHub
  • Overview
  • Authentication & Security
  • Endpoint Reference
  • Multi-Language Integration
  • Account

    • Profile
    • Balance
    • Merchants
    • Transactions
    • Commission
  • On behalf of merchants

    • UPI
    • AEPS
    • DMT

Transactions

View and summarize transactions processed by merchants under your vendor account, across all services (DMT, AEPS, UPI/QR).

This page was rewritten against the live backend

The previous version documented a single /api/v1/vendor/transactions list endpoint and a /api/v1/vendor/transactions/:txnId detail endpoint. Neither path exists — the real list route is at a different path with different query params, and there are four more summary/dashboard endpoints this page didn't cover at all. What follows is read directly from paymentSystem/src/modules/vendors/routes/vendor.route.js.

List Transactions

GET /vendor/transaction/vendor/all?page=1&limit=20&paymentMethod=DMT&status=SUCCESS&fromDate=2026-07-01&toDate=2026-07-04
Authorization: Bearer <token>
Query paramTypeDescription
page, limitnumberPagination (default: page 1, limit 10)
statusstringFilter by transaction status
paymentMethodstringDMT, AEPS, UPI, …
transactionMethodstringAlias for paymentMethod — same filter, different query key; either works
fromDate, toDatestringISO date/time — bare YYYY-MM-DD is treated as UTC midnight
merchantIdstringRestrict to one managed merchant
{
  "statusCode": "00",
  "message": "vendor transactions fetched successfully",
  "data": [
    {
      "id": "txn-uuid",
      "paymentMethod": "DMT",
      "amount": 500,
      "status": "SUCCESS",
      "merchantId": "m-uuid",
      "merchant": { "id": "m-uuid", "mid": "M001", "legal_name": "Main Street Shop", "mstatus": "APPROVED" },
      "terminal": { "id": "t-uuid", "tid": "TID001", "type": "DMT" },
      "vendor": { "id": "v-uuid", "name": "My Company Pvt Ltd" },
      "upiTransaction": null,
      "cardTransaction": null,
      "createdAt": "2026-07-04T10:30:00Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "total": 287, "totalPages": 15 }
}

Get Transaction

GET /vendor/transaction/:id
Authorization: Bearer <token>

Returns the transaction plus its full ledger entries — 404 if not found, 403 if it belongs to a merchant outside your vendor account.

{
  "statusCode": "00",
  "data": {
    "id": "txn-uuid",
    "amount": 500,
    "status": "SUCCESS",
    "merchant": { "id": "m-uuid", "mid": "M001", "legal_name": "Main Street Shop", "business_name": "...", "mstatus": "APPROVED", "status": true },
    "terminal": { "id": "t-uuid", "tid": "TID001", "type": "DMT" },
    "vendor": { "id": "v-uuid", "name": "My Company Pvt Ltd" },
    "commissionSnapshot": { "...": "commission breakdown at time of transaction" },
    "settlement": { "...": "settlement record, if settled" },
    "reconciliation": { "...": "reconciliation record, if reconciled" },
    "ledgerEntries": [
      { "id": "le-uuid", "entryType": "DEBIT", "amount": 500, "account": { "id": "a-uuid", "code": "1000", "name": "Merchant Wallet", "type": "ASSET", "category": "WALLET" } }
    ]
  }
}

Dashboard summary

GET /vendor/gettransactions
Authorization: Bearer <token>

Aggregates only PAID/SUCCESS transactions across every merchant you manage into today/week/month/year buckets, a per-service breakdown, and a top-10 merchants list.

{
  "statusCode": "00",
  "message": "Vendor Transactions Summary",
  "data": {
    "summary": {
      "today": { "count": 12, "totalAmount": 6000 },
      "week": { "count": 84, "totalAmount": 42000 },
      "month": { "count": 310, "totalAmount": 155000 },
      "year": { "count": 3100, "totalAmount": 1550000 }
    },
    "serviceCollection": {
      "today": { "DMT": { "count": 8, "totalAmount": 4000 }, "AEPS": { "count": 4, "totalAmount": 2000 } },
      "week": { "...": "same shape" },
      "month": { "...": "same shape" },
      "year": { "...": "same shape" }
    },
    "merchants": { "total": 42, "active": 38 },
    "topMerchants": {
      "week": [ { "id": "m-uuid", "name": "Main Street Shop", "totalAmount": 12000, "txnCount": 24 } ],
      "month": [ "..." ],
      "year": [ "..." ]
    }
  }
}

Payment method summary

GET /vendor/payment-method-summary
Authorization: Bearer <token>

PAID/SUCCESS transactions only, grouped by paymentMethod.

{
  "statusCode": "00",
  "message": "Payment Method Summary",
  "data": { "DMT": { "count": 310, "amount": 155000 }, "AEPS": { "count": 120, "amount": 60000 }, "UPI": { "count": 45, "amount": 22500 } }
}

Today's summary by response code

GET /vendor/transaction/summary/today
Authorization: Bearer <token>
{
  "statusCode": "00",
  "message": "Today's transaction summary grouped by responceCode",
  "data": [
    { "responseCode": "00", "reason": "Approved", "status": "SUCCESS", "count": 10, "amount": 5000 },
    { "responseCode": "51", "reason": "Insufficient funds", "status": "FAILED", "count": 2, "amount": 1000 }
  ]
}

If there are no merchants under this vendor yet, or no transactions today, this returns a single placeholder bucket ({"responseCode": "N/A", "reason": "No transactions today", "count": 0, "amount": 0}) instead of an empty array.

Dashboard stats

GET /vendor/dashboard/stats
Authorization: Bearer <token>

Status breakdown across all time, today/this-month aggregates, and settlement status.

{
  "statusCode": "00",
  "data": {
    "byStatus": { "SUCCESS": { "count": 3100, "amount": 1550000, "netAmount": 1540000 }, "FAILED": { "count": 45, "amount": 22000, "netAmount": 0 } },
    "today": { "count": 12, "amount": 6000, "netAmount": 5970 },
    "thisMonth": { "count": 310, "amount": 155000, "netAmount": 154000 },
    "settlement": {
      "pending": { "count": 5, "amount": 2500, "netSettlement": 2480 },
      "lastSettled": { "netSettlement": 12000, "settledAt": "2026-07-03T18:00:00Z", "settlementRef": "STL-...", "merchantId": "m-uuid" },
      "recent": [ { "id": "stl-uuid", "netSettlement": 12000, "status": "SUCCESS", "createdAt": "2026-07-03T18:00:00Z", "transaction": { "merchant": { "legal_name": "Main Street Shop", "mid": "M001" } } } ]
    }
  }
}

Status values

Real transaction status values in this schema are strings like SUCCESS, FAILED, PENDING, PAID — not the "00"/"01"/"03" codes used elsewhere in this documentation set for AEPS/DMT/UPI operation responses. Don't conflate the two: status on a Transaction row is a state name; statusCode on an operation response is a numeric-string result code.

Prev
Merchants
Next
Commission