Skip to main content

POST /traditional-transfer-of-reads/v1/{mpid}/gaining-supplier

Creates a traditional transfer-of-reads request as the gaining supplier.

Request

Method and path:

  • POST /traditional-transfer-of-reads/v1/{mpid}/gaining-supplier

Headers:

  • X-API-KEY (required): string, API key in UUID format.
  • X-IDEMPOTENCY-KEY (required): string.

Path parameters:

  • mpid (required): string supplier MPID.

Body schema:

  • TraditionalTransferOfReadsSchemaNoFlagRequest
{
"mpan_core": 1234567890123,
"bsc_validation": "V",
"site_visit_information": [
{
"site_visit_check_code": "01",
"additional_information": "Customer own reading"
}
],
"meter_readings": [
{
"meter_id": "A123456789",
"reading_type": "C",
"register_readings": [
{
"meter_register_id": "01",
"reading_datetime": "2024-12-17T09:35:00.540Z",
"reading": "100190092.5",
"md_reset_datetime": "2024-12-17T09:35:00.540Z",
"md_reset_count": 0,
"reading_method": "N",
"site_visit_information": [
{
"site_visit_check_code": "01",
"additional_information": "Read taken at handover"
}
]
}
]
}
]
}

Response

Success:

  • 200 OK
  • Body type: SupplierProcessResponseSchema
{
"request_id": "72f30f06-afcc-4ad8-8c1f-78e556ea9cbc",
"request_type": "traditional-transfer-of-reads",
"request_status": "Pending",
"description": "Traditional Transfer of Reads Process",
"created_at": "2026-03-11T14:04:22+00:00",
"last_updated_at": "2026-03-11T14:04:22+00:00",
"mpan_core": 1234567890123
}

Other documented responses:

  • 400 Business/process validation error
  • 401 Unauthorized
  • 422 Validation error
  • 428 Missing X-IDEMPOTENCY-KEY

Field-level constraints: