API Описание процесса передачи данных
для взаимодействия
между Банком и Партнером
в рамках программы «Партнерский инстоллмент»
Оглавление
2Назначение документа. 3
3История изменений документа. 3
4Глоссарий. 4
5Передача данных. 4
6Описание API. 5
7Описание методов. 5
7.1Pегистрация заказа (createOrder) 5
7.1.1Вызов Партнера со стороны Банка на этапе регистрации заказа 7
7.1.2Вызов Партнера со стороны Банка для передачи параметров для формирования Гарантийного Письма 8
7.1.3Вызов Партнера со стороны Банка для передачи Гарантийного Письма в формате BASE64 8
7.2Получение информации по заказу (getOrder) 9
7.3Получение Гарантийного письма по заказу (getGuarantee) 10
7.4Изменение данных по заказу (updateOrder) 11
7.5Отмена заказа (по инициативе Партнера) (cancelOrder) 13
7.5.1Вызов Партнера со стороны Банка на этапе обработки запроса на отмену заказа 14
7.6Подтверждение заказа (confirmOrder) 14
7.7Возврат товара по заказу (reversalOrder) 15
7.7.1Вызов Партнера со стороны Банка на этапе регистрации возврата 17
7.8Варианты поведения Партнера в случае возникновения отдельных статусов на методах регистрации заказа, отмены, возврата 17
Назначение документа.
Данный документ предназначен для предоставления сведений относительно технической реализации и описывает варианты передачи данных между Банком и Партнером в рамках программы «Партнерский инстоллмент»
История изменений документа.
| Номер версии | Дата | Автор изменения | Суть изменения |
| 1 | 05.03.2019 | Вишневская Н. | Базовая версия документа |
| 1.01 | 14.03.2019 | Вишневская Н. | Внесены уточнения по результатам внутренних обсуждений: в методах регистрации заказа, отмены заказа и возврата по заказу (order method POST, order method DELETE, reversalOrder method POST) унифицирован набор параметров, участвующий в назначении платежа при взаиморасчетах с Партнером (сумма покупки/отмены/возврата, НДС, код ТТ) термин «заявка» заменен на «заказ» |
| 1.02 | 21.03.2019 | Вишневская Н. | Добавлены разделы с описанием методов вызова Партнера со стороны Банка (на этапе регистрации заказа и возврата); расширен перечень вариантов ответа Партнеру на шагах регистрации заказа и возврата; callBackURL – обязательный параметр при регистрации и изменении заказа; в запросах регистрации и изменения заказа добавлен обязательный входящий параметр e-mail, на который будет отправляться Гарантийное письмо описан набор знаков, допустимых для параметра orderID, orderTerm |
| 1.03 | 29.03.2019 | Вишневская Н. | Уточнен набор параметров в методе редактирования заказа Описана таблица отдельных статусов, причины их возникновения и дальнейшее поведение Партнера Описаны примеры набора параметров для получения Гарантийного письма |
| 1.04 | 09.04.2019 | Вишневская Н. | Уточнен набор параметров при редактировании заказа, возврате товара по заказу Исключен метод изменения статуса заказа Добавлены методы для подтверждения (confirm order) и отмены (cancel order) заказа В методе отмены параметр cancelId на вход обязательный, reason на входе необязательный в методе возврата - в ответе messageId это ИД отмены (а не ИД покупки) статус NO_ORDERID_MESSAGEID заменен на NO_IDS Изменен набор статусов при обработке возврата |
| 1.05 | 15.04.2019 | Вишневская Н. | Уточнен набор параметров в методе getOrder |
| 1.06 | 19.04.2019 | Вишневская Н. | Добавлен раздел с описанием вызова со стороны Банка на этапе обработки запроса на отмену заказа |
| 1.07 | 02.05.2019 | Вишневская Н. | Добавлен метод вызова со стороны Партнера для получения Гарантийного письма getGuaranty |