📋Transactions View

Use this endpoint to view transactions for a merchant profile. Provide start and end date-time filters.

get

Query parameters

pageintegerOptional

Page number for pagination

Example: {"value":1}

page_sizeintegerOptional

Number of records per page (max 10)

Example: {"value":5}

datestringOptional

Filter by specific date (YYYY-MM-DD format)

Example: {"value":"2025-03-17"}

start_date_timestringOptional

Filter by start date and time (ISO 8601 format)

Example: {"value":"2025-03-17T00:00:00Z"}

end_date_timestringOptional

Filter by end date and time (ISO 8601 format)

Example: {"value":"2025-03-17T23:59:59Z"}

typestring · enumOptional

Filter by transaction type (fbe, trv, reg, mct)

Example: {"value":"fbe"}Possible values:

Header parameters

AuthorizationstringRequired

API token for user authentication

Example: {"value":"Token tk-abc-1234-xyz"}

Responses

200

Tokens retrieved successfully

application/json

204

No vend receipts found

application/json

400

Invalid request parameters

application/json

500

Server error while fetching receipts

application/json

get

/api/v1/meter/vend

HTTPcURLJavaScriptPython

GET /api/v1/meter/vend HTTP/1.1
Host: stage-api.digimali.co.za
Authorization: text
Accept: */*

{
  "count": 7,
  "next": "http://localhost:5000/api/v1/meter/vend?page=2&page_size=5",
  "previous": "http://localhost:5000/api/v1/meter/vend?page=0&page_size=5",
  "results": [
    {
      "account": {
        "account_number": "0987654321"
      },
      "aggregation_id": "0ea72d93-0158-4eb3-b25d-879f1e1f83dd",
      "amt": "200.00",
      "category": "reg",
      "charges": [],
      "client_id": "6004708001981",
      "display_header": "CREDIT VEND - TAX INVOICE",
      "id": "b3e84bcc-7b32-47f7-b919-696fd076ad6a",
      "merchant_id": "109205d9-a125-41ab-b1f6-0f78c74e5a21",
      "meter": {
        "algo_tech": "07",
        "key_rev_no": "1",
        "meter_no": "1234567890",
        "supply_group_code": "100600",
        "tariff_index": "07",
        "token_tech": "02"
      },
      "old_meter_no": "12345678901",
      "resp_date_time": "2024-10-17 03:00:31",
      "status": "done",
      "supplier": "ravasvend",
      "terminal_id": "0000000000001",
      "tokens": [
        {
          "amt": "200.00",
          "created": "2024-10-17T17:00:31.213232+02:00",
          "currency": "ZAR",
          "desc": "Normal Sale",
          "receipt_no": "0987564321",
          "tariff_desc": "52.17 c/kWh",
          "tariff_name": "HomeLight 1 (60A)",
          "taxes": [
            {
              "amt": "24.56",
              "currency": "ZAR",
              "rate": "14.00"
            }
          ],
          "type": 1,
          "unit_type": "kWh",
          "units": "383.39",
          "value": "56493153725450313471",
          "vat_no": "9876543210"
        }
      ],
      "units": null,
      "utility": {
        "address": "Foo Road",
        "name": "Eskom",
        "tax_ref": "1234567890"
      },
      "vend_type": 2,
      "vendor": {
        "address": "Foo Road",
        "name": "Eskom"
      }
    }
  ]
}