Fetch Commercial Api
Fetch Commercials
Description :
This API endpoint is used to fetch commercials.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Required | Description | |||
|---|---|---|---|---|---|---|
| operator_code | string | Yes | Operator code for operator identification | |||
| amount | integer | Yes | Please pass the amount which you want to get commercials |
Request Example
Responses (JSON)
- Description: Data fetched successfully.
- status_code (integer): The status code of the response.
- data (object):
- amount (string): Amount of transaction.
- gst (integer): Gst amount.
- tds (integer): Tds amount.
- rate (integer): Commission.
- type (string): Optional.
- per_flat (string): Flat or Percent.
- commission_surcharge (string): Commission or Surcharge.
- charged_amount (string): This amount will be charged to user.
{"status_code": 2, "message": "operator_code is required"}, 422
- Status Code 2: Validation Error
- Description: Validation error in the input parameters.
- 'status_code' (integer): 2
- 'message' (string): "A specific validation error message."
{"status_code": 0, "message": "Unable to fetch data"}, 200
- Status Code 0: Error message
- Description: A specific error message.
- 'status_code' (integer): 0
- 'message' (string): "Unable to fetch data"
Note
- The API endpoint should be accessed via a POST request.
- Ensure that the request is properly validated and sanitized to prevent security vulnerabilities.
- Implement proper error handling on the client side to display user-friendly error messages based on the 'status_code' and 'message' fields in the response.