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

Сообщение будет приходить на ранее указанный адрес обратного вызова (поле "cbUrl" при отправке заявки в шаге 4).

Имя поляКратностьТипОписание
applicationId1StringИдентификатор заявки. toProducts[].applicationId из POST /api/v1/deal/send_applications (Шаг 4. Отправка заявки в сервисы с указанием продуктов)
displayStatus1StringСтатус заявки, для отображения пользователю, указанный в настройках статусной модели владельцем поставщика продуктов(банком).
applicationStatus1StringНастройка статусной модели определена в Статусы подключаемого сервиса: dealApplicationStatuses. Набор возможных статусов, отражающий жизненный цикл заявки, и получаемых внешней системой формирования заявок определен ниже.
message0-1String

userActions[]0-NObject[]Настройка возможный действий при различных статусах на стороне банка определен в Пользовательские действия: userActions.

userActions[].actionType

1Enum(
CLIENT_EXTERNAL_SIGN

AGENT_GET_EXTERNAL_SIGN_URL
CLIENT_INTERNAL_SIGN
AGENT_GET_INTERNAL_SIGN_URL
CLIENT_SIGN_OFFER
CORRECT_REQUEST
GO_TO_SERVICE
)
Тип действия

userActions[].label

1StringНазвание действия

userActions[].description

1StringОписание действия

userActions[]{CLIENT_EXTERNAL_SIGN}.signUrl

1URLURL на страницу с подписанием заявки

userActions[]{AGENT_GET_EXTERNAL_SIGN_URL}.signUrl

1URLURL на страницу с подписанием заявки

userActions[]{CORRECT_REQUEST}.url

1URLURL на страницу с возможностью редактирования заявки

userActions[]{CLIENT_INTERNAL_SIGN}.documentsToSignUrl

1URLURL получения списка документов на подписание

userActions[]{AGENT_GET_INTERNAL_SIGN_URL}.documentsToSignUrl

1URLURL получения списка документов на подписание

userActions[]{GO_TO_SERVICE}.url

1URLURL на страницу с дальнейшими дополнительными действиями пользователя.


Для повышения уровня безопасности коммуникации, и минимизации согласования авторизационных данных, данное сообщение планируется передавать в виде подписанного JWT, чтобы принимающая сторона смогла проверять достоверность полученных данных без необходимости какой-либо дополнительной аутентификации при обратном вызове.
{
  "applicationId": "de74bb16-7d03-420f-9c84-f034f249a1b0",
  "displayStatus": "Готова к подписанию",
  "applicationStatus": "SENT_TO_SERVICE",
  "message": null,
  "userActions": [
    {
      "actionType": "CLIENT_INTERNAL_SIGN",
      "label": "Подписать",
      "description": "Подписать заявку",
      "documentsToSignUrl": "/deal/documents_to_sign/de74bb16-7d03-420f-9c84-f034f249a1b0"
    },
    {
      "actionType": "AGENT_GET_INTERNAL_SIGN_URL",
      "label": "Получить ссылку",
      "description": "Получить ссылку для подписания клиентом",
      "documentsToSignUrl": "/deal/documents_to_sign/de74bb16-7d03-420f-9c84-f034f249a1b0"
    }
  ]
}

На текущий момент в прототипе не реализован проброс API для подписания документов, чтобы заявка могла считаться подписанной. Необходимые данные для получения и подписания документов предполагается указывать в виде соответствующих URI внутри каждого элемента userActions. Так же возможна реализация ресурса, для получения текущего состояния заявки, чтобы внешняя система могла в любой момент получить актуальное состояние заявки, и возможные действия по ней.

Не все требования к полям сервисы декларируют в своих продуктах, некоторые проверки они выполняют у себя самостоятельно, поэтому возможны статусы отклонения заявки. 

Пример отклонения заявки

{
  "applicationId": "33c9e43e-82fd-43ea-8fbf-4d54fa4fa97f",
  "displayStatus": "Ошибка отправки",
  "applicationStatus": "REJECTED_BY_SERVICE",
  "message": "У компании-агента не заполнен ОКПО в карточке компании.\r\nУ компании-агента не заполнен базовый ОКВЭД в карточке компании.\r\nУ компании-агента не заполнен юридический адрес в карточке компании.\r\nУ компании-агента не заполнен тип организации в карточке компании.\r\nУ компании-агента не заполнен фактический адрес в карточке компании.",
  "userActions": []
}

Возможные значения applicationStatus:

ЗначениеОписание
SENT_TO_SERVICEОтправлена в сервис
CLOSED_BY_SYSTEMЗакрыта системой. Терминальный статус
REJECTED_BY_SERVICEОтклонена сервисом (банком). Терминальный статус
PRODUCT_ISSUEDВыпущен продукт. Терминальный статус
  • Нет меток