B2C

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

Пром GET https://baas.alfabank.ru/api/b2cpay/jp/v1/clients/checks/{checkId}

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

Scope

b2c_sbp_payments

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

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

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

Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

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

Идентификатор запроса на проверку возможности платежа

QUERY
Атрибут
Описание
b2cClientId
stringoptional

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

partnerId
number(integer)required

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

Пример запроса
curl -X GET https://baas.alfabank.ru/api/b2cpay/jp/v1/clients/checks/543?b2cClientId=6abd7050-6aea-4fb1-90cd-0e1d8fecb1e4&partnerId=214 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'\
  -H 'Content-Type: application/json'

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

Пример ответа 200 (ОК)
{
  "client": {
    "b2cClientId": "1b00587d-09a1-4928-af4f-1ce5eb769724",
    "partnerId": 100
  },
  "payments": [
    {
      "amount": 100.53,
	  "nspkBankId": "100000000025",
	  "nspkName": {
		"first": "Василий",
		"middle": "Семенович",
		"last": "Иванов"
	  },
	  "name": {
		"first": "Василий",
		"middle": "Семенович",
		"last": "Иванов"
	  },
	  "nameCheck": true,
      "phone": "0079612894744",
      "status": "ACWP"
    }
  ]
}
objectrequired

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

b2cClientId
stringoptional

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

partnerId
number(integer)required

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

array of objectrequired

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

amount
number(float)required

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

nspkBankId
stringrequired

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

objectoptional

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

first
stringoptional

Имя

middle
stringoptional

Отчество

last
stringoptional

Фамилия

objectoptional

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

first
stringoptional

Имя

middle
stringoptional

Отчество

last
stringoptional

Фамилия

nameCheck
booleanoptional

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

phone
stringrequired

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

status
stringrequired

Результат проверки возможности отправки платежа по реквизитам

Пример ответа 200 (ОК)
{
  "client": {
    "b2cClientId": "1b00587d-09a1-4928-af4f-1ce5eb769724",
    "partnerId": 100
  },
  "payments": [
    {
      "amount": 100.53,
	  "nspkBankId": "100000000025",
	  "nspkName": {
		"first": "Василий",
		"middle": "Семенович",
		"last": "Иванов"
	  },
	  "name": {
		"first": "Василий",
		"middle": "Семенович",
		"last": "Иванов"
	  },
	  "nameCheck": true,
      "phone": "0079612894744",
      "status": "ACWP"
    }
  ]
}
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"
}

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