B2BH2H

Получение выписки по идентификатору

Песочница
GET https://sandbox.alfabank.ru/api/jp/open-banking/v1.3/statements/{statementId}
Пром
GET https://baas.alfabank.ru/api/jp/open-banking/v1.3/statements/{statementId}
Scope

accounts

Описание

Метод позволяет получить сформированную с помощью метода «Создание запроса на формирование выписки» выписку по стандартам Банка России (версия 1.3.3le) по её идентификатору.

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

x-fapi-auth-date
stringoptional

Время последнего входа Пользователя в систему с TPP. Значение предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]

x-fapi-customer-ip-address
stringoptional

IP-адрес Пользователя, если Пользователь в данный момент подключён к Стороннему Поставщику (авторизован в приложении Стороннего Поставщика)

x-fapi-interaction-id
stringrequired

RFC4122 UID, используемый в качестве идентификатора корреляции

x-customer-user-agent
stringoptional

Тип устройства (user-agent), которое использует пользователь

QUERY
Атрибут
Описание
page
integeroptional

Номер страницы

fromBookingDateTime
stringoptional

Дата и время начала расчётов, представленных в выписке, в формате YYYY-MM-DDThh:mm:ss±hh:mm. Должна совпадать с fromBookingDateTime, указанными при создании выписки

toBookingDateTime
stringoptional

Дата и время окончания расчётов, представленных в выписке, в формате YYYY-MM-DDThh:mm:ss±hh:mm. Должна совпадать с fromBookingDateTime, указанными при создании выписки

