🔌Vend Normal Token

Use this endpoint to vend a normal electricity token. A positive wallet balance is required, and upon successful vend, the value of the token will be subtracted from the wallet balance.

post

Header parameters

AuthorizationstringRequired

API token for user authentication

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

Body

application/json

aggregation_idstringRequired

Unique identifier for the transaction

Example: 8cd4f756-59c8-4135-9198-4ec88fffe033

amtnumber · floatRequired

Amount to vend

Example: 1460.45

channelstringRequired

Users vending channel code

Example: web

merchant_idstringOptional

Optional UUID to be provided by merchants for tracking

Example: 109205d9-a125-41ab-b1f6-0f78c74e5a21

meter_nostringRequired

Meter number

Example: 12345678912

Responses

200

Token verification successful

application/json

400

Invalid input or verification failed

application/json

500

Server error

application/json

post

/api/v1/meter/vend

HTTPcURLJavaScriptPython

POST /api/v1/meter/vend HTTP/1.1
Host: stage-api.digimali.co.za
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "aggregation_id": "8cd4f756-59c8-4135-9198-4ec88fffe033",
  "amt": 1460.45,
  "channel": "web",
  "merchant_id": "109205d9-a125-41ab-b1f6-0f78c74e5a21",
  "meter_no": "12345678912"
}

{
  "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"
  }
}