🆓Free Basic Electricity

Use this endpoint to claim Free Basic Electricity tokens against a meter that has been approved for FBE issue.

post

Header parameters

AuthorizationstringRequired

API token for user authentication

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

Body

application/json

Valid combinations for this request:

1. 'meter_no'
2. 'meter_card'
3. ['meter_no', 'supply_group_code', 'key_rev_no', 'tariff_index', 'token_tech', 'algo_tech'] Note: In Update Meter Key flow only combinations 2 and 3 are allowed

and

Responses

200

vend token retrieved successfully

application/json

aggregation_idstringOptionalExample: 0ea72d93-0158-4eb3-b25d-879f1e1f83dd

amtstring · nullableOptionalExample: 200.00

categorystringOptionalExample: reg

chargesobject[]OptionalExample: []

client_idstringOptionalExample: 6004708001981

display_headerstringOptionalExample: CREDIT VEND - TAX INVOICE

idstringOptionalExample: b3e84bcc-7b32-47f7-b919-696fd076ad6a

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

old_meter_nostringOptionalExample: 12345678901

resp_date_timestring · date-timeOptionalExample: 2024-10-17 03:00:31

statusstringOptionalExample: done

supplierstringOptional

Supplier name

Example: ravasvend

terminal_idstringOptionalExample: 0000000000001

unitsinteger · nullableOptional

vend_typeintegerOptionalExample: 2

400

Invalid input

application/json

post

/api/v1/meter/fbe-vend

HTTPcURLJavaScriptPython

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

{
  "algo_tech": "07",
  "key_rev_no": "1",
  "meter_no": "1234567890",
  "supply_group_code": "100600",
  "tariff_index": "07",
  "token_tech": "02",
  "meter_card": "600727123412341234===0716123456647",
  "channel": "web"
}

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