Confirmation of funds debit

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/action/confirm/invoice

Headers

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

Body

Name	Type	Description
agent*	String	Showcase code in the Tarlanpayments system
confirm_code	String	Payment confirmation code
external_id*	String	Payment ID on the showcase side

Response

Name	Type	Description
status	bool	Request processing status
status_code	uint	Error code
message	string	Description of error
result	Object	An object storing payment information
-is_success	String	Payment success flag
-transaction_status_id	String	Transaction status
-external_id	String	Payment ID on the showcase side
-otp_status	bool	otp check success flag

200: OK Example of a successful response

{
    "status": true,
    "status_code": 0,
    "message": "Success",
    "result": {
        "is_success": true,
        "transaction_status_id": "1",
        "external_id": "200001",
        "message": "",
        "otp_status": true
    }
}

Examples of error responses before the changes

400 Bad Request

{
    "status": false,
    "status_code": 1041,
    "message": "Order not found",
    "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": 1041,
        "message": "Order not found",
        "data": null,
        "additional_data": null
    }
}

400 Bad Request: Unexpected Error

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

curl --location 'https://agwsapi.tarlanpayments.kz/showcase-gateway/api/v1/action/confirm/invoice' \
--header 'Content-Type: application/json' \
--header 'X-Signature: your_signature_here' \
--data '{
    "agent": "test_agent",
    "confirm_code": "104000",
    "external_id": "externa312"
}'