Checking the remaining balance on the account

ATTENTION: New Error Response Format In the near future, errors in our system will be classified as expected and unexpected. Depending on the type of error, the format of the JSON response will be changed. Please review the new formats on the Error Codes page. This change will be applied to all APIs in the AGWS system except ''Make a payment'.

Click here to view the old and new JSON error responses. Please take note of this update and ensure your system is ready for these changes, if necessary.

POST https://agwsapi.tarlanpayments.kz/showcase-gateway/api/v1/showcase/balance

Headers

Name	Value
Content-Type	application/json
X-Signature	Authorization hash

Body

Name	Type	Description
agent*	String	Showcase code in Tarlan system

Response

Name	Type	Description
status	bool	Request processing status
status_code	uint	Error code
message	string	Description of error
result	Object	The result of a request that contains information
-showcase_code	String	Showcase code in Tarlan system
-balance	float	Current balance

200: OK Example of a successful response

{
    "status": true,
    "status_code": 0,
    "message": "Success",
    "result": {
        "showcase_code": "daw",
        "balance": 0
    }
}

Examples of error responses before the changes

404 Not Found

{
    "status": false,
    "status_code": 8015,
    "message": "account doesn't exist",
    "result": {}
}

400 Bad Request

{
    "status": false,
    "status_code": 1014,
    "message": "Invalid signature",
    "result": {}
}

Examples of error responses after the changes

200 OK: Expected error

{
    "status": true,
    "status_code": 0,
    "message": "Success",
    "result": {
        "error_code": 8015,
        "message": "account doesn't exist",
        "data": null,
        "additional_data": null
    }
}

400 Bad Request: Unexpected error

{
    "status": false,
    "status_code": 1014,
    "message": "Invalid signature",
    "result": {}
}