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

1 Проблематика

Если вы не нашли в списке доступных к подключению ПС, вы можете собственными силами подключить любую другую ПС, используя протокол взаимодействия с сервисами ОпенТрейд Коммерс.

2 Общие сведения

ОпенТрейд Коммерс предоставляет протокол, позволяющий Контрагенту интегрировать способы оплаты, недоступные клиентам ОпенТрейд Коммерс, в систему заказов и учета движения средств.

Сокращения

  • ОпенТрейд Коммерс -- система заказов и учета движения средств. Биллинг.
  • Контрагент — клиент ОпенТрейд Коммерс.
  • Плательщик — пользователь веб-ресурса Контрагента, совершающий платеж.
  • ПС — платежная система.

Подключение

Для подключения к данному протоколу необходимо:

3 Общее описание протокола

Диаграмма последовательности взаимодействия всех участников платежа

Сам процесс взаимодействия является обобщенным примером. В некоторых реальных ситуациях процесс может несколько отличаться от представленного на диаграмме.

Далее следует подробное пошаговое описание последовательности процесса взаимодействия.

3.1 Пример взаимодействия Плательщик, ПС, Контрагент, ОпенТрейд Коммерс при проведении платежа.

1. Плательщик инициализирует оплату.
2-4. Сайт контрагента запрашивает способы оплаты в ОпенТрейд Коммерс с помощью метода GetPaymentModes и показывает плательщику.

Способ оплаты для работы с кастомной ПС, в ответе метода GetPaymentModes, будет иметь идентификатор: opentao.custom

5. Плательщик выбирает способ оплаты и заполняет платежные данные, такие как сумма платеж и др.

6. Сайт Контрагента запрашивает данные системы учета ОпенТрейд Коммерс для инициализации платежа в ПС с помощью метода GetPaymentParameters

7. ОпенТрейд Коммерс передает платежные данные в ответ на вызов метода GetPaymentParameters

 Кликните здесь, чтобы расширить...
Пример ответа PaymentFormAnswer

где

Параметр
Описание
 
RequestUrlАдрес тестовой страницы, для проверки работы кастомной платежной системы до её отдельной реализации 
RequestMethodСпособ пересылки на адрес тестовой страницыGET/POST
ParameterПлатежный параметр, являющийся по сути KeyValuePair 
Parameter.NameИмя параметра 
Parameter.ValueЗначение параметра 

Варианты имен параметров (описание см. в 3.3.1):

Имя параметраНеобязательные
orderId+
paymentId 
userId 
amount 
currency 
description 
successUrl 
failUrl 
resultUrl 

8. Контрагент на основе данных, полученных на шаге 7, формирует платежную форму с учетом требований ПС.

9. По данным, полученным из платежной формы, ПС формирует контракт, отправляет его плательщику и ждет подтверждения оплаты.

10. Плательщик подтверждает платеж.

11. ПС принимает и проверяет платеж.

12. ПС возвращает в браузер плательщика ответ - страницу с сообщением об успехи/неудачи платежа.

3.2 Пример взаимодействия ПС, Контрагент, ОпенТрейд Коммерс при оповещении о платеже.

13. ПС уведомляет Контрагента о совершенном платеже

14. Контрагент адаптирует данные, полученные в шаге 13, к параметрам оповещения ОпенТрейд Коммерс.

15. Контрагент уведомляет ОпенТрейд Коммерс о совершенном платеже.

 Кликните здесь, чтобы расширить...

Необходимо передать нижеследующие параметры на адрес оповещения (параметр resultUrl из полученных ОпенТрейд Коммерс на 7 шаге), используя транспорт HTTP.

Параметры (описание см. в 3.3.1):

Имя параметраНеобязательные
instanceKey 
orderId+
paymentId 
userId 
amount 
currency 
status 
signature 

16. ОпенТрейд Коммерс проверяет параметры оповещение. В случае когда все проверки пройдены и статус платежа помечен как Completed — зачисляет средства на счет плательщика.

17. ОпенТрейд Коммерс подтверждает Контрагенту получение оповещения о платеже.

 Примеры ответов на оповещение

Ответ о безошибочной обработке оповещения

Ответ с ошибкой

где

ПараметрОписание
PaymentId 
Идентификатор платежа во внутренней системе биллинга ОпенТрейд Коммерс
ErrorCode 
Код ошибки. Подробнее см. 3.3.2
ErrorDescription 
Описание ошибки

18. Контрагент подтверждает ПС получение оповещения о платеже.

3.3. Таблицы данных

3.3.1 Платежные параметры 

ПараметрОписаниеВозможное значениеПримечание
instanceKeyИдентификатор Контрагента в системе ОпенТрейд Коммерс  
secretПлатежный секрет Необходим для формирования цифровой подписи 3.4. Выдается Контрагенту от ОпенТрейд Коммерс.
orderIdИдентификатор заказа для оплаты 

Присутствует если пользователь оплачивает заказ.

Отсутствует при пополнении счета

paymentIdИдентификатор платежа во внутренней системе биллинга ОпенТрейд Коммерс  
userIdИдентификатор пользователя ОпенТрейд Коммерс  
amountСумма платежа Десятичный разделитель — точка, и всегда 2 знака после него.
currencyЦифровой код валюты платежа в формате ISO 4217643 - RUBhttp://en.wikipedia.org/wiki/ISO_4217
statusСостояние платежа

Completed - завершен

Canceled - отменен

 
signatureЦифровая подпись зашифрованная по алгоритму MD5 32 шестнадцатеричных символа, в верхнем регистре
descriptionОписание платежа  

3.3.2 Описание NoticeErrorCode

КодОписание
OkОповещение обработано
VerificationErrorОшибка при проверки входящих данных
SignatureVerificationErrorНе совпали цифровые подписи: присланная Контрагентом и подсчитанная на стороне ОпенТрейд Коммерс
InternalErrorВнутренняя ошибка сервиса ОпенТрейд Коммерс. Необработанная ошибка

3.4. Правила формирования цифровой подписи при оповещении Контрагентом ОпенТрейд Коммерс

MD5 хеширование применяется к тексту, формируемому как последовательность значений ряда параметров, разделенных символом «точка с запятой» — «;». 

orderId;paymentId;userId;amount;currency;status;secret

Пример:

СтрокаРезультат
111;222;0000000001;500.15;643;Completed;secret11AE0ABC8F0CF443F950D84C278F1C51
  • No labels