Выписка по счету
Вы можете запросить выписку по расчетному или номинальному счету в рублях. Выписку можно получить по данным за одни сутки.
Чтобы получить выписку, используйте метод report/account_statement
.
Параметры запроса
Название | Обязательность | Тип | Описание |
---|---|---|---|
X-PARTNER-PROJECT | + | string | Идентификатор проекта. Выдается менеджером Банка 131 |
X-PARTNER-SIGN | + | string | Подпись запроса |
date_from | + | date | Дата начала выписки. Пример: 2023-06-01 |
date_to | + | date | Дата окончания выписки. Пример: 2023-06-01 |
account_number | + | string | Номер счета (20 цифр), по которому запрашивается выписка |
Значения в
date_from
иdate_to
должны совпадать.
Пример запроса
https://demo.bank131.ru/api/v1/report/account_statement \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d '{
"date_from": "2023-06-01",
"date_to": "2023-06-01",
"account_number": "40702810600200000014"
}'
Параметры ответа
Название | Обязательность | Тип | Описание |
---|---|---|---|
status | + | string | Статус. Возможные варианты: error , ok |
name | + | string | Название метода account_statement |
account_statement | + | object | Детали выписки |
date_from | + | date | Дата начала выписки |
date_to | + | date | Дата окончания выписки |
account_number | + | string | Номер счёта (20 цифр), по которому сформирована выписка |
total_turnover | + | object | Информация по движению средств |
debet | + | int | Сумма списаний по счёту за период выписки |
credit | + | int | Сумма пополнений по счёту за период выписки |
total_balance | + | object | Информация по балансу |
opening | + | int | Входящий остаток по счёту на дату начала выписки |
closing | + | int | Исходящий остаток по счёту на дату окончания выписки |
transactions | + | object | Список транзакций |
amount | + | int | Сумма транзакции (только неотрицательные значения) |
base_amount | - | int | Сумма операции в валюте. Заполняется только для транзакций в валюте, отличной от рублей. При использовании базовой валюты (RUB) параметр является необязательным |
currency | + | string | Валюта операции |
payment_date | + | date | Дата операции |
bank_system_id | + | string | Идентификатор платежа. Указывается для любого движения денежных средств по счету: - для платежей, отправленных по API - для переводов из другого банка - для платежей, совершенных через интернет-банк |
transaction_id | - | string | Идентификатор транзакции. Передается для платежей, отправленных по API |
session_id | - | string | Идентификатор сессии. Передается для платежей, отправленных по API |
purpose | + | string | Назначение платежа |
counter_party | + | object | Информация о контрагенте |
kpp | - | string | КПП контрагента |
inn | - | string | ИНН контрагента |
name | + | string | Наименование контрагента |
account_number | + | string | Номер счета контрагента |
bank_code | + | string | БИК банка контрагента |
type | + | string | Тип транзакции. Может принимать значения credit (для операции пополнения) или debet (для операции списания) |
Пример успешного ответа
{
"status": "ok",
"method": {
"name": "account_statement",
"account_statement": {
"date_from": "2022-11-12T18:19:32.487+0000",
"date_to": "2022-11-13T18:19:32.487+0000",
"account_number": "40703810500000000025",
"total_turnover": {
"debet": 0,
"debet_base": null,
"credit": 100,
"credit_base": null
},
"total_balance": {
"opening": 0,
"opening_base": null,
"closing": 100,
"closing_base": null
},
"transactions": [
{
"amount": 10000,
"base_amount": null,
"currency": "RUB",
"payment_date": "2022-11-13",
"bank_system_id": "2080040097819020",
"transaction_id": "c7b923ec-844f-4d98-ad02-795d62fe1989",
"session_id": "ps_3230",
"purpose": "Пополнение счета для тестов",
"counter_party": {
"kpp": "165501001",
"inn": "1655415696",
"name": "Плата за услуги процессинга по переводам без открытия счета",
"account_number": "70606810600004710401",
"bank_code": "049205131"
},
"type": "credit"
}
]
}
}
}
Примеры неуспешных ответов
date_from
не равна date_to
{
"status": "error",
"error": {
"description": "Invalid input request parameters: (max interval is 1 day)",
"code": "invalid_request"
}
}
date_from
больше date_to
{
"status": "error",
"error": {
"description": "Invalid input request parameters: (date_to must be greater than date_from); (max interval is 1 day)",
"code": "invalid_request"
}
}
Невалидная дата в date_from
{
"status": "error",
"error": {
"description": "Invalid value in date_from",
"code": "invalid_request"
}
}
Невалидная дата в date_to
{
"status": "error",
"error": {
"description": "Invalid value in date_to",
"code": "invalid_request"
}
}
Невалидный запрос по формату JSON
{
"status": "error",
"error": {
"description": "Invalid request",
"code": "invalid_request"
}
}
Внутренняя ошибка
Данный ответ возвращается в следующих случаях:
- номер счета указан неверно,
- запрашивается выписка по несуществующему счету,
- счет, по которому запрошена выписка, не принадлежит клиенту.
{
"status": "error",
"error": {
"description": "Internal error",
"code": "internal_error"
}
}