Balance Credit Debit Api
Balance Credit Debit
Description :
This API endpoint is used to get the Balance credit debit report of the user.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| from_date | Date | Yes | date in Y-m-d format | |||
| to_date | Date | Yes | date in Y-m-d format | |||
| type | string | Optional | credit, debit | |||
| offset | integer | 0 | No | number of records to skip before starting to return results. | ||
| limit | integer | 10 | No | determines the maximum number of records to return in the response. |
Request Example
Responses (JSON)
- Status Code 1: records fetched
- Description: records successfully fetched.
- 'status_code' (integer): 1
- 'message' (string): "records successfully fetched"
- 'recordsTotal' (integer): "number or total records"
- 'recordsFiltered' (integer): "number or records filtered"
-
'data' (Array): "it contains array of object"
- 'txn_id' (integer): "id of the transaction"
- 'transfer_type' (string): "trasnfer type credit or debit"
- 'prev_balance' (string): "balance before transaction"
- 'transfer_amount' (string): "amount of transaction"
- 'post_balance' (string): "balance after transaction"
- 'payment_mode' (string): "mode of payment"
- 'utr' (string): "reference no for transaction"
- 'remark' (string): "remark from user"
- 'created_date' (string): "date of record created"
- 'created_time' (string): "time of record created"
{"status_code": 2, "message": "type 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": "records not found"}, 200
- Status Code 0: Error message
- Description: A specific error message.
- 'status_code' (integer): 0
- 'message' (string): "there is no data found"
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.