Skip to main content

Формат ответа

Ответ на запрос содержит код ответа (состояния) HTTP, стандартные заголовки и при необходимости тело ответа.

Тело ответа при успехе​

Основная сущность API — это объект. Например, для проведения платежа нужен объект платежа, а для проведения выплаты — объект выплаты. Каждый запрос в API связан с выполнением определенного действия над объектом, например создание объекта, получение информации о нём.

При успешной обработке запроса (HTTP 200) API возвращает в теле ответа созданный, измененный или запрошенный объект или список объектов. Формат тела ответа — JSON. Параметры тела ответа зависят от запроса.

Пример тела ответа​

JSON
{
    "success": true,
    "response": {
        "id": "02b150d3-6302-4358-9be5-b3606718791f",
        "amount": {
            "currency": "RUB",
            "value": 100.00
        },
        "status": "NEW",
        "paid": false,
        "created_at": "2019-01-22T14:30:45.129Z",
    }
}

Тело ответа при ошибке​

Если с запросом что-то не так (код ответа HTTP, отличный от 200), то для кодов ответа HTTP 400, 401, 403, 404, 429 и 500 вернется тело ответа в формате JSON с описанием ошибки.

Пример тела ответа при ошибке​

JSON
{
    "success": false,
    "error": {
        "status_code": 400,
        "code": "BAD_REQUEST",
        "message": "payment_id must be a string"
    }
}