Песочница
POST https://sandbox.alfabank.ru/api/jp/v1/accounts/{accountNumber}/transactions/files/requests
Пром
POST https://baas.alfabank.ru/api/jp/v1/accounts/{accountNumber}/transactions/files/requests
Scope
transactions
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Возможны два варианта:
-
•Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
-
•ApiKey {API Key}, полученный через Портал разработчика
Content-Type
stringrequired
application/json
PATH
Атрибут
Описание
accountNumber
stringrequired
Номер расчётного счёта
BODY
Атрибут
Описание
requestId
string(uuid)required
Идентификатор запроса, необходимо сгенерировать самостоятельно
executeDate
string(date)required
Дата исполнения
format
stringrequired
Формат выписки. Возможные значения:
-
•
pdf- PDF-файл; -
•
xls- XLSX-файл; -
•
csv- CSV-файл; -
•
1c- 1C-файл в формате .txt
withDocument
booleanoptional
Параметр, добавляющий к выписке все документы (например, платёжные поручения). Вся выписка возвращается в .zip. Данное поле доступно для заполнения, только если format = pdf. Возможные значения:
-
•
true- добавлять документы; -
•
false- не добавлять документы
withSignature
booleanoptional
Параметр необходимости получения выписки с подписью (к файлу формируется файл с подписью банка pcs, и вся выписка возвращается в .zip). Данное поле доступно для заполнения, только если format = pdf. Возможные значения:
-
•
true- с подписью; -
•
false- без подписи
objectoptional
Информация о способе отображения комиссии в выписке
commissions
booleanoptional
Объединение комиссии. Возможные значения:
-
•
true- если требуется схлопнуть комиссии за сутки в одну транзакцию (устанавливается по умолчанию); -
•
false- если требуется отображение комиссии по каждой операции
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v1/accounts/{accountNumber}/transactions/files/requests' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--data '{
5 "requestId": "67e50b09-a203-4119-86cb-647d06a803a0",
6 "executeDate": "2021-09-06",
7 "format": "pdf",
8 "withDocument": false,
9 "withSignature": false,
10 "merge": {
11 "commissions": true
12 }
13}'Параметры ответа
1Нет тела ответа
Нет тела ответа
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
invalid_request- неверные входные параметры запроса
error_description
stringoptional
Описание ошибки
Пример ошибки 400 (Bad Request)
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers"
4}
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощьюrefresh_token. При отзыве токена необходимо заново пройти авторизацию"
error_description
stringoptional
Описание ошибки
Пример ошибки 401 (Unauthorized)
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
insufficient_scope- при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметраprompt=consent; -
•
access_denied- доступ к счёту запрещён
error_description
stringoptional
Описание ошибки
Пример ошибки 403 (Forbidden)
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
unknown_endpoint- эндпоинт не найден или неактивен
error_description
stringoptional
Описание ошибки
Пример ошибки 404 (Not Found)
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}
Нет тела ответа
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional
Описание ошибки
Пример ошибки 500 (Internal Server Error)
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}
Нет тела ответа
Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.
Параметры зашифрованного запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
Accept
stringrequired
application/jose
Content-Type
stringrequired
application/jose
PATH
Атрибут
Описание
accountNumber
integerrequired
Номер расчётного счёта
BODY
Атрибут
Описание
stringrequired
Зашифрованное тело запроса
Пример зашифрованного запроса
1curl -X POST https://baas.alfabank.ru/api/jp/v1/accounts/40702810301300001458/transactions/files/requests \
2 -H 'Accept: application/jose' \
3 -H 'Authorization: Bearer {access-token}' \
4 -H 'Content-Type: application/jose' \
5 -d '
6 eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.vtN63c_zu0fy9f7PhIwezv63jUZXK3Xyqz6YZ4Ku6Wu6AlueD-uVpioeS8ocJabmSxqKpe-2tH8AE5wmFYnYRPhDH89iSSq2-sSi7-Rb0z6KKqHvKNp6dDDG1a-UnMjHQCV_D333HRpdtUQPEJrrvYM2dWsie2pqReR140vzR3DXKgpxV9O4wLF4T_D295a_APcmAFcbNS0TJTPmF3A04g2fGw2E4b7LvXGOSy7JF8LdSaL56LK3mIFlieFFeaR9ketrFVxoMg3uykRTVsv11IyEsx0iC5gCT5gCtmESxnsx6wR6BBbO0I2yyPYTYhY2BVfIDDCwBBvwd8KZ1Y17bQ.6y6nWl7M5hw2ckeH.jIfoUv3S3bAeuWxVV5oxMWcfW_WzVpnxrCV5BPQiyi_y4LpAPYLyFAqqlIHflPEqWdC88fmqY_66dSMKUDvHZv5FHhrQZ-TVJeIxaO5GIXIvAOKbONo7i3awYUsMNXTo7pMIJgt5bm8ShLmPcZOIVYY7_u_kJwic-24op7XS7PJC3kQurekccjOOQls-LBlNsE2qGOjoqIaHAcFraxg8MffbYp670sjn5-HvPUgGMNPi347_tygEGtJh9kLpaXNUTXjQMEBttqegdJ1t9rghJAQAU16czaQmw66nhIqGyoh2rxvqFQ9Epi1disnC3wjjVTaB7MNZ1HzKNq5t7H5yboRRr9Tq4X0IuaGN4ENKtnTaBpwEghb-b0qyGk2hAyd-tSbkNOu3SOkQqYQKMatBqCCx3OpaaV_Vbz-tNik_MoqPExzbJABGH5rAdlVJ3LCfy2cPW8Omw5j0mysFESzKSDokXC99RDwcmcAoNCSDObuV5-HYyVbvu4IzBgC8Mie5IFHNeBRE8xO_Ze5Dl37ljTb9GwvrvQg7ugkdbrzE0Z-t9FsIPvwBI163kS4s0opgvd6ul0IG9jNbvUrRZ1HlT5iu3D1e_DVe7nZA3ykHyQZkOkmGYYOSjjZFiWlV0ZnOd_-qu6S6cTFj9OZwp0O5AXKg7vxufIKz0rvXDM1wf4C6iis3SpnhLDi2Y051C6MhTygXVQ4Lui5vgRckin4t4Ib-0IHMH5jlUnt0HjevNwIwNfdh4h8tv3-t6Jfc-_89gMTp96Gf7ZRqUU4rev_apZYLFEnY9_KBOEG4rPHWhUQdb7vL87lVESQ-QDYdMsTxQA.TVM2F_uBNcj4KsC5u8b6qw'