Перейти к содержанию

Справка о выплате

Методы получения справки об успешной транзакции. Доступны только для работы с Альфа-Банком. Справку по транзакции от банка можно будет получить только на следующий день.

Получение на почту

Метод отправки PDF файла с информацией о выполненной транзакции на указанный адрес электронной почты.

URL

Метод: POST

  • Production: https://api.pay.kvell.group/v1/orders/{transaction}/operation-certificate
  • Stage: https://api.pay.stage.kvell.group/v1/orders/{transaction}/operation-certificate

Параметры запроса

Название Тип данных Обязательно Описание
transaction string Да Уникальный номер транзакции на стороне мерчанта

Параметры в теле запроса

Название Тип данных Обязательно Описание
email string Да Адрес электронной почты, куда будет направлен отчет.

Пример запроса

{
  "email": "user@user.com"
}

Заголовки запроса

Название Тип данных Обязательно Описание
X-Api-Key string Да Уникальный идентификатор магазина
X-Signature string Да Подпись

Подпись X-Signature формируется конкатенацией X-Api-Key, transaction, email и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{transaction}{email}{secret_key})

где secret_key - секретный ключ, который находится в настройках магазина мерчанта;

Ответ запроса

    Успех, нет контента.

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Получение по ссылке

Создание задачи по получению ссылки

Метод создания задачи для получения PDF файла с информацией о выполненной транзакции по ссылке.

URL

Метод: POST

  • Production: https://api.pay.kvell.group/v1/orders/{transaction}/operation-certificate/view
  • Stage: https://api.pay.stage.kvell.group/v1/orders/{transaction}/operation-certificate/view

Параметры запроса

Название Тип данных Обязательно Описание
transaction string Да Уникальный номер транзакции на стороне мерчанта

Заголовки запроса

Название Тип данных Обязательно Описание
X-Api-Key string Да Уникальный идентификатор магазина
X-Signature string Да Подпись

Подпись X-Signature формируется конкатенацией X-Api-Key, transaction и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{transaction}{secret_key})

Ответ запроса

{
  "task_id": "9d711e68-3b94-4a40-9b20-b7a659ef252d"
}

Получение статуса и результата задачи

Рекомендуется запрашивать раз в 5 минут.

URL

Метод: GET

  • Production: https://api.pay.kvell.group/v1/orders/{transaction}/operation-certificate/view
  • Stage: https://api.pay.stage.kvell.group/v1/orders/{transaction}/operation-certificate/view

Заголовки запроса

Название Тип данных Обязательно Описание
X-Api-Key string Да Уникальный идентификатор магазина
X-Signature string Да Подпись

Подпись X-Signature формируется конкатенацией X-Api-Key, transaction и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{transaction}{task_id}{secret_key})

Параметры строки запроса

Название Тип данных Обязательно Описание
task_id string Да ID задачи из ответа на запрос по созданию задачи

Ответ запроса

Название Тип данных Описание
status string Статус задачи. Ворозможные статусы: in_progress, done, error
order_id string ID заказа
url string Ссылка на справку. null если ссылки ещё нет
error_message string Сообщение об ошибке, если статус error 
{
  "status": "in_progress",
  "order_id": "string",
  "url": "string",
  "error_message": "string"
}