B2BH2H

Получение входящих платежей

Песочница
GET https://sandbox.alfabank.ru/api/sbp/jp/v1/incoming-payments
Пром
GET https://baas.alfabank.ru/api/sbp/jp/v1/incoming-payments
Scope

b2b-sbp

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

application/json

QUERY
Атрибут
Описание
b2bClientId
stringrequired

Идентификатор клиента, от имени которого выполняется запрос. Банк сообщает партнёру API при подключении

qrcId
stringoptional

Идентификатор платёжной ссылки

sort
arrayoptional

Сортировка результатов поиска (не более трёх параметров). Возможные значения:

  • •
    qrcId - идентификатор платёжной ссылки;
  • •
    amount - сумма к зачислению в копейках;
  • •
    taxAmount - сумма налога Операции СБП в копейках;
  • •
    paymentPurpose - назначение платежа;
  • •
    payeeAccount - счёт зачисления платежа;
  • •
    payerAccount - счёт списания платежа;
  • •
    timestamp - дата и время выполнения Операции СБП
limit
integeroptional

Количество элементов. Максимальное значение - 1000

offset
integeroptional

Смещение в результатах поиска

Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/sbp/jp/v1/incoming-payments?b2bClientId={b2bClientId}&qrcId={qrcId}&sort={sort}&limit={limit}&offset={offset}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "pagination": {
3    "limit": 10,
4    "offset": 0,
5    "totalCount": 1
6  },
7  "payments": [
8    {
9      "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
10      "nspkTransactionId": "B467FC50C59A469A9898AB7B05EE3F07",
11      "amount": 1000000,
12      "taxAmount": 200000,
13      "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
14      "payeeAccount": "40702810100010000001",
15      "payerAccount": "40702810901400001289",
16      "currency": "RUR",
17      "timestamp": "2022-05-26T09:09:32Z",
18      "payerInfo": {
19        "name": "OOO Ромашка",
20        "inn": "911006876365",
21        "bik": "044525593",
22        "accountType": "BBAN",
23        "bankName": "АО \"АЛЬФА-БАНК\"",
24        "bankCorrAccount": "30101810200000000593"
25      },
26      "recipientInfo": {
27        "name": "OOO Ромашка",
28        "inn": "911006876365",
29        "bik": "044525593",
30        "bankName": "АО \"АЛЬФА-БАНК\"",
31        "bankCorrAccount": "30101810200000000593"
32      }
33    }
34  ]
35}
BODY
атрибут
описание
objectoptional

Параметры пагинации

limit
integeroptional

Количество элементов

offset
integeroptional

Смещение в результатах поиска

totalCount
integeroptional

Количество элементов, удовлетворяющих запросу

array of objectsrequired

Информация о входящем платеже

qrcId
stringrequired

Идентификатор платёжной ссылки

nspkTransactionId
stringoptional

Идентификатор операции НСПК

amount
integerrequired

Сумма к зачислению в копейках

taxAmount
integeroptional

Сумма налога Операции СБП в копейках

paymentPurpose
stringrequired

Назначение платежа

payeeAccount
stringoptional

Счёт зачисления платежа

payerAccount
stringoptional

Счёт списания

currency
stringoptional

Код валюты платежа

timestamp
stringrequired

Дата и время выполнения Операции СБП в формате ISO 8601

paymentNumber
stringoptional

Номер платёжного поручения

objectrequired

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

name
stringrequired

Наименование ЮЛ плательщика/получателя

inn
stringrequired

ИНН плательщика/получателя

bik
stringrequired

БИК банка плательщика/получателя

accountType
stringoptional

Тип идентификатора номера счёта плательщика

bankName
stringrequired

Наименование банка плательщика/получателя

bankCorrAccount
stringrequired

Корреспондентский счёт банка плательщика/получателя

objectrequired

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

name
stringrequired

Наименование ЮЛ плательщика/получателя

inn
stringrequired

ИНН плательщика/получателя

bik
stringrequired

БИК банка плательщика/получателя

accountType
stringoptional

Тип идентификатора номера счёта плательщика

bankName
stringrequired

Наименование банка плательщика/получателя

bankCorrAccount
stringrequired

Корреспондентский счёт банка плательщика/получателя

Пример ответа 200 (OK) 
1{
2  "pagination": {
3    "limit": 10,
4    "offset": 0,
5    "totalCount": 1
6  },
7  "payments": [
8    {
9      "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
10      "nspkTransactionId": "B467FC50C59A469A9898AB7B05EE3F07",
11      "amount": 1000000,
12      "taxAmount": 200000,
13      "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
14      "payeeAccount": "40702810100010000001",
15      "payerAccount": "40702810901400001289",
16      "currency": "RUR",
17      "timestamp": "2022-05-26T09:09:32Z",
18      "payerInfo": {
19        "name": "OOO Ромашка",
20        "inn": "911006876365",
21        "bik": "044525593",
22        "accountType": "BBAN",
23        "bankName": "АО \"АЛЬФА-БАНК\"",
24        "bankCorrAccount": "30101810200000000593"
25      },
26      "recipientInfo": {
27        "name": "OOO Ромашка",
28        "inn": "911006876365",
29        "bik": "044525593",
30        "bankName": "АО \"АЛЬФА-БАНК\"",
31        "bankCorrAccount": "30101810200000000593"
32      }
33    }
34  ]
35}
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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. Необходимо получить новый токен доступа
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
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}
Нет тела ответа
Получение данных по зарегистрированной платёжной ссылкеВыполнение исходящего платежа в СБП за один шаг