B2C

Получение списка доступных действий по карте

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

card-sec-actions

Описание

В результате данного запроса пользователь получит перечень доступных действий по определённой карте. На данный момент доступно 3 действия: блокировка, разблокировка и смена пин-кода.

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

PATH
Атрибут
Описание
cardId
stringrequired
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/pp/v1/cards/{cardId}/actions' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "actions": [
3    {
4      "actionId": "CARD_BLOCK",
5      "title": "Блокировка карты",
6      "available": true
7    },
8    {
9      "actionId": "CARD_UNBLOCK",
10      "title": "Разблокировка карты",
11      "available": true
12    }
13  ]
14}
BODY
атрибут
описание
array of objectsrequired

Список действий по карте

actionId
stringrequired

Тип действий с картой. Принимает возможные значения:

  • •
    CARD_BLOCK - заблокировать карту;
  • •
    CARD_UNBLOCK - разблокировать карту;
  • •
    CARD_PIN_CHANGE - изменить код
title
stringoptional

Название

available
booleanoptional

Флаг доступности действия клиенту

Пример ответа 200 (OK)
1{
2  "actions": [
3    {
4      "actionId": "CARD_BLOCK",
5      "title": "Блокировка карты",
6      "available": true
7    },
8    {
9      "actionId": "CARD_UNBLOCK",
10      "title": "Разблокировка карты",
11      "available": true
12    }
13  ]
14}
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}
Нет тела ответа