B2BH2H

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

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

b2b-sbp

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

application/json

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

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

outgoingPaymentId
stringoptional

Идентификатор исходящего платежа

qrcId
stringoptional

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

sort
arrayoptional

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

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

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

offset
integeroptional

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

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/sbp/jp/v1/outgoing-payments?b2bClientId={b2bClientId}&outgoingPaymentId={outgoingPaymentId}&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      "outgoingPaymentId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
10      "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
11      "nspkTransactionId": "B467FC50C59A469A9898AB7B05EE3F07",
12      "status": "COMPLETE",
13      "amount": 1000000,
14      "taxAmount": 200000,
15      "currency": "RUR",
16      "payerAccount": "40702810100010000001",
17      "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
18      "timestamp": "2022-05-26T09:09:32Z",
19      "commission": 100,
20      "payerInfo": {
21        "name": "OOO Ромашка",
22        "inn": "911006876365",
23        "bik": "044525593",
24        "accountType": "BBAN",
25        "bankName": "АО \"АЛЬФА-БАНК\"",
26        "bankCorrAccount": "30101810200000000593"
27      },
28      "recipientInfo": {
29        "name": "OOO Ромашка",
30        "inn": "911006876365",
31        "bik": "044525593",
32        "bankName": "АО \"АЛЬФА-БАНК\"",
33        "bankCorrAccount": "30101810200000000593"
34      }
35    }
36  ]
37}
BODY
атрибут
описание
objectoptional

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

limit
integeroptional

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

offset
integeroptional

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

totalCount
integeroptional

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

array of objectsrequired

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

outgoingPaymentId
stringrequired

Идентификатор платежа в СБП B2B

qrcId
stringrequired

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

nspkTransactionId
stringoptional

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

status
stringrequired

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

  • •
    SENDING_MESSAGE - платёж в обработке;
  • •
    COMPLETE - платёж выполнен
amount
integerrequired

Сумма перевода в копейках

taxAmount
integerrequired

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

currency
stringrequired

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

payerAccount
stringrequired

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

paymentPurpose
stringrequired

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

timestamp
stringoptional

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

commission
integeroptional

Сумма комиссии в копейках

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      "outgoingPaymentId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
10      "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
11      "nspkTransactionId": "B467FC50C59A469A9898AB7B05EE3F07",
12      "status": "COMPLETE",
13      "amount": 1000000,
14      "taxAmount": 200000,
15      "currency": "RUR",
16      "payerAccount": "40702810100010000001",
17      "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
18      "timestamp": "2022-05-26T09:09:32Z",
19      "commission": 100,
20      "payerInfo": {
21        "name": "OOO Ромашка",
22        "inn": "911006876365",
23        "bik": "044525593",
24        "accountType": "BBAN",
25        "bankName": "АО \"АЛЬФА-БАНК\"",
26        "bankCorrAccount": "30101810200000000593"
27      },
28      "recipientInfo": {
29        "name": "OOO Ромашка",
30        "inn": "911006876365",
31        "bik": "044525593",
32        "bankName": "АО \"АЛЬФА-БАНК\"",
33        "bankCorrAccount": "30101810200000000593"
34      }
35    }
36  ]
37}
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}
Нет тела ответа