B2C

Выполнение перевода по номеру телефона от ЮЛ к ФЛ

Пром POST https://baas.alfabank.ru/api/b2cpay/jp/v1/payments

Песочница POST https://sandbox.alfabank.ru/api/b2cpay/jp/v1/payments

Scope

b2c_sbp_payments

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

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

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

Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

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

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

b2cClientId
stringoptional

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

partnerId
number(integer)required

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

inn
stringrequired

ИНН клиента

account
stringrequired

Номер счета отправителя

total
number(float)required

Общая сумма платежей в пакете

nameCheck
booleanoptional

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

array of objectrequired

Получатели платежей. Могут быть разные внутри пакета

objectoptional

ФИО получателя

first
stringoptional

Имя

middle
stringoptional

Отчество

last
stringoptional

Фамилия

amount
number(float)required

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

nspkBankId
stringrequired

ID банка получателя

phone
stringrequired

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

sequence
stringrequired

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

paymentDescription
stringrequired

Описание платежа

ric
number(integer)required

Код вида дохода

signedBody
stringrequired

ЭЦП для верификации платежа

Пример запроса
curl -X POST https://baas.alfabank.ru/api/b2cpay/jp/v1/payments \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'\
  -H 'Content-Type: application/json'
{
  "client": {
    "b2cClientId": "1b00587d-09a1-4928-af4f-1ce5eb769724",
    "partnerId": 100
  },
  "inn": "773509414997",
  "account": "40802810802790005307",
  "total": 100.53,
  "nameCheck":"true",  
  "payments": [
    {
      "amount": 100.53,
      "nspkBankId": "100000000025",
      "phone": "0079612894744",
      "sequence": "payment1020",
      "paymentDescription": "Платеж по договору ХХХ",
      "ric": 1,	  
	  "name": {
		"first": "Василий",
		"middle": "Семенович",
		"last": "Иванов"
	  }	  
    }
  ]
}

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

Пример ответа 200 (ОК)
{
  "client": {
    "b2cClientId": "1b00587d-09a1-4928-af4f-1ce5eb769724",
    "partnerId": 100
  },
  "payPackage": "1562",
  "payments": [
    {
      "amount": 100.53,
      "feeAmount": 15.03,
      "transactionId": "649",
      "phone": "0079612894744",
      "sequence": "payment1020",
      "createDate": "2023-04-24T14:15:22Z",
      "paymentDescription": "Платеж по договору ХХХ",
	  "nameCheck": true,
      "name": {
		"first": "Иван",
		"middle": "Иванович",
		"last": "Иванов",
	  }		  
    }
  ]
}
objectrequired

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

b2cClientId
stringoptional

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

partnerId
number(integer)required

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

payPackage
number(integer)required

Уникальный идентификатор пакета платежей

array of objectrequired

Получатели платежей. Могут быть разные внутри пакета

amount
number(float)required

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

feeAmount
number(float)required

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

transactionId
stringrequired

Уникальный идентификатор транзакции, формируемый сервисом B2C-переводы

phone
stringrequired

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

sequence
stringrequired

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

createDate
stingrequired

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

paymentDescription
stringrequired

Описание платежа

objectoptional

ФИО получателя

first
stringoptional

Имя

middle
stringoptional

Отчество

last
stringoptional

Фамилия

nameCheck
booleanoptional

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

Пример ответа 200 (ОК)
{
  "client": {
    "b2cClientId": "1b00587d-09a1-4928-af4f-1ce5eb769724",
    "partnerId": 100
  },
  "payPackage": "1562",
  "payments": [
    {
      "amount": 100.53,
      "feeAmount": 15.03,
      "transactionId": "649",
      "phone": "0079612894744",
      "sequence": "payment1020",
      "createDate": "2023-04-24T14:15:22Z",
      "paymentDescription": "Платеж по договору ХХХ",
	  "nameCheck": true,
      "name": {
		"first": "Иван",
		"middle": "Иванович",
		"last": "Иванов",
	  }		  
    }
  ]
}
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"
}

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