PATH
Атрибут
Описание
statementId
stringrequired
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/open-banking/v1.3/statements/{statementId}?page={page}&fromBookingDateTime=2025-12-02T11%3A40%3A21+00%3A00&toBookingDateTime=2025-12-03T11%3A40%3A21+00%3A00' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json' \
4--header 'x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT' \
5--header 'x-fapi-customer-ip-address: 172.123.123.123' \
6--header 'x-fapi-interaction-id: 97ed4827-7b6f-4491-a06f-b548d5a7512d' \
7--header 'x-customer-user-agent: mobile'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "Data": {
3    "statementId": "9b23e27e-f4f8-4cab-9b80-aaa008d4330c",
4    "accountId": "95791e79-0f2d-47de-a5e0-df034b285XXx",
5    "fromBookingDateTime": "2025-12-02T11:40:21+00:00",
6    "toBookingDateTime": "2025-12-03T11:40:21+00:00",
7    "creationDateTime": "2021-10-05T15:15:13+00:00",
8    "Balance": [
9      {
10        "creditDebitIndicator": "Credit",
11        "type": "OpeningAvailable",
12        "Amount": {
13          "amount": "2000.00",
14          "currency": "RUB"
15        }
16      },
17      {
18        "creditDebitIndicator": "Credit",
19        "type": "ClosingAvailable",
20        "Amount": {
21          "amount": "700.00",
22          "currency": "RUB"
23        }
24      }
25    ],
26    "TransactionsSummary": {
27      "TotalCreditEntries": {
28        "numberOfEntries": "2",
29        "sum": "100.00",
30        "currency": "RUB"
31      },
32      "TotalDebitEntries": {
33        "sum": "1500.00",
34        "currency": "RUB"
35      }
36    },
37    "Entry": [
38      {
39        "transactionIdentification": "73791e79-0f2d-47de-a5e0-df034b285XXx",
40        "purpose": "1",
41        "creditDebitIndicator": "Debit",
42        "status": "AcceptedSettlementCompleted",
43        "bookingDateTime": "2023-12-15T00:00:00+00:00",
44        "valueDateTime": "2023-12-15T00:00:00+00:00",
45        "Amount": {
46          "amount": "200.00",
47          "currency": "RUB"
48        },
49        "TransactionAmount": {
50          "amount": "200.00",
51          "currency": "RUB"
52        },
53        "PaymentTypeInformation": {
54          "localInstrument": "01",
55          "categoryPurpose": "1",
56          "serviceLevel": "URGP"
57        },
58        "Debtor": {
59          "Agent": {
60            "name": "Наименование организации или физического лица",
61            "BankIdentification": [
62              {
63                "schemeName": "RU.CBR.BIC",
64                "identification": "9612123"
65              }
66            ],
67            "OrganizationIdentification": [
68              {
69                "schemeName": "RU.CBR.TXID",
70                "identification": "7728240240"
71              }
72            ],
73            "CorrespondentAccount": {
74              "schemeName": "RU.CBR.BBAN",
75              "identification": "40817810621234570000"
76            }
77          }
78        },
79        "DebtorAgent": {
80          "schemeName": "RU.CBR.BIC",
81          "identification": "9612123"
82        },
83        "DebtorAgentAccount": {
84          "schemeName": "RU.CBR.BBAN",
85          "identification": "40817810621234570000"
86        },
87        "DebtorAccount": {
88          "schemeName": "RU.CBR.BBAN",
89          "identification": "40817810621234570000"
90        },
91        "IntermediaryAgent": {
92          "schemeName": "RU.CBR.BIC",
93          "identification": "9612123"
94        },
95        "CreditorAgent": {
96          "schemeName": "RU.CBR.BIC",
97          "identification": "9612123"
98        },
99        "CreditorAccount": {
100          "schemeName": "RU.CBR.BBAN",
101          "identification": "40817810621234570000"
102        },
103        "CreditorAgentAccount": {
104          "schemeName": "RU.CBR.BBAN",
105          "identification": "40817810621234570000"
106        },
107        "Creditor": {
108          "Agent": {
109            "name": "Наименование организации или физического лица",
110            "BankIdentification": [
111              {
112                "schemeName": "RU.CBR.BIC",
113                "identification": "9612123"
114              }
115            ],
116            "OrganizationIdentification": [
117              {
118                "schemeName": "RU.CBR.TXID",
119                "identification": "7728240240"
120              }
121            ],
122            "CorrespondentAccount": {
123              "schemeName": "RU.CBR.BBAN",
124              "identification": "40817810621234570000"
125            }
126          }
127        },
128        "RemittanceInformation": {
129          "unstructured": "Назначение платежа - оплата за товары или услуги",
130          "ReferredDocumentInformation": [
131            {
132              "Number": "0",
133              "RelatedDate": "2021-06-05T15:15:13+00:00"
134            }
135          ],
136          "TaxRemittance": {
137            "administrationZone": "45388000",
138            "referenceNumber": "120",
139            "date": "2021-06-05T15:15:13+00:00",
140            "creditor": {
141              "taxType": "991230001"
142            },
143            "debtor": {
144              "taxType": "991230001"
145            },
146            "Record": {
147              "type": "1234",
148              "category": "TP",
149              "categoryDetails": "18210301000011000000",
150              "debtorStatus": "13"
151            }
152          }
153        }
154      }
155    ]
156  },
157  "Links": {
158    "self": "https://sb.example.ru/v1.3/example?page=1",
159    "first": "https://sb.example.ru/v1.3/example?page=1",
160    "prev": "https://sb.example.ru/v1.3/example?page=1",
161    "next": "https://sb.example.ru/v1.3/example?page=1",
162    "last": "https://sb.example.ru/v1.3/example?page=1"
163  },
164  "Meta": {
165    "totalPages": 1
166  }
167}
HEADERS
Атрибут
Описание
x-fapi-interaction-id
stringrequired

RFC4122 UID, используемый в качестве идентификатора корреляции

x-jws-signature
stringrequired

Отделяемая подпись полезной нагрузки в формате JWS

BODY
атрибут
описание
objectrequired

Полезная нагрузка ответа

statementId
stringrequired

Идентификатор выписки

accountId
stringrequired

Идентификатор номера расчётного счёта

fromBookingDateTime
stringrequired

Дата и время начала расчётов, представленных в выписке

toBookingDateTime
stringrequired

Дата и время окончания расчётов, представленных в выписке

