B2C

Проверка возможности совершения платежа по реквизитам получателя через СБП

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

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

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

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

nameCheck
booleanoptional

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

array of objectrequired

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

amount
number(float)required

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

nspkBankId
stringrequired

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

phone
stringrequired

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

objectoptional

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

first
stringoptional

Имя

middle
stringoptional

Отчество

last
stringoptional

Фамилия

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

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

Пример ответа 200 (ОК)
{
  "checkPaymentId": "543",
  "client": {
    "b2cClientId": "1b00587d-09a1-4928-af4f-1ce5eb769724",
    "partnerId": 100
  }
}
checkId
number(integer)required

Уникальный идентификатор запроса на проверку, по которому в дальнейшем возможно получение статуса проверки

objectrequired

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

b2cClientId
stringoptional

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

partnerId
number(integer)required

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

Пример ответа 200 (ОК)
{
  "checkPaymentId": "543",
  "client": {
    "b2cClientId": "1b00587d-09a1-4928-af4f-1ce5eb769724",
    "partnerId": 100
  }
}
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"
}

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