Give Bill Value
Overview
Description: endpoint processes transactions by validating, processing and applying a requested service or payment.
Endpoint: {base_url}/process
REQUEST PARAMETER
- Request Parameters
- Response 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 | No |
3 | parameters.name | String | Name of the parameter | Yes (if parameters is provided) |
4 | parameters.value | String | Value of the parameter | Yes (if parameters is provided) |
5 | pin | String | User's PIN for authentication | Yes |
6 | serviceId | String | Unique identifier for the service | Yes |
7 | sessionid | String | Unique session identifier | Yes |
8 | terminalId | String | Unique identifier for the terminal | Yes |
Response Parameters
# | Parameter | Type | Description | Mandatory |
---|---|---|---|---|
1 | account | String | Account identifier related to the response | Yes |
2 | action | String | Action performed in the transaction | Yes |
3 | alias | String | Alias associated with the account | No |
4 | amount | Integer | Transaction amount | Yes |
5 | clientRef | String | Client reference ID for tracking | Yes |
6 | code | String | Response code indicating transaction status | Yes |
7 | String | Email address of the user | No | |
8 | error | String | Error message, if applicable | No |
9 | execTime | String | Execution time of the request | No |
10 | fault | String | Fault description, if applicable | No |
11 | fee | Integer | Transaction fee | No |
12 | hosterror | String | Host error message, if applicable | No |
13 | message | String | Additional message about the response | No |
14 | mobile | String | Mobile number of the user | No |
15 | name | String | Name of the user | No |
16 | narration | String | Transaction narration | No |
17 | otherinfo | String | Additional information | No |
18 | period | String | Period associated with the transaction | No |
19 | reference | String | Unique transaction reference ID | Yes |
20 | response | String | Detailed response message | Yes |
21 | status | Integer | Status code of the transaction | Yes |
22 | subscriber | String | Subscriber identifier | No |
23 | thirdPartyRef | String | Reference ID from a third party | No |
24 | type | String | Type of transaction | Yes |
- Sample Request
- Sample Response
Request Parameters
POST {base_url}/process
curl `${base_url}/process`
-H "Content-type: application/json"
-X POST
-d '{
"bundleId": 0,
"parameters": [
{
"name": "string",
"value": "string"
}
],
"pin": "string",
"serviceId": "string",
"sessionid": "string",
"terminalId": "string"
}
'
Response Parameters
POST {base_url}/process
{
"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"
}