B2C

Выполнение действия по карте

Пром POST https://baas.alfabank.ru/api/pp/v1/cards/{cardId}/actions

Песочница POST https://sandbox.alfabank.ru/api/pp/v1/cards/{cardId}/actions

Scope

card-sec-actions

Описание

С помощью данного метода, пользователь выполняет определённое действие с картой (на данный момент доступна только блокировка карты, но список возможных действий будет расширяться).

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

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

application/json

Authorization
stringrequired

Bearer {access_token}, полученный по Authorization Code Flow

Content-Type
stringrequired

application/json

PATH
Атрибут
Описание
cardId
stringrequired

Идентификатор карты. Для того, чтобы получить cardId используйте метод Получение списка карт клиента

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

Тип действия с картой. Принимает возможные значения: CARD_BLOCK - заблокировать карту

Пример запроса
curl -X POST https://baas.alfabank.ru/api/pp/v1/cards/{cardId}/actions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -H 'Content-Type: application/json'
  -d '
  {
    "actionId": "CARD_BLOCK"
  }
  '

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

Пример ответа 200 (ОК)
{
  "reference": "H390506200000003",
  "auth": "SMSPWD",
  "passwordLength": 4
}
reference
stringrequired

Идентификатор действия по карте

auth
stringrequired

Способ подтверждения действия. Принимает возможные значения: SMSPWD - одноразовый sms-пароль; AM - уведомление в приложении

passwordLength
integerrequired

Длина пароля для подтверждения действия

Пример ответа 200 (ОК)
{
  "reference": "H390506200000003",
  "auth": "SMSPWD",
  "passwordLength": 4
}
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; access_denied - доступ к счету запрещен

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"
}
Нет тела ответа
error
stringrequired

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

error_description
stringoptional

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

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

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