Подтверждение списания средств

ВНИМАНИЕ: Новый формат ответа для ошибок

В ближайшее время в нашей системе ошибки будут разделены на ожидаемые и неожидаемые. Это приведет к изменению формата JSON-ответа в зависимости от типа ошибки. Пожалуйста, ознакомьтесь с изменениями на странице Коды Ошибок. Изменения будут применены ко всем API в системе AGWS, за исключением методов «Проведение платежа».

Нажмите здесь, чтобы просмотреть старые и новые ответы об ошибках JSON. Обратите внимание на это обновление и убедитесь, что ваша система готова к изменениям, если это необходимо.

Для некоторых услуг необходимо подтверждать списание используя дополнительные атрибуты например отп-код.

POST https://agwsapi.tarlanpayments.kz/showcase-gateway/api/v1/action/confirm/invoice

Headers

Name	Value
Content-Type	application/json
X-Signature	Авторизационный хэш

Body

Name	Type	Description
agent*	String	Код витрины в системе Tarlanpayments
confirm_code	String	Код подтверждения платежа
external_id*	String	Идентификатор платежа на стороне витрины

Response

Name	Type	Description
status	bool	Статус обработки запроса
status_code	uint	Код ошибки
message	string	Оисание ошибки
result	Object	Объект хранящий информацию о платеже
-is_success	String	Флаг успешности платежа
-transaction_status_id	String	Статус транзакции
-fail_reason	Object	Поле содержащее причину неуспеха
-external_id	String	Идентификатор платежа на стороне витрины
-otp_status	bool	Флаг успешности проверки otp

200: OK Пример успешного ответа

{
    "status": true,
    "status_code": 0,
    "message": "Success",
    "result": {
        "is_success": true,
        "transaction_status_id": "4",
        "external_id": "200001",
        "message": "",
        "otp_status": false,
        "fail_reason": {
            "code": 402,
            "message": "Incorrect confirmation code"
        }
    }
}

Примеры ответов об ошибках до внесения изменений

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": {}
}

Примеры ответов об ошибках после внесения изменений

200 OK: Ожидаемая ошибка

{
    "status": true,
    "status_code": 0,
    "message": "Success",
    "result": {
        "error_code": 1041,
        "message": "Order not found",
        "data": null,
        "additional_data": null
    }
}

400 Bad Request: Неожидаемая ошибка

{
    "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' \ 
--data '{ 
    "agent": "test_agent",
    "confirm_code": "104000", 
    "external_id": "externa312" 
}'