notify_web_payment_started

OCPP 2.1 NotifyWebPaymentStarted action.

Request/Response payload types with their OCPP-J codecs (request_to_json/request_decoder, response_to_json/ response_decoder). Transport-agnostic; the action-string mapping lives in ocpp/v2_1/dispatch.

Types

Request

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—
`evse_id`	`Int`	✓	EVSE id for which transaction is requested. (≥ 0)
`timeout`	`Int`	✓	Timeout value in seconds after which no result of web payment process (e.g. QR code scanning) is to be expected anymore.

Schema: NotifyWebPaymentStartedRequest

pub type Request {
  Request(
    custom_data: option.Option(custom_data.CustomData),
    evse_id: Int,
    timeout: Int,
  )
}

Constructors

Request(
  custom_data: option.Option(custom_data.CustomData),
  evse_id: Int,
  timeout: Int,
)

Response

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—

Schema: NotifyWebPaymentStartedResponse

pub type Response {
  Response(custom_data: option.Option(custom_data.CustomData))
}

Constructors

Response(custom_data: option.Option(custom_data.CustomData))

Values

new_request

</>

pub fn new_request(
  evse_id evse_id: Int,
  timeout timeout: Int,
) -> Request

Construct a Request from its required fields, with every optional field set to None.

new_response

</>

pub fn new_response() -> Response

Construct a Response from its required fields, with every optional field set to None.

request_decoder

</>

pub fn request_decoder() -> decode.Decoder(Request)

Decode a Request from its OCPP-J JSON object, enforcing schema constraints.

request_to_json

</>

pub fn request_to_json(value: Request) -> json.Json

Encode a Request to its OCPP-J JSON object.

response_decoder

</>

pub fn response_decoder() -> decode.Decoder(Response)

Decode a Response from its OCPP-J JSON object, enforcing schema constraints.

response_to_json

</>

pub fn response_to_json(value: Response) -> json.Json

Encode a Response to its OCPP-J JSON object.