Получение информации по бизнес-картам

Обновлено 20 февраля 2025

POST

/v2/corporate-cards/list

Запрос позволяет получить информацию по всем бизнес-картам пользователя, чей access_token используется для запроса. Отправьте запрос с токеном доступа (access_token) пользователя в параметре Authorization заголовка и информацией о количестве карт, которое нужно вывести, в теле запроса.

В параметре scope ссылки авторизации пользователя должен быть указан сервис CORPORATE_CARDS для получения доступа к этому запросу.

Запрос

• application/json

Body

required

pagination objectrequired

Объект запроса при для получении постраничного списка моделей

offset

int32

required

Сдвиг элементов

count

int32

required

Возможные значения: >= 1 и <= 10000

Количество записей на странице

Ответы

• 200
• 400
• 403
• 500

Успешный ответ

• application/json

• Схема
• Пример из схемы

Schema

cards object[]
Possible values: <= 10000
Массив данных по картам
Array [
businessCardId
string
Возможные значения: <= 36 characters
Идентификатор бизнес-карты отправителя
cardStatus
string
Возможные значения: <= 255 characters
Статус в формате WAY4
accountNumber
string
Возможные значения: <= 20 characters, Value must match regular expression [0-9]{20}
Номер счета (20-зн.)
maskedCardNumber
string
required
Возможные значения: <= 255 characters
Замаскированный номер карты
embossedName
string
Возможные значения: <= 255 characters
Эмбоссируемое имя клиента на карте
holderName
string
Возможные значения: <= 255 characters
ФИО держателя карты
userIsHolder
boolean
Признак держателя карты
cardOpenDate
string
required
Возможные значения: <= 255 characters
Дата выпуска карты
cardExpiryDate
string
required
Возможные значения: Value must match regular expression ^[0-9]{4}$
Дата истечения срока действия карты в формате ММГГ
limits object[]
Массив лимитов по карте
Array [
name
string
required
Возможные значения: <= 100 characters
Наименование лимита
period
string
required
Возможные значения: <= 100 characters, [DAY, MONTH, UNLIMITED, CLIENTPERIOD]
Период обновления расходного лимита
value
string
required
Возможные значения: <= 100 characters
Сумма установленного лимита
restVolume
string
required
Возможные значения: <= 100 characters
Доступный расходный лимит
]
]
pagination objectrequired

Объект ответа при для получении постраничного списка моделей

hasNextPage

boolean

required

Признак наличия следующей страницы

offset

int32

required

Сдвиг элементов

count

int32

required

Возможные значения: >= 1 и <= 10000

Количество записей на странице

{
  "cards": [
    {
      "businessCardId": "string",
      "cardStatus": "string",
      "accountNumber": "string",
      "maskedCardNumber": "220220******0760",
      "embossedName": "string",
      "holderName": "string",
      "userIsHolder": true,
      "cardOpenDate": "string",
      "cardExpiryDate": "string",
      "limits": [
        {
          "name": "string",
          "period": "DAY",
          "value": "string",
          "restVolume": "string"
        }
      ]
    }
  ],
  "pagination": {
    "hasNextPage": true,
    "offset": 0,
    "count": 0
  }
}

Ошибка бизнес-логики

• application/json

• Схема
• Пример из схемы

Schema

errorCode

string

required

Возможные значения: <= 255 characters

Код ошибки

errorType

string

required

Возможные значения: [VALIDATION_ERROR, UNEXPECTED_SOWA_ERROR, CONTEXT_ERROR, GATEWAY_ERROR, UNEXPECTED_SERVER_ERROR, FORBIDDEN_ERROR, INTEGRATION_ERROR, BUSINESS_LOGIC_ERROR, REQUEST_LIMIT_EXCEED]

errorDesc

string

required

Возможные значения: <= 255 characters

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

requestId

string

Возможные значения: <= 36 characters

Уникальный идентификатор запроса

{
  "errorCode": "string",
  "errorType": "VALIDATION_ERROR",
  "errorDesc": "string",
  "requestId": "string"
}

Нет доступа к услуге / сервису

• application/json

• Схема
• Пример из схемы

Schema

errorCode

string

required

Возможные значения: <= 255 characters

Код ошибки

errorType

string

required

Возможные значения: [VALIDATION_ERROR, UNEXPECTED_SOWA_ERROR, CONTEXT_ERROR, GATEWAY_ERROR, UNEXPECTED_SERVER_ERROR, FORBIDDEN_ERROR, INTEGRATION_ERROR, BUSINESS_LOGIC_ERROR, REQUEST_LIMIT_EXCEED]

errorDesc

string

required

Возможные значения: <= 255 characters

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

requestId

string

Возможные значения: <= 36 characters

Уникальный идентификатор запроса

{
  "errorCode": "string",
  "errorType": "VALIDATION_ERROR",
  "errorDesc": "string",
  "requestId": "string"
}

Внутренняя ошибка сервера

• application/json

• Схема
• Пример из схемы

Schema

errorCode

string

required

Возможные значения: <= 255 characters

Код ошибки

errorType

string

required

Возможные значения: [VALIDATION_ERROR, UNEXPECTED_SOWA_ERROR, CONTEXT_ERROR, GATEWAY_ERROR, UNEXPECTED_SERVER_ERROR, FORBIDDEN_ERROR, INTEGRATION_ERROR, BUSINESS_LOGIC_ERROR, REQUEST_LIMIT_EXCEED]

errorDesc

string

required

Возможные значения: <= 255 characters

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

requestId

string

Возможные значения: <= 36 characters

Уникальный идентификатор запроса

{
  "errorCode": "string",
  "errorType": "VALIDATION_ERROR",
  "errorDesc": "string",
  "requestId": "string"
}

Loading...

Loading...