creationDateTime
stringrequired

Дата и время создания ресурса

array of objectsoptional

Детальная информация об остатке на счёте

creditDebitIndicator
stringrequired

Направление остатка на счёте. Принимает возможные значения:

  • •
    Credit - остаток на счёте положительный;
  • •
    Debit - остаток на счёте отрицательный
type
stringrequired

Тип остатка. Принимает возможные значения:

  • •
    OpeningAvailable - начальный баланс суммы денег, которая находится в распоряжении владельца счёта на указанную дату;
  • •
    ClosingAvailable - конечный остаток суммы денег, которая находится в распоряжении владельца счёта на указанную дату
objectrequired

Сумма остатка

amount
stringrequired

Сумма денежных средств

currency
stringrequired

Код валюты в соответствии с ISO 4217

objectoptional

Обороты по кредиту и дебету

objectoptional

Обороты по кредиту

numberOfEntries
stringoptional

Колличество записей

sum
stringrequired

Общая сумма всех записей

currency
stringrequired

Код валюты в соответствии с ISO 4217

objectoptional

Обороты по дебету

numberOfEntries
stringoptional

Колличество записей

sum
stringrequired

Общая сумма всех записей

currency
stringrequired

Код валюты в соответствии с ISO 4217

array of objectsoptional

Список операций

transactionIdentification
stringoptional

Идентификатор операции по счёту

purpose
stringoptional

(Реквизит 15.5 - код вида дохода) Причина, по которой осуществляется платёж. Принимает возможные значения:

  • •
    1 - перевод денежных средств, являющихся заработной платой и (или) иными доходами;
  • •
    2 - перевод денежных средств, являющихся доходами, на которые не может быть обращено взыскание;
  • •
    3 - перевод денежных средств, являющихся доходами, к которым ограничения по обращению взыскания не применяются
creditDebitIndicator
stringrequired

Признак операции по счёту. Принимает возможные значения:

  • •
    Credit - кредитовая операция по счёту;
  • •
    Debit - дебетовая операция по счёту
status
stringrequired

Статус операции по счёту. Принимает возможные значения:

  • •
    AcceptedSettlementCompleted - расчёт по счёту плательщика завершён
bookingDateTime
stringrequired

Дата и время, когда запись об операции по счёту публикуется на счёте в бухгалтерской книге обслуживающей организации. Используется стандарт ISO8601

valueDateTime
stringoptional

Дата и время, когда активы становятся доступными владельцу счёта в случае ввода кредита или перестают быть доступными владельцу счёта в случае ввода дебетовой операции по счёту

objectrequired

Информация о сумме и валюте операции по счёту для данной записи

amount
stringrequired

Сумма денежных средств

currency
stringrequired

Код валюты в соответствии с ISO 4217

objectoptional

Сумма в валюте исходной операции по счёту

amount
stringrequired

Сумма денежных средств

currency
stringrequired

Код валюты в соответствии с ISO 4217

objectoptional

Информация о типе платежа

localInstrument
stringoptional

(Реквизит 5) Вид распоряжения

categoryPurpose
stringoptional

(Реквизит 15.3) Категория назначения. Очерёдность платежа. Принимает возможные значения:

  • •
    0 - очерёдность платежа не применяется;
  • •
    1 - алиментные удержания из заработной платы, компенсации вреда жизни и здоровью;
  • •
    2 - погашение задолженностей по зарплатам сотрудникам, выплаты выходных пособий и авторских вознаграждений;
  • •
    3 - выплаты зарплат сотрудникам по трудовым соглашениям, принудительная уплата налогов и отчислений во внебюджетные фонды;
  • •
    4 - принудительные выплаты, которые не вошли в первую, вторую и третью очередь, например, задолженности по договорам, штрафы, неустойки, коммунальные платежи;
  • •
    5 - не вошедшие в первую, вторую, третью и четвёртую категории, например, добровольная уплата долгов, пеней, штрафов
serviceLevel
stringoptional

