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

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

GET

/v1/card-issues/{externalId}/state

Запрос на получение статуса реестра на открытие счетов и выпуск карт.

Должен содержать токен доступа (access_token) пользователя в параметре Authorization заголовка.

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

Request {#request}

Path Parameters

externalId
uuid
required
Уникальный идентификатор реестра на открытие счетов и выпуск карт
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Ответы

• 200
• 400
• 401
• 403
• 404
• 500
• 503

Успешный код возврата

• application/json

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

Schema

bankStatus

string

Статус документа

bankComment

string

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

Банковский комментарий к статусу документа

channelInfo

Дополнительная информация (string)

Комментарий, специфичный для документа, полученного по данному каналу

{
  "bankStatus": "PROCESSING",
  "bankComment": "Документ в обработке",
  "channelInfo": "string"
}

Ошибка в запросе

• application/json

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

Schema

bankStatus

string

Статус документа

bankComment

string

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

Банковский комментарий к статусу документа

channelInfo

Дополнительная информация (string)

Комментарий, специфичный для документа, полученного по данному каналу

{
  "bankStatus": "PROCESSING",
  "bankComment": "Документ в обработке",
  "channelInfo": "string"
}

accessToken not found

• application/json

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

Schema

bankStatus

string

Статус документа

bankComment

string

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

Банковский комментарий к статусу документа

channelInfo

Дополнительная информация (string)

Комментарий, специфичный для документа, полученного по данному каналу

{
  "bankStatus": "PROCESSING",
  "bankComment": "Документ в обработке",
  "channelInfo": "string"
}

Операция не может быть выполнена: доступ к ресурсу запрещен

• application/json

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

Schema

bankStatus

string

Статус документа

bankComment

string

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

Банковский комментарий к статусу документа

channelInfo

Дополнительная информация (string)

Комментарий, специфичный для документа, полученного по данному каналу

{
  "bankStatus": "PROCESSING",
  "bankComment": "Документ в обработке",
  "channelInfo": "string"
}

Документ не найден

• application/json

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

Schema

accept

boolean

required

Флаг Согласие физ. лиц получено

authPersonName

string

ФИО ответственного лица

authPersonTelfax

string

Телефон ответственного лица

bankComment

string

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

Банковский комментарий к статусу документа

bankStatus

string

Статус документа

contractDate

date

required

Дата зарплатного договора

contractNumber

string

required

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

Номер зарплатного договора

date

date

required

Дата составления документа

digestSignatures object[]
Array [
certificateUuid
uuid
required
Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
base64Encoded
string
required
Возможные значения: non-empty
Значение электронной подписи, закодированное в Base64
]
employeeCardIssue FintechCardIssueEmployee[]required
Array [
accountNumber
string
Возможные значения: <= 20 characters, Value must match regular expression ^\d{20}$
Номер открытого счета
bankMessage
string
Возможные значения: <= 255 characters
Банковский комментарий к статусу карты
birthDate
date
required
Дата рождения
birthPlace
string
required
Возможные значения: <= 500 characters
Место рождения
cardInfo FintechCardIssueCardInforequired
Информация по карте
bonusId
string
Возможные значения: <= 2 characters
Идентификатор бонус программы
bonusNum
string
Возможные значения: <= 10 characters
Номер участника в бонусной программе
cardCurrName
string
required
Возможные значения: <= 3 characters
Цифровой код валюты счета
extendedCode
string
required
Возможные значения: <= 20 characters
Код типа карты
cardTypeName
string
required
Возможные значения: <= 50 characters
Тип карты
embossedTextFirstName
string
required
Возможные значения: <= 50 characters
Текст эмбоссированный Имя
embossedTextSurname
string
required
Возможные значения: <= 50 characters
Текст эмбоссированный Фамилия
cardUniqueDesignCode
string
Возможные значения: <= 11 characters
Код индивидуального дизайна карты
categoryCode
string
required
Возможные значения: <= 4 characters
Код категории населения
citizenship FintechCardIssueCitizenshiprequired
Гражданство
countryNumericCode
string
required
Возможные значения: <= 3 characters
Гражданство сотрудника, цифровой код страны
countryCode
string
required
Возможные значения: <= 3 characters
Гражданство сотрудника, буквенный код стран
country
string
required
Возможные значения: <= 64 characters
Гражданство сотрудника, наименование страны
contactInfo FintechCardIssueContactInfo
Контактная информация
email
string
Возможные значения: <= 50 characters
Электронная почта
homePhone
string
Домашний телефон
mobileOperatorType
string
Наименование оператора мобильной связи
mobilePhone
string
Возможные значения: <= 10 characters
Мобильный телефон
officePhone
string
Рабочий телефон
firstName
string
required
Возможные значения: <= 50 characters
Имя
identityDoc FintechCardIssueIdentityDoc
Документ удостоверяющий личность
issueDate
date
required
Дата выдачи
issuer
string
required
Возможные значения: <= 250 characters
Кем выдан
issuerCode
string
required
Возможные значения: <= 10 characters
Код органа, выдавшего документ
number
string
required
Возможные значения: <= 20 characters
Номер
serial
string
required
Возможные значения: <= 20 characters
Серия
type
string
required
Возможные значения: <= 150 characters
Наименование ДУЛ
typeCode
string
required
Возможные значения: <= 2 characters
Код вида документа
inn
string
Возможные значения: <= 12 characters, Value must match regular expression ^\d{10,12}$
ИНН
issCard
boolean
Признак того что карта выпущена
lastName
string
required
Возможные значения: <= 50 characters
Фамилия
middleName
string
Возможные значения: <= 50 characters
Отчество
personnelNumber
string
Возможные значения: <= 128 characters
Табельный номер
placeOfService FintechCardIssuePlaceOfServicerequired
Места обслуживания физических лиц
branchCode
string
required
Возможные значения: <= 20 characters
Код подразделения
branchName
string
required
Возможные значения: <= 255 characters
Наименование подразделения
osb
string
required
Возможные значения: <= 22 characters
Номер ОСБ
vsp
string
required
Возможные значения: <= 22 characters
Номер ВСП
tb
string
required
Возможные значения: <= 3 characters
Номер ТБ
position
string
Возможные значения: <= 128 characters
Должность
registrationAddress FintechCardIssueAddressrequired
Адрес
building
string
Возможные значения: <= 10 characters
Номер корпуса
city
string
Возможные значения: <= 100 characters
Город
country
string
required
Возможные значения: <= 64 characters
Наименование страны
countryCode
string
required
Возможные значения: <= 3 characters
Трехбуквенный код страны
countryNumericCode
string
required
Возможные значения: <= 3 characters
Цифровой код страны
district
string
Возможные значения: <= 100 characters
Район
flat
string
Возможные значения: <= 10 characters
Номер офиса/квартиры
fullAddress
string
Возможные значения: <= 500 characters
Полный адрес
house
string
required
Возможные значения: <= 10 characters
Номер дома
postalCode
string
required
Возможные значения: <= 30 characters
Индекс
settlementName
string
Возможные значения: <= 100 characters
Наименование нас. пункта
state
string
required
Возможные значения: <= 100 characters
Субъект/Регион
street
string
required
Возможные значения: <= 100 characters
Улица
resident
boolean
Резидент РФ
residentalAddress FintechCardIssueAddress
Адрес
building
string
Возможные значения: <= 10 characters
Номер корпуса
city
string
Возможные значения: <= 100 characters
Город
country
string
required
Возможные значения: <= 64 characters
Наименование страны
countryCode
string
required
Возможные значения: <= 3 characters
Трехбуквенный код страны
countryNumericCode
string
required
Возможные значения: <= 3 characters
Цифровой код страны
district
string
Возможные значения: <= 100 characters
Район
flat
string
Возможные значения: <= 10 characters
Номер офиса/квартиры
fullAddress
string
Возможные значения: <= 500 characters
Полный адрес
house
string
required
Возможные значения: <= 10 characters
Номер дома
postalCode
string
required
Возможные значения: <= 30 characters
Индекс
settlementName
string
Возможные значения: <= 100 characters
Наименование нас. пункта
state
string
required
Возможные значения: <= 100 characters
Субъект/Регион
street
string
required
Возможные значения: <= 100 characters
Улица
result
string
Возможные значения: <= 100 characters
Результат открытия счетов / выпуска карт
sameAddress
boolean
Адреса регистрации и проживания совпадают
sendReport
boolean
Признак рассылки отчета по Internet
serNumber
int64
required
№ п/п
sex
boolean
required
Пол(false-женский, true-мужской)
]
employeesNumber

int32

required

Итоговое количество сотрудников

externalId

string

required

Возможные значения: <= 36 characters, Value must match regular expression ^[a-f0-9]{8}(-[a-f0-9]{4}){3}(-[a-f0-9]{12})$

Идентификатор документа, присвоенный сервисом (UUID)

number

string

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

Номер документа

orgName

string

required

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

Наименование организации пользователя

orgTaxNumber

string

required

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

ИНН организации пользователя

{
  "accept": true,
  "authPersonName": "string",
  "authPersonTelfax": "string",
  "bankComment": "string",
  "bankStatus": "string",
  "contractDate": "2017-07-21",
  "contractNumber": "string",
  "date": "2024-07-29",
  "digestSignatures": [
    {
      "certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
      "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w=="
    }
  ],
  "employeeCardIssue": [
    {
      "accountNumber": "40817810000001234567",
      "bankMessage": "string",
      "birthDate": "2024-07-29",
      "birthPlace": "string",
      "cardInfo": {
        "bonusId": "01",
        "bonusNum": "string",
        "cardCurrName": "22",
        "extendedCode": "string",
        "cardTypeName": "string",
        "embossedTextFirstName": "string",
        "embossedTextSurname": "string"
      },
      "cardUniqueDesignCode": "string",
      "categoryCode": "01",
      "citizenship": {
        "countryNumericCode": "08",
        "countryCode": "RU",
        "country": "string"
      },
      "contactInfo": {
        "email": "string",
        "homePhone": "string",
        "mobileOperatorType": "string",
        "mobilePhone": "string",
        "officePhone": "string"
      },
      "firstName": "string",
      "identityDoc": {
        "issueDate": "2024-07-29",
        "issuer": "string",
        "issuerCode": "string",
        "number": "string",
        "serial": "string",
        "type": "string",
        "typeCode": "01"
      },
      "inn": 123456789012,
      "issCard": true,
      "lastName": "string",
      "middleName": "string",
      "personnelNumber": "string",
      "placeOfService": {
        "branchCode": "1390130151",
        "branchName": "ДО №1111/0777",
        "osb": "string",
        "vsp": "string",
        "tb": "01"
      },
      "position": "string",
      "registrationAddress": {
        "building": "string",
        "city": "string",
        "country": "string",
        "countryCode": "AAA",
        "countryNumericCode": "111",
        "district": "string",
        "flat": "string",
        "fullAddress": "string",
        "house": "string",
        "postalCode": "string",
        "settlementName": "string",
        "state": "string",
        "street": "string"
      },
      "resident": true,
      "residentalAddress": {
        "building": "string",
        "city": "string",
        "country": "string",
        "countryCode": "AAA",
        "countryNumericCode": "111",
        "district": "string",
        "flat": "string",
        "fullAddress": "string",
        "house": "string",
        "postalCode": "string",
        "settlementName": "string",
        "state": "string",
        "street": "string"
      },
      "result": "string",
      "sameAddress": true,
      "sendReport": true,
      "serNumber": 0,
      "sex": true
    }
  ],
  "employeesNumber": 0,
  "externalId": "9b9f1b57-425e-4aff-9856-21fc4951f1e8",
  "number": "string",
  "orgName": "string",
  "orgTaxNumber": "string"
}

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

• application/json

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

Schema

bankStatus

string

Статус документа

bankComment

string

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

Банковский комментарий к статусу документа

channelInfo

Дополнительная информация (string)

Комментарий, специфичный для документа, полученного по данному каналу

{
  "bankStatus": "PROCESSING",
  "bankComment": "Документ в обработке",
  "channelInfo": "string"
}

Сервис временно недоступен

• application/json

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

Schema

bankStatus

string

Статус документа

bankComment

string

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

Банковский комментарий к статусу документа

channelInfo

Дополнительная информация (string)

Комментарий, специфичный для документа, полученного по данному каналу

{
  "bankStatus": "PROCESSING",
  "bankComment": "Документ в обработке",
  "channelInfo": "string"
}

Loading...

Loading...