Песочница
POST https://sandbox.alfabank.ru/api/pp/v1/cards/{cardId}/actions
Пром
POST https://baas.alfabank.ru/api/pp/v1/cards/{cardId}/actions
Scope
card-sec-actions
Описание
Метод позволяет заблокировать, разблокировать карту и изменить её PIN-код.
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Bearer {access_token}, полученный по Authorization Code Flow
Accept
stringrequired
application/json
Content-Type
stringrequired
application/json
PATH
Атрибут
Описание
cardId
stringrequired
Идентификатор пластиковой карты. Для того чтобы получить cardId, используйте метод «Получение списка карт клиента»
BODY
Атрибут
Описание
actionId
stringrequired
Тип действий с картой. Возможные значения:
-
•
CARD_BLOCK- заблокировать карту; -
•
CARD_UNBLOCK- разблокировать карту; -
•
CARD_PIN_CHANGE- изменить ПИН-код
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/pp/v1/cards/{cardId}/actions' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6 "actionId": "CARD_BLOCK"
7}'Параметры ответа
Пример ответа 200 (OK)
1{
2 "reference": "H390506200000003",
3 "auth": "SMSPWD",
4 "passwordLength": 4
5}
BODY
атрибут
описание
reference
stringrequired
Идентификатор действия по карте
auth
stringrequired
Способ подтверждения действия. Принимает возможные значения:
-
•
SMSPWD- одноразовый sms-пароль; -
•
AM- уведомление в приложении
passwordLength
integerrequired
Длина пароля для подтверждения действия
Пример ответа 200 (OK)
1{
2 "reference": "H390506200000003",
3 "auth": "SMSPWD",
4 "passwordLength": 4
5}
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
invalid_request- неверные входные параметры запроса
error_description
stringoptional
Описание ошибки
Пример ошибки 400 (Bad Request)
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers"
4}
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. Необходимо получить новый токен доступа
error_description
stringoptional
Описание ошибки
Пример ошибки 401 (Unauthorized)
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
insufficient_scope- при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметраprompt=consent; -
•
access_denied- доступ к счёту запрещён
error_description
stringoptional
Описание ошибки
Пример ошибки 403 (Forbidden)
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
unknown_endpoint- эндпоинт не найден или неактивен
error_description
stringoptional
Описание ошибки
Пример ошибки 404 (Not Found)
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}
Нет тела ответа
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional
Описание ошибки
Пример ошибки 500 (Internal Server Error)
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}
Нет тела ответа