СКОРО В РЕЛИЗЕB2BH2H

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

Пром GET https://baas.alfabank.ru/api/sbp/jp/v1/outgoing-payments

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

Scope

b2b-sbp

Параметры запроса

HEADER
Атрибут
Описание
Authorization
stringrequired

Bearer {access_token}, полученный по Client Credentials Flow

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

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

Идентификатор клиента, от имени которого выполняется запрос

outgoingPaymentId
stringoptional

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

qrcId
stringoptional

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

sort
array of stringoptional

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

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

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

offset
integeroptional

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

Пример запроса
curl -X GET https://baas.alfabank.ru/api/sbp/jp/v1/outgoing-payments?b2bClientId=021be5ed-6312-4982-a4e9-2a2cc44bc88c&sort=status,asc&sort=timestamp,desc&limit=10&offset=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Параметры ответа

Пример ответа 200 (ОК)
{
  "pagination": {
    "limit": 10, 
    "offset": 0,
    "totalCount": 1
  },
  "payments": [
    {
      "outgoingPaymentId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
      "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
      "status": "COMPLETE",
      "amount": 1000000,
      "taxAmount": 200000,
      "currency": "RUR",
      "payerAccount": "40702810901400001130",
      "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
      "timestamp": "2022-05-26T09:09:32Z",
      "recipientInfo": {
        "name": "OOO Ромашка",
        "inn": "3664069397",
        "bik": "044525593"
      }
    }
  ]
}
objectoptional

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

limit
integeroptional

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

offset
integeroptional

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

totalCount
integeroptional

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

array of objectrequired

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

outgoingPaymentId
stringrequired

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

qrcId
stringrequired

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

status
stringrequired

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

  • COMPLETE - Платеж выполнен;
  • ERROR - Платеж отклонен
amount
integerrequired

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

taxAmount
integerrequired

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

currency
stringrequired

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

payerAccount
stringrequired

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

paymentPurpose
stringrequired

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

timestamp
stringrequired

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

objectrequired

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

name
stringrequired

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

inn
stringrequired

ИНН получателя

bik
stringrequired

БИК банка получателя

Пример ответа 200 (ОК)
{
  "pagination": {
    "limit": 10, 
    "offset": 0,
    "totalCount": 1
  },
  "payments": [
    {
      "outgoingPaymentId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
      "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
      "status": "COMPLETE",
      "amount": 1000000,
      "taxAmount": 200000,
      "currency": "RUR",
      "payerAccount": "40702810901400001130",
      "paymentPurpose": "Оплата по договору №123456789 от 01.09.2001",
      "timestamp": "2022-05-26T09:09:32Z",
      "recipientInfo": {
        "name": "OOO Ромашка",
        "inn": "3664069397",
        "bik": "044525593"
      }
    }
  ]
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса

error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

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

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope

error_description
stringoptional

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

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
error
stringrequired

Код ошибки. Принимает возможные значения: unknown_endpoint - Эндпоинт не найден или неактивен

error_description
stringoptional

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

Пример ошибки 404 (Not Found)
{
  "error": "unknown_endpoint",
  "error_description": "Endpoint is not found or not active"
}
Пример ответа 429 (Too Many Requests)
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

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

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}
Пример ответа 503 (Service Unavailable)
Нет тела ответа

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.