(Реквизит 15.1) Вид платежа. Принимает возможные значения:

  • •
    URGP - срочный платёж;
  • •
    NURG - несрочный платёж
objectoptional

Плательщик

objectoptional

Информация об участнике, используемая для идентификации финансовой организации

name
stringrequired

Наименование организации

array of objectsrequired

Идентификация финансового учреждения

schemeName
stringrequired

Наименование идентификационной схемы финансового учреждения. Принимает возможные значения:

  • •
    RU.CBR.BIC - уникальный идентификатор банка, используемый в платёжных документах на территории Российской Федерации
identification
stringrequired

Банковский идентификационный код (БИК)

array of objectsoptional

Идентификация юридического лица

schemeName
stringrequired

Наименование идентификационной схемы юридического или физического лица. Принимает возможные значения:

  • •
    RU.CBR.TXID - ИНН/КИО
identification
stringrequired

ИНН

objectoptional

Корреспондентский счёт

schemeName
stringrequired

Схема идентификации счёта. Принимает возможные значения:

  • •
    RU.CBR.BBAN - базовый номер банковского счёта (RUCBRAccountIdentifier)
identification
stringrequired

Номер банковского счёта

objectoptional

Финансовое организация, обслуживающая счёт плательщика

schemeName
stringrequired

Наименование идентификационной схемы финансового учреждения. Принимает возможные значения:

  • •
    RU.CBR.BIC - уникальный идентификатор банка, используемый в платёжных документах на территории Российской Федерации
identification
stringrequired

Банковский идентификационный код (БИК)

objectoptional

Идентификация счёта плательщика у обслуживающего его банка в платёжной цепочке

schemeName
stringrequired

Схема идентификации счёта. Принимает возможные значения:

  • •
    RU.CBR.BBAN - базовый номер банковского счёта (RUCBRAccountIdentifier)
identification
stringrequired

Идентификатор счёта, соответствующий схеме идентификации

objectoptional

Идентификация счёта плательщика, на котором будет сделана дебетовая запись в результате операции

schemeName
stringrequired

Схема идентификации счёта. Принимает возможные значения:

  • •
    RU.CBR.BBAN - базовый номер банковского счёта (RUCBRAccountIdentifier)
identification
stringrequired

Идентификатор счёта, соответствующий схеме идентификации

objectoptional

Банк-посредник, находящийся между банком плательщика и банком получателя денежных средств

schemeName
stringrequired

Наименование идентификационной схемы финансового учреждения. Принимает возможные значения:

  • •
    RU.CBR.BIC - уникальный идентификатор банка, используемый в платёжных документах на территории Российской Федерации
identification
stringrequired

Банковский идентификационный код (БИК)

objectoptional

Финансовое организация, обслуживающая счёт получателя денежных средств

schemeName
stringrequired

Наименование идентификационной схемы финансового учреждения. Принимает возможные значения:

  • •
    RU.CBR.BIC - уникальный идентификатор банка, используемый в платёжных документах на территории Российской Федерации
identification
stringrequired

Банковский идентификационный код (БИК)

objectoptional

Идентификатор счёта получателя средств, на котором будет проведена запись о кредите в результате операции

schemeName
stringrequired

Схема идентификации счёта. Принимает возможные значения:

  • •
    RU.CBR.BBAN - базовый номер банковского счёта (RUCBRAccountIdentifier)
identification
stringrequired

Идентификатор счёта, соответствующий схеме идентификации

objectoptional

Идентификация счёта банка получателя денежных средств у обслуживающего его банка, по которому будет выполнена кредитовая запись в результате платёжной операции

schemeName
stringrequired

Схема идентификации счёта. Принимает возможные значения:

  • •
    RU.CBR.BBAN - базовый номер банковского счёта (RUCBRAccountIdentifier)
identification
stringrequired

Идентификатор счёта, соответствующий схеме идентификации

objectoptional

Получатель денежных средств

objectoptional

Информация об участнике, используемая для идентификации финансовой организации

name
stringrequired

Наименование организации

array of objectsrequired

Идентификация финансового учреждения

