Validate Bill

Overview

Description: This endpoint processes and verifies transaction details before completion. It validates customer input to requirement fields that require validation. Each requirement in request object is validated separately

Endpoint: {base_url}/validation

REQUEST PARAMETER

Request Parameters

Request Parameters

#	Parameter	Type	Description	Required?
1	bundleId	Integer	Unique identifier for the bundle	Yes
2	parameters	Array of Objects	List of parameters containing name-value pairs	Yes
3	parameters.name	String	Name of the parameter	Yes
4	parameters.value	String	Value associated with the parameter	Yes
5	pin	String	Personal identification number for authentication	Yes
6	serviceId	String	Unique identifier for the service	Yes
7	sessionid	String	Unique session identifier for the transaction	Yes
8	terminalId	String	Terminal identifier for the transaction request	Yes

Response Parameters

Response Parameters

#	Parameter	Type	Description	Required?
1	account	String	Account associated with the transaction	Yes
2	action	String	Action performed (e.g., payment, refund, etc.)	Yes
3	alias	String	Alias for the transaction	Yes
4	amount	Integer	Amount involved in the transaction	Yes
5	clientRef	String	Client reference identifier	Yes
6	code	String	Code associated with the transaction or service	Yes
7	email	String	Email address of the client	Yes
8	error	String	Error message, if any	No
9	execTime	String	Time taken for the execution of the request	No
10	fault	String	Fault message, if any	No
11	fee	Integer	Fee associated with the transaction	Yes
12	hosterror	String	Error from the host system, if any	No
13	message	String	Response message for the transaction	Yes
14	mobile	String	Mobile number associated with the client	Yes
15	name	String	Name associated with the transaction	Yes
16	narration	String	Narration or description of the transaction	Yes
17	otherinfo	String	Any additional information related to the transaction	No
18	period	String	Time period for the transaction	Yes
19	reference	String	Transaction reference number	Yes
20	response	String	Response status or code	Yes
21	status	Integer	Status code indicating the result of the transaction	Yes
22	subscriber	String	Subscriber ID associated with the transaction	Yes
23	thirdPartyRef	String	Reference number from a third party, if applicable	No
24	type	String	Type of the transaction or service	Yes

Sample Request

Request Parameters

POST {base_url}/validation

curl `${base_url}/validation`
-H "Content-type: application/json"
-X POST
-d '{
  "bundleId": 0,
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "pin": "string",
  "serviceId": "string",
  "sessionid": "string",
  "terminalId": "string"
}
'

Sample Response

Response Parameters

POST {base_url}/validation

{
  "account": "string",
  "action": "string",
  "alias": "string",
  "amount": 0,
  "clientRef": "string",
  "code": "string",
  "email": "string",
  "error": "string",
  "execTime": "string",
  "fault": "string",
  "fee": 0,
  "hosterror": "string",
  "message": "string",
  "mobile": "string",
  "name": "string",
  "narration": "string",
  "otherinfo": "string",
  "period": "string",
  "reference": "string",
  "response": "string",
  "status": 0,
  "subscriber": "string",
  "thirdPartyRef": "string",
  "type": "string"
}