# Выгрузка справок по транзакциям
# Инициализация процесса выгрузки
Данное api позволяет массово выгрузить справки по транзакциям в формате PDF с факсимиле и без. Основные принципы работы с api описаны выше.
ОБРАТИТЕ ВНИМАНИЕ!
Справки формируются асинхронно, время формирования отчета варьируется от нескольких секунд и, ориентировочно, до получаса, в зависимости от количества операций в запросе.
Для выполнения требуются скоупы report.read
report.write
clients.read
transactions.read
clients:client.read
, которые необходимо запросить при аутентификации.
Параметр | Тип | Обязателен | Описание |
---|---|---|---|
cs1_ids | array | Да | Cписок id платежей, для которых будут формироваться справки |
sign_type | string | Да | Тип подписи, который будет использоваться: 1) no_sign - без подписи 2) sign1 - с факсимиле Сизов А.Е. |
Запрос:
POST https://api.psp.io/report-generator-nt/v1/report/payments/transactions/statements
{
"cs1_ids": [
"43913ddc000c4d3990fddbd3980c1725",
"1e68b13b34e247fd9ac3583ae9947127"
],
"sign_type": "sign1"
}
Ответ в случае успешного создания запроса:
{
"report": {
"id": "9506073e-457d-4385-8eab-837672704c91",
"status": "initial",
"report_type": "report",
"error_message": null,
"created_at": "2023-05-29T20:38:55.469834Z",
"updated_at": "2023-05-29T20:38:55.469834Z"
}
}
# Проверка статуса выгрузки
Параметр | Тип | Обязателен | Описание |
---|---|---|---|
id | string | Да | id запроса - в конце Url строки указывается id запроса, полученный в ответе на инициализацию процесса |
Запрос:
GET https://api.psp.io/report-generator-nt/v1/report/9506073e-457d-4385-8eab-837672704c91
Ответ в случае успешного создания запроса:
{
"report": {
"id": "9506073e-457d-4385-8eab-837672704c91",
"status": "success",
"report_type": "report",
"error_message": null,
"created_at": "2023-05-29T20:38:55.469834Z",
"updated_at": "2023-05-29T20:38:56.091098Z"
}
}
Если status
запроса success
, то он успешно сформирован и можно скачивать архив с файлами.
# Выгрузка справок в PDF
Параметр | Тип | Обязателен | Описание |
---|---|---|---|
id | string | Да | id запроса - в Url строке указывается id запроса, полученный в ответе на инициализацию процесса |
Запрос:
GET https://api.psp.io/report-generator-nt/v1/report/9506073e-457d-4385-8eab-837672704c91/download
Ответ, в случае успешного создания запроса:
Ответ будет содержать набор символов файлов PDF. Данный ответ нужно сохранить в файл. По итогу будет получен архив "response.zip" со справками по запрошенным операциям.