B2BH2H

Получение списка счетов по стандартам Банка России

Песочница
GET https://sandbox.alfabank.ru/api/jp/open-banking/v1.3/accounts
Пром
GET https://baas.alfabank.ru/api/jp/open-banking/v1.3/accounts
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), которое использует пользователь

Пример запроса
Язык 
1curl --location 'https://baas.alfabank.ru/api/jp/open-banking/v1.3/accounts' \
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    "Account": [
4      {
5        "accountId": "this-is-a-slug-format-account-id",
6        "status": "Enabled",
7        "currency": "RUB",
8        "accountType": "Business",
9        "accountDescription": "Розничные операции",
10        "AccountDetails": [
11          {
12            "schemeName": "RU.CBR.BBAN",
13            "identification": "40817810621234570000"
14          }
15        ],
16        "Owner": {
17          "name": "Наименование организации или физического лица",
18          "Identification": [
19            {
20              "schemeName": "RU.CBR.TXID",
21              "identification": "7728240240"
22            }
23          ]
24        },
25        "Servicer": {
26          "name": "Наименование организации или физического лица",
27          "BankIdentification": [
28            {
29              "schemeName": "RU.CBR.BBAN",
30              "identification": "9612123"
31            }
32          ],
33          "OrganizationIdentification": [
34            {
35              "schemeName": "RU.CBR.BBAN",
36              "identification": "7728240240"
37            }
38          ],
39          "CorrespondentAccount": {
40            "schemeName": "RU.CBR.BBAN",
41            "identification": "40817810621234570000"
42          }
43        }
44      }
45    ]
46  },
47  "Links": {
48    "self": "https://sb.example.ru/v1.3/example"
49  },
50  "Meta": {
51    "totalPages": 1
52  }
53}
HEADERS
Атрибут
Описание
x-fapi-interaction-id
stringrequired

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

x-jws-signature
stringrequired

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

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

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

array of objectsoptional

Счёт

accountId
stringrequired

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

status
stringrequired

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

  • •
    Enabled - счёт доступен и может использоваться;
  • •
    Disabled - счёт недоступен и не может использоваться, временно или навсегда
currency
stringrequired

Валюта ведения счёта

accountType
stringrequired

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

  • •
    Business - счёт юридического лица
accountDescription
stringrequired

Краткое описание назначения счёта или продукта, привязанного к счёту

array of objectsoptional

Идентификация счёта

schemeName
stringrequired

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

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

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

objectoptional

Информация о владельце счёта

name
stringrequired

Наименование организации или имя физического лица

array of objectsrequired

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

schemeName
stringrequired

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

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

ИНН

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 - базовый номер банковского счёта
identification
stringrequired

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

objectoptional

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

self
stringrequired

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

objectoptional

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

totalPages
integeroptional

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

Пример ответа 200 (OK) 
1{
2  "Data": {
3    "Account": [
4      {
5        "accountId": "this-is-a-slug-format-account-id",
6        "status": "Enabled",
7        "currency": "RUB",
8        "accountType": "Business",
9        "accountDescription": "Розничные операции",
10        "AccountDetails": [
11          {
12            "schemeName": "RU.CBR.BBAN",
13            "identification": "40817810621234570000"
14          }
15        ],
16        "Owner": {
17          "name": "Наименование организации или физического лица",
18          "Identification": [
19            {
20              "schemeName": "RU.CBR.TXID",
21              "identification": "7728240240"
22            }
23          ]
24        },
25        "Servicer": {
26          "name": "Наименование организации или физического лица",
27          "BankIdentification": [
28            {
29              "schemeName": "RU.CBR.BBAN",
30              "identification": "9612123"
31            }
32          ],
33          "OrganizationIdentification": [
34            {
35              "schemeName": "RU.CBR.BBAN",
36              "identification": "7728240240"
37            }
38          ],
39          "CorrespondentAccount": {
40            "schemeName": "RU.CBR.BBAN",
41            "identification": "40817810621234570000"
42          }
43        }
44      }
45    ]
46  },
47  "Links": {
48    "self": "https://sb.example.ru/v1.3/example"
49  },
50  "Meta": {
51    "totalPages": 1
52  }
53}
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  "id": "4aca5b0d-1730-416f-a52b-6d353b687082",
4  "message": "Invalid token",
5  "Errors": [
6    {
7      "errorCode": "RU.CBR.Field.Missing",
8      "message": "This service is only available for legal entities",
9      "path": "Data.Model.Object.filled",
10      "url": "https://example.com/error-description"
11    }
12  ]
13}
Нет тела ответа
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  "id": "ab41a751-619b-4947-bf0a-251f6e92f599",
4  "message": "Forbidden",
5  "Errors": [
6    {
7      "errorCode": "RU.CBR.Authenticate.InvalidScope",
8      "message": "The request requires higher privileges than provided by the access token",
9      "url": "https://example.com/error-description"
10    }
11  ]
12}
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  "id": "af467d1b-985d-4a8e-972e-24a32287085f",
4  "message": "Internal Server Error",
5  "Errors": [
6    {
7      "errorCode": "RU.CBR.UnexpectedError",
8      "message": "Internal Server Error",
9      "path": "Data.Model.Object.filled",
10      "url": "https://example.com/error-description"
11    }
12  ]
13}

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

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