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

POST /api/v1/deal/send_applications


Имя поляКратностьТипОписание
toProducts[]1-N
Целевые продукты отправки заявки

toProducts[].productId

1StringИдентификатор продукта
toProducts[].applicationId1StringИдентификатор создаваемой заявки для данного продукта
toProducts[].cbUrl1URLURL для обратной связи по заявке. На этот URL придет результат первичной обработки заявки банком, а так же будут приходить  события о изменении статуса заявки
dealState1ObjectСостояние заявки. По структуре идентично dealState передаваемой в /api/v1/deal/findProducts
{
  "toProducts": [
    {
      "productId": "7ab44246-4607-41f4-8272-8b2ed290e444:179f3310-9827-44a2-913a-515cf2c43721",
      "applicationId": "de74bb16-7d03-420f-9c84-f034f249a1b0"
    }
  ],
  "cbUrl": "https://some_host.com/cb"
  "dealState": <...>
}
В ближайшем будущем планируется вместо productId принимать токен, который будет возвращаться из findProducts. Так же вероятна замена передачи данных в dealState на указание URI, по которому можно получить данные, с поддержкой указания требуемых секций данных. Эти преобразования дадут возможность применить стиль REST с применением HATEOAS.

Информация о результате принятия заявки в работу

Система банка, получив заявку, делает первичную ее валидацию, по результатам которой она отправляет сообщение о успешном или провалившемся результате принятия заявки в обработку.

Имя поляКратностьТипОписание
originatorMsgType1

Enum(
AddDealApplication
CancelDealApplication
SignServiceDocuments
)

Инициирующий тип сообщения
originatorMsgId

Системное поле, формируется GF при отправке заявки в конкретный сервис
targetObjectId

Идентификатор заявки, по которой пришел результат
result1Enum(SUCCESS, ERROR)

error0-1
Доп информация о ошибке, если result=ERROR.
error.id1UUIDУникальный идентификатор конкретной ошибки, формируется для каждого запроса свой.
error.errorCode1StringМашиночитаемый код ошибки
error.message0-1StringСообщение о ошибке от сервиса
error.params0-1Map<String, Object>Набор параметров ошибки, соответствующий errorCode. Ключ-значение. 


Структура сообщения об успешном принятии заявки в работу

{
  "originatorMsgType": "AddDealApplication",
  "originatorMsgId": "a45f8520-b132-4ab4-82ce-562affdbed43",
  "targetObjectId": "333a7c64-973d-40ce-8fb5-18f228d89b8f",
  "result": "SUCCESS",
  "error": null
}

Структура сообщения об ошибке

{
  "originatorMsgType": "AddDealApplication",
  "originatorMsgId": "e8eb698b-0dea-4fd7-a705-b254eb53e06f",
  "targetObjectId": "333a7c64-973d-40ce-8fb5-18f228d89b8f",
  "result": "ERROR",
  "error": {
    "id": "adbab53c-11aa-43c8-b9e1-8960a03d8ee0",
    "errorCode": "MY_ERROR_STATUS_1",
    "message": "Some message",
    "params": {
      "MY_PARAM_3": "VALUE3"
    }
  }
}
  • Нет меток