B2C

Формирование отчетности по платежам по пакету

Пром GET https://baas.alfabank.ru/api/b2cpay/jp/v1/payments/packages/{packageId}

Песочница GET https://sandbox.alfabank.ru/api/b2cpay/jp/v1/payments/packages/{packageId}

Scope

b2c_sbp_payments

Описание

Пакет формируется на стороне сервиса в момент выполнения метода Выполнение перевода физическому лицу по номеру телефона.

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

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

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

Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

PATH
Атрибут
Описание
packageId
number(integer)required

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

Пример запроса
curl -X GET https://baas.alfabank.ru/api/b2cpay/jp/v1/payments?packageId=3263\
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'\
  -H 'Content-Type: application/json'

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

Пример ответа 200 (ОК)
{
  "client": {
    "b2cClientId": "1b00587d-09a1-4928-af4f-1ce5eb769724",
    "partnerId": 100
  },
  "account": "40802810802790005307",
  "inn": "773509414997", 
  "payments": [
    {
      "transactionId": "235424",
      "sequence": "payment1020",
      "payPackage": "634",
      "nspkTransactionId": "B309612415221505000019415C2D38B2",
      "nspkBankName": "Альфа Банк",
      "nspkName": {
		"first": "Иван",
		"middle": "Иванович",
		"last": "Иванов",
		},
	"nameCheck": true,
      "name": {
		"first": "Иван",
		"middle": "Иванович",
		"last": "Иванов",
		},	
      "eqTrnId": "C310604230001899",
      "phone": "0079612894744",
      "amount": 100.53,
      "feeAccount": "40802810802790005306",
      "feeAmount": 15.35,
      "createDate": "2022-08-24T14:15:22Z",
      "modifyDate": "2022-08-24T14:15:22Z",
      "nspkStatus": "ACWP",
      "errorDescription": ""
    }
  ]
}
objectrequired

Контекст клиента

b2cClientId
stringoptional

Идентификатор клиента, от имени которого интегратором отправляется платеж (при использовании API технологическим партнером)

partnerId
number(integer)required

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

array of objectrequired

Коллекция транзакций на основании параметров запроса. Может содержать транзакции для различных получателей

account
stringrequired

Счет списания отправителя

inn
stringrequired

ИНН отправителя

transactionId
stringrequired

Уникальный идентификатор транзакции

sequence
stringrequired

Идентификатор платежа внутри пакета. Формируется потребителем сервиса B2C-переводы

payPackage
stringrequired

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

nspkTransactionId
stringoptional

Код транзакции НСПК

nspkBankName
stringrequired

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

objectoptional

ФИО получателя в НСПК

first
stringoptional

Имя

middle
stringoptional

Отчество

last
stringoptional

Фамилия

objectoptional

ФИО получателя из запроса платежа

first
stringoptional

Имя

middle
stringoptional

Отчество

last
stringoptional

Фамилия

nameCheck
booleanoptional

Переданный в запросе флаг необходимости проверки совпадения переданного ФИО получателя и зарегестрированного ФИО получателя в НСПК

eqTrnId
stringoptional

Идентификатор платежа в банке-отправителе (АБС Альфа-банка)

phone
stringrequired

Телефон получателя

amount
number(float)required

Сумма платежа

feeAccount
stringoptional

Счет списания комиссии платежа. Может отличаться от основного счета списания ДС

feeAmount
number(float)required

Сумма комиссии платежа

createDate
stingrequired

Дата/Время создания платежа (в формате 2023-03-28T19:47:21.644Z)

modifyDate
stingrequired

Дата/Время изменения платежа (в формате 2023-03-28T19:47:21.644Z)

nspkStatus
stringrequired

Статус платежа в НСПК

errorDescription
stringoptional

Описание ошибки платежа. Возвращается в случае ошибки платежа в НСПК (поле nspkStatus имеет значение RJCT)

Пример ответа 200 (ОК)
{
  "client": {
    "b2cClientId": "1b00587d-09a1-4928-af4f-1ce5eb769724",
    "partnerId": 100
  },
  "account": "40802810802790005307",
  "inn": "773509414997", 
  "payments": [
    {
      "transactionId": "235424",
      "sequence": "payment1020",
      "payPackage": "634",
      "nspkTransactionId": "B309612415221505000019415C2D38B2",
      "nspkBankName": "Альфа Банк",
      "nspkName": {
		"first": "Иван",
		"middle": "Иванович",
		"last": "Иванов",
		},
	"nameCheck": true,
      "name": {
		"first": "Иван",
		"middle": "Иванович",
		"last": "Иванов",
		},	
      "eqTrnId": "C310604230001899",
      "phone": "0079612894744",
      "amount": 100.53,
      "feeAccount": "40802810802790005306",
      "feeAmount": 15.35,
      "createDate": "2022-08-24T14:15:22Z",
      "modifyDate": "2022-08-24T14:15:22Z",
      "nspkStatus": "ACWP",
      "errorDescription": ""
    }
  ]
}
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_route - Эндпоинт не найден или неактивен

error_description
stringoptional

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

Пример ошибки 404 (Not Found)
{
  "error": "unknown_route",
  "error_description": "Route is not found or not active"
}
error
stringrequired

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

error_description
stringoptional

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

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}

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