schemeName
stringrequired

Наименование идентификационной схемы финансового учреждения. Принимает возможные значения:

  • •
    RU.CBR.BIC - уникальный идентификатор банка, используемый в платёжных документах на территории Российской Федерации
identification
stringrequired

Банковский идентификационный код (БИК)

array of objectsoptional

Идентификация юридического лица

schemeName
stringrequired

Наименование идентификационной схемы юридического или физического лица. Принимает возможные значения:

  • •
    RU.CBR.TXID - ИНН/КИО
identification
stringrequired

ИНН

objectoptional

Корреспондентский счёт

schemeName
stringrequired

Схема идентификации счёта. Принимает возможные значения:

  • •
    RU.CBR.BBAN - базовый номер банковского счёта (RUCBRAccountIdentifier)
identification
stringrequired

Номер банковского счёта

objectoptional

Информация, позволяющая сопоставить запись с позициями, для которых предназначен перевод

unstructured
stringrequired

Текстовое назначение платежа

array of objectsoptional

Информация о связанном документе

Number
stringoptional

Номер связанного документа

RelatedDate
stringoptional

Дата связанного документа

objectoptional

Информация о платеже, которая связана с оплатой налогов

administrationZone
stringoptional

(Реквизит 105) Код ОКТМО

referenceNumber
stringoptional

(Реквизит 108) Номер налогового документа

date
stringoptional

(Реквизит 109) Дата налогового документа

objectoptional

Налоговая информация о получателе средств

taxType
stringoptional

Код причины постановки на учёт (КПП)

objectoptional

Налоговая информация о плательщике

taxType
stringoptional

Код причины постановки на учёт (КПП)

objectoptional

Дополнительные налоговые реквизиты

type
stringoptional

(Реквизит 110) Код выплат

category
stringoptional

(Реквизит 106) Основание налогового платежа

categoryDetails
stringoptional

Код бюджетной классификации

debtorStatus
stringoptional

Статус налогоплательщика

fromDate
stringoptional

Дата уплаты налогового платежа

toDate
stringoptional

Дата уплаты налогового платежа

objectoptional

Раздел для указания ссылок

self
stringrequired

Текущая ссылка

first
stringoptional

Первая ссылка

prev
stringoptional

Предыдущая ссылка

next
stringoptional

Следующая ссылка

last
stringoptional

Последняя ссылка

objectoptional

Раздел метаданных

totalPages
integeroptional

Количество передаваемых страниц

Пример ответа 200 (OK)
1{
2  "Data": {
3    "statementId": "9b23e27e-f4f8-4cab-9b80-aaa008d4330c",
4    "accountId": "95791e79-0f2d-47de-a5e0-df034b285XXx",
5    "fromBookingDateTime": "2025-12-02T11:40:21+00:00",
6    "toBookingDateTime": "2025-12-03T11:40:21+00:00",
7    "creationDateTime": "2021-10-05T15:15:13+00:00",
8    "Balance": [
9      {
10        "creditDebitIndicator": "Credit",
11        "type": "OpeningAvailable",
12        "Amount": {
13          "amount": "2000.00",
14          "currency": "RUB"
15        }
16      },
17      {
18        "creditDebitIndicator": "Credit",
19        "type": "ClosingAvailable",
20        "Amount": {
21          "amount": "700.00",
22          "currency": "RUB"
23        }
24      }
25    ],
26    "TransactionsSummary": {
27      "TotalCreditEntries": {
28        "numberOfEntries": "2",
29        "sum": "100.00",
30        "currency": "RUB"
31      },
32      "TotalDebitEntries": {
33        "sum": "1500.00",
34        "currency": "RUB"
35      }
36    },
37    "Entry": [
38      {
39        "transactionIdentification": "73791e79-0f2d-47de-a5e0-df034b285XXx",
40        "purpose": "1",
41        "creditDebitIndicator": "Debit",
42        "status": "AcceptedSettlementCompleted",
43        "bookingDateTime": "2023-12-15T00:00:00+00:00",
44        "valueDateTime": "2023-12-15T00:00:00+00:00",
45        "Amount": {
46          "amount": "200.00",
47          "currency": "RUB"
48        },
49        "TransactionAmount": {
50          "amount": "200.00",
51          "currency": "RUB"
52        },
53        "PaymentTypeInformation": {
54          "localInstrument": "01",
55          "categoryPurpose": "1",
56          "serviceLevel": "URGP"
57        },
58        "Debtor": {
59          "Agent": {
60            "name": "Наименование организации или физического лица",
61            "BankIdentification": [
62              {
63                "schemeName": "RU.CBR.BIC",
64                "identification": "9612123"
65              }
66            ],
67            "OrganizationIdentification": [
68              {
69                "schemeName": "RU.CBR.TXID",
70                "identification": "7728240240"
71              }
72            ],
73            "CorrespondentAccount": {
74              "schemeName": "RU.CBR.BBAN",
75              "identification": "40817810621234570000"
76            }
77          }
78        },
79        "DebtorAgent": {
80          "schemeName": "RU.CBR.BIC",
81          "identification": "9612123"
82        },
83        "DebtorAgentAccount": {
84          "schemeName": "RU.CBR.BBAN",
85          "identification": "40817810621234570000"
86        },
87        "DebtorAccount": {
88          "schemeName": "RU.CBR.BBAN",
89          "identification": "40817810621234570000"
90        },
91        "IntermediaryAgent": {
92          "schemeName": "RU.CBR.BIC",
93          "identification": "9612123"
94        },
95        "CreditorAgent": {
96          "schemeName": "RU.CBR.BIC",
97          "identification": "9612123"
98        },
99        "CreditorAccount": {
100          "schemeName": "RU.CBR.BBAN",
101          "identification": "40817810621234570000"
102        },
103        "CreditorAgentAccount": {
104          "schemeName": "RU.CBR.BBAN",
105          "identification": "40817810621234570000"
106        },
107        "Creditor": {
108          "Agent": {
109            "name": "Наименование организации или физического лица",
110            "BankIdentification": [
111              {
112                "schemeName": "RU.CBR.BIC",
113                "identification": "9612123"
114              }
115            ],
116            "OrganizationIdentification": [
117              {
118                "schemeName": "RU.CBR.TXID",
119                "identification": "7728240240"
120              }
121            ],
122            "CorrespondentAccount": {
123              "schemeName": "RU.CBR.BBAN",
124              "identification": "40817810621234570000"
125            }
126          }
127        },
128        "RemittanceInformation": {
129          "unstructured": "Назначение платежа - оплата за товары или услуги",
130          "ReferredDocumentInformation": [
131            {
132              "Number": "0",
133              "RelatedDate": "2021-06-05T15:15:13+00:00"
134            }
135          ],
136          "TaxRemittance": {
137            "administrationZone": "45388000",
138            "referenceNumber": "120",
139            "date": "2021-06-05T15:15:13+00:00",
140            "creditor": {
141              "taxType": "991230001"
142            },
143            "debtor": {
144              "taxType": "991230001"
145            },
146            "Record": {
147              "type": "1234",
148              "category": "TP",
149              "categoryDetails": "18210301000011000000",
150              "debtorStatus": "13"
151            }
152          }
153        }
154      }
155    ]
156  },
157  "Links": {
158    "self": "https://sb.example.ru/v1.3/example?page=1",
159    "first": "https://sb.example.ru/v1.3/example?page=1",
160    "prev": "https://sb.example.ru/v1.3/example?page=1",
161    "next": "https://sb.example.ru/v1.3/example?page=1",
162    "last": "https://sb.example.ru/v1.3/example?page=1"
163  },
164  "Meta": {
165    "totalPages": 1
166  }
167}
HEADERS
Атрибут
Описание
x-fapi-interaction-id
stringrequired

RFC4122 UID, используемый в качестве идентификатора корреляции

BODY
атрибут
описание
code
stringrequired

HTTP-код ошибки

id
stringoptional

Уникальный идентификатор ошибки

message
stringrequired

Краткое сообщение об ошибке

array of objectsrequired

Детализация ошибки

errorCode
stringrequired

Низкоуровневое описание ошибки

message
stringrequired

Описание ошибки

path
stringoptional

Путь к элементу с ошибкой в JSON-объекте

url
stringoptional

URL для помощи в устранении проблемы / предоставления дополнительной информации

Пример ошибки 400 (Bad Request)
1{
2  "code": "400",
3  "message": "Bad Request",
4  "Errors": [
5    {
6      "errorCode": "RU.CBR.Field.Missing",
7      "message": "The account statement is not ready yet, please try again later",
8      "path": "accountId"
9    }
10  ]
11}
Нет тела ответа
HEADERS
Атрибут
Описание
x-fapi-interaction-id
stringrequired

RFC4122 UID, используемый в качестве идентификатора корреляции

BODY
атрибут
описание
code
stringrequired

HTTP-код ошибки

id
stringoptional

Уникальный идентификатор ошибки

message
stringrequired

Краткое сообщение об ошибке

array of objectsrequired

Детализация ошибки

errorCode
stringrequired

Низкоуровневое описание ошибки

message
stringrequired

Описание ошибки

path
stringoptional

Путь к элементу с ошибкой в JSON-объекте

url
stringoptional

URL для помощи в устранении проблемы / предоставления дополнительной информации

Пример ошибки 403 (Forbidden)
1{
2  "code": "403",
3  "message": "Forbidden",
4  "Errors": [
5    {
6      "errorCode": "RU.CBR.Authenticate.InvalidConsent",
7      "message": "The user does not have rights to view the account statement {accountId}"
8    }
9  ]
10}
HEADERS
Атрибут
Описание
x-fapi-interaction-id
stringrequired

RFC4122 UID, используемый в качестве идентификатора корреляции

BODY
атрибут
описание
code
stringrequired

HTTP-код ошибки

message
stringrequired

Краткое сообщение об ошибке

array of objectsrequired

Детализация ошибки

errorCode
stringrequired

Низкоуровневое описание ошибки

message
stringrequired

Описание ошибки

path
stringoptional

Путь к элементу с ошибкой в JSON-объекте

url
stringoptional

URL для помощи в устранении проблемы / предоставления дополнительной информации

Пример ошибки 404 (Not Found)
1{
2  "code": "404",
3  "message": "Not found",
4  "Errors": [
5    {
6      "errorCode": "RU.CBR.Resource.NotFound",
7      "message": "Endpoint is not found or not active"
8    }
9  ]
10}
Нет тела ответа
HEADERS
Атрибут
Описание
x-fapi-interaction-id
stringrequired

RFC4122 UID, используемый в качестве идентификатора корреляции

BODY
атрибут
описание
code
stringrequired

HTTP-код ошибки

id
stringoptional

Уникальный идентификатор ошибки

message
stringrequired

Краткое сообщение об ошибке

array of objectsrequired

Детализация ошибки

errorCode
stringrequired

Низкоуровневое описание ошибки

message
stringrequired

Описание ошибки

path
stringoptional

Путь к элементу с ошибкой в JSON-объекте

url
stringoptional

URL для помощи в устранении проблемы / предоставления дополнительной информации

Пример ошибки 500 (Internal Server Error)
1{
2  "code": "500",
3  "message": "Internal Server Error",
4  "Errors": [
5    {
6      "errorCode": "RU.CBR.UnexpectedError",
7      "message": "Internal server error"
8    }
9  ]
10}

Отправьте письмо на alfa_api@alfabank.ru, указав следующие данные:

  1. 1.
    client_id.
  2. 2.
    Дата и время запроса с указанием часового пояса.
  3. 3.
    Метод и URI запроса.
  4. 4.
    Заголовки и тело запроса.
  5. 5.
    Полученная ошибка и заголовки ответа, включая X-TraceId.
  6. 6.
    IP-адрес, с которого был отправлен запрос.