- Created by IntellectMoney, last modified by Unknown User (a.chernyh) on Sep 30, 2019
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 239 Next »
БИЗНЕС СХЕМА
Примерная схема взаимодействия системы IntellectMoney, Интернет-магазина и Покупателя (данная схема не является обязательно и служит только для демонстрации):
- Покупатель оформляет заказ: вводит персональные данные, выбирает способ доставки и так далее.
- После того как пользователь отправил персональные данные, система Интернет-магазина получает доступные (активные) магазину способы оплаты, использую метод getpaymentways().
Этот шаг можно пропустить, если способ оплаты выбирается на шаге 1.
Этот шаг можно выполнить после выставления счёта к оплате.
Это шаг можно пропустить, если есть четкое понимание каким способом будет проводиться оплата.
Этот шаг можно выполнить до шага 1. - Система IntellectMoney возвращает в систему магазина все доступные (активные) способы оплаты.Система Интернет-магазина предлагает пользователю выбрать способ оплаты.
Данный шаг выполняется всегда, когда выполняется шаг 2. - Покупатель выбирает способ оплаты.
Этот шаг можно пропустить, если способ оплаты выбирается на шаге 1 или есть четкое понимание каким способом будет проводиться оплата. - Система Интернет-магазина показывает информацию о выбранном способе оплаты, предлагает подтвердить согласие с условиями и прочее.
Этот шаг можно пропустить, если способ оплаты выбирается на шаге 1 или есть четкое понимание каким способом будет проводиться оплата. - Покупатель заполняет какие-либо поля, выполняет инструкции.
Этот шаг можно пропустить, если способ оплаты выбирается на шаге 1 или есть четкое понимание каким способом будет проводиться оплата. - Система Интернет-магазина , на основании выбранного способа оплаты, выставляет счёт к оплате через метод createinvoice().
- Система IntellectMoney возвращает в систему магазина номер созданного счёта к оплате - invoiceId.
- Система Интернет-магазина вызывает метод оплаты в зависимости от выбранного способа оплаты.
- Система IntellectMoney возвращает всю необходимую информацию для проведения оплаты.
- Система Интернет-магазина отображает покупателю информацию об оплате.
- Если был выбран не моментальный способ оплаты, например почтой России, то пользователь асинхронно оплачивает покупку, сделанную в Интернет магазине.
- Когда деньги поступили на счёт, система IntellectMoney оповещает систему Интернет-магазина, посредством отправки формы оповещения (см. протокол IntellectMoney) на URL оповещения о платеже - Result URL.
- Если был выбран моментальный способ оплаты. Пользователь заполняет поля, производит необходимые действия и отправляет эти данные в систему Интернет-магазина.
- Система Интернет-магазина,в зависимости от выбранного способа оплаты, отображает форму для ввода 3-DS пароля или переводит Покупателя на страницу личного кабинета(Сбербанк, AlfaClick и др.).
- Если был выбран способ оплаты через обменники (exchangers - AlfaClick, Qiwi и т.д.), пользователь завершает оплату в личном кабинете обменника.
- Когда деньги поступили на счёт, система IntellectMoney оповещает систему Интернет-магазина, посредством отправки формы оповещения (см. протокол IntellectMoney ) на URL оповещения о платеже - Result URL.
- Система Интернет-магазина показывает страницу с сообщением об успешной оплате, если это требуется.
После того как Система Интернет-магазина получила ID счета к оплате (invoiceId), можно получить информацию по данному счету к оплате, через метод getPuschaseInfo(). Через этот метод дополнительно можно получить информацию о настройках магазина в системе IntellectMoney- узнать время работы, название и так далее.
Порядок вызова методов для оплаты Банковской картой (Acquiring): bankCardPayment() затем activationPay(), после вызова метода bankCardPayment() можно отслеживать состояние платежа через метод getBankCardPaymentState().
ОБЩАЯ ИНФОРМАЦИЯ
Данное API позволит Вам выставить счёт, контролировать состояние счёта, отправлять пользователя (покупателя) на выбранный способ оплаты или получить необходимые данные для оплаты. Взаимодействие между сервером IntellectMoney и сайтом поставщика (далее поставщика) происходит по HTTP-протоколу.
Данные при запросах на сервер IntellectMoney передаются в формате параметров HTTP-запроса в кодировке UTF-8 с типом контента "application/x-www-form-urlencoded". В ответ данные возвращаются в формате XML, либо в формате JSON. Что бы получить ответ в формате JSON нужно в заголовки запроса передать "Accept: text/json".
Для обращения к методам API нужно выполнить GET- или POST- запрос на URL, который состоит из следующих частей: host(https://api.intellectmoney.ru/merchant/)+номер версии API(<api_version>)+название метода к которому идёт обращение(createinvoice). Пример: https://api.intellectmoney.ru/merchant/latest/getpaymentways. Список всех доступных версий с описанием доступны в разделе "Разница в версиях API".
ПОРЯДОК ВЫЗОВА МЕТОДОВ
Работу с представленным API можно разделить на 2 шага:
- Выставляем счёт к оплате посредством метода createInvoice(). После того как счёт выставлен, его состояние можно отслеживать через метод getPurchaseInfo().
- Если нужно получить все доступные магазину способы оплаты, вызываем метод getPaymentWays(). Если данная информация не нужна и Вы проводить оплату зафиксированным способом оплаты (например, принимаете только оплату с банковской карты), данный метод можно не вызывать.
- В зависимости от выбранного способа оплаты, проводим оплату:
- Оплата с кошелька IntellectMoney:
- Получаем userToken.
- Запрашиваем у Покупателя код для подтверждения платёжных операций (pinCode).
- Обращаемся к методу innerPayment().
- Оплата банковской картой:
- Обращаемся к методу bankCardPayment(). После отправки данных о карте, состояние банковского платежа можно отслеживать через метод getBankCardPaymentState().
- Если платёж 3-DS отображаем Покупателю iFrame с окном для ввода 3-DS пароля.
Если проводим активационный платеж, то обращаемс к методу activationPay().
- Оплата через почту России:
- Запрашиваем у пользователя данные для заполнения бланка.
- Обращаемся к методу getPostPayBlank().
- Оплата через обменники (alfaClick, Яндекс.Деньги и тд):
- Обращаемся к методу обменника:
- Альфа-Клик: alfaClickPayment().
- Сбербанк Онлайн: sberbankPapment().
- Яндекс.Деньги: yandexPayment().
- С кошелька WebMoney: WMRPayment().
- С QIWI-кошелька: QIWIPursePayment().
- Обращаемся к методу обменника:
GETPAYMENTWAYS() - ЗАПРОС СПОСОБОВ ОПЛАТЫ
Передача параметров
Для запроса доступных (активных) магазину способов оплаты необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/merchant/<api_version>/getpaymentways
В запросе необходимо передать следующие параметры:
Название | Имя параметра | Обязательный | Описание |
---|---|---|---|
ID магазина | eshopId | Да, если не передан invoiceId | Номер магазина в системе IntellectMoney, на который пользователь (покупатель) должен совершить платеж. Можно увидеть на странице https://intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID" Если данный параметр не передан, то обязательно нужно передать параметр invoiceId. Иначе Вы получите Exception. |
Номер СКО | invoiceId | Да, если не передан eshopId | Счёт К Оплате - уникальный номер в системе IntellectMoney, с помощью которого идентифицируется любой платеж. Для получения воспользуйтесь операцией “ Запрос выставления счета ” Если данный параметр не передан, то обязательно нужно передать параметр eshopId. Иначе Вы получите Exception. |
Сумма платежа | amount | нет | Сумма платежа, которую поставщик желает получить от пользователя (покупателя). Сумма должна быть больше нуля, дробная часть отделяется точкой, два знака после точки. Если передать данный параметр, то в возвращаемой структуре <PaymentWayListData> будут только те способы оплаты, которые можно использовать для данной суммы. Если данный параметр не передан, то в возвращаемой структуре <PaymentWayListData> будут все способы оплаты, которые активированы в настройках магазина. Максимальная длина - 13 цифр вместе с десятичными знаками. |
Способ оплаты | preferences | Нет | Когда передан данный параметр, то система вернет информацию, только по указанным способам оплаты. Подробное описание доступно по ссылке |
Подпись для преданных данных | hash | Да | Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя. Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности: Строка подписи eshopId::invoiceId::amount::preferences Далее, к этой строке применяется алгоритм криптографии из пункта ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ |
В ответ возвращается код операции и возможны 3 варианта:
Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <PaymentWayListData> (синхронная обработка). ( Код операции - 0 )
Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). ( Код операции - 1 )
Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 2 )
Post /merchant/getPaymentWays/ HTTP/1.1 Host: api.intellectmoney.ru Content-Type: application/x-www-form-urlencoded; charset=utf-8 eshopId=450123 invoiceId=356421216 amount=8.14 hash=dHA6Ly9jcmwuZ2xvYmFsc2lnbi5jb20v3MvZ3Nkb21haW52YWxzaGEyZzIuY3JsMIG
HTTP/1.1 200 OK Content-Type: text/xml <?xml version="1.0" encoding="utf-8"?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OperationState> <Code>0</Code> <Desc>Успешно обработана</Desc> </OperationState> <OperationId>3cf78bc5-63f4-4fe3-86a0-8ce9d60e8228</OperationId> <EshopId>455551</EshopId> <Result> <State> <Code>0</Code> <Desc>Успешно обработан</Desc> </State> <PaymentWays> <PaymentWayData> <Id>1</Id> <Amount> <Amount>10.0000</Amount> <Currency>TST</Currency> </Amount> <Preference>Inner</Preference> <InputType>InnerPayment</InputType> <PreferenceTypes> <PreferenceTypeSpecification>All</PreferenceTypeSpecification> <PreferenceTypeSpecification>Online</PreferenceTypeSpecification> <PreferenceTypeSpecification>NonComission</PreferenceTypeSpecification> <PreferenceTypeSpecification>Flash</PreferenceTypeSpecification> </PreferenceTypes> <ServiceTimeOfEnrollmentType>Flash</ServiceTimeOfEnrollmentType> <Commission>0</Commission> </PaymentWayData> </PaymentWays> </Result> </Response>
CREATEINVOICE - ВЫСТАВЛЕНИЕ СЧЁТА К ОПЛАТЕ (далее СКО)
Запрос выставления СКО
Для выставления счета необходимо отправить GET- или POST-запрос на следующий адрес URL
https://api.intellectmoney.ru/merchant/<api_version>/createInvoice
В запросе необходимо передать следующие параметры:
Название | Имя параметра | Обязательный | Описание |
---|---|---|---|
ID магазина | eshopId | Да | Номер магазина в системе IntellectMoney, на который пользователь (покупатель) должен совершить платеж. Можно увидеть на странице https://intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID" |
Внутренний номер покупки поставщика | orderId | Да | В этом поле нужно передать номер покупки в соответствии со своей системой учета. Данный номер должен быть уникальным, если включена соответствующая опция в настройках магазина в системе IntellectMoney. Можно увидеть на странице настроек магазина https://intellectmoney.ru/ru/enter/ps_organization_shop/ , выбрав “настройки“, далее вкладка “прием платежей“, далее “расширенные настройки“. Если при включенном параметре передать не уникальный номер покупки, то в ответ придет Exception. Максимальная длина - 50 символов. |
Назначение платежа | serviceName | Нет | Описание товара или услуги. Максимальная длина - 1024 символов. |
Сумма платежа | recipientAmount | Да | Сумма платежа, которую поставщик желает получить от пользователя (покупателя). Положительное число, округленное до 2 знаков после десятичной точки, без пробелов. Минимальное значение 10.00. Максимальная длина - 13 цифр вместе с десятичными знаками. |
Валюта платежа | recipientCurrency | Да | Валюта платежа. Может принимать значения:
Внимание: USD и EUR можно передавать только для платежей посредством банковской карты (preference=bankCard). Подробную информацию о подключении иностранных валют Вы можете получить у Вашего персонального менеджера. |
Имя Пользователя | userName | Нет | Имя пользователя (покупателя), который совершает платеж Максимальная длина – 255 символов. |
E-mail пользователя | Да | Email пользователя (покупателя). Максимальная длина – 100 символов. | |
Адрес удачного платежа | successUrl | Нет | Адрес, который будет отображаться в поле SuccessUrl структуре Максимальная длина - 512 символов. |
Адрес не удачного платежа | failUrl | Нет | Адрес, который используется для внутренних нужд. Максимальная длина - 512 символов. |
Адрес окончания платежа | backUrl | Нет | Адрес, который будет отображаться в поле BackUrl структуры <> Максимальная длина - 512 символов. |
Адрес оповещений | resultUrl | Нет | Адрес, на который система IntellectMoney посылает HTTP/S POST запросы об изменении состояния СКО Максимальная длина - 512 символов. |
Дата и время истечения срока блокировки | expireDate | Нет | Дата и время, через которое заблокированные средства зачислятся на счет магазина, либо будут возвращены пользователю (формат “yyyy-MM-dd HH:mm:ss”). Используется в случае использования блокировки (холдирования) средств на СКО. |
Режим холдирования | holdMode | Нет | Устанавливает режим холдированного счета. |
Способ оплаты | preference | Нет | Способы оплаты, которые будут доступны для данного СКО. Если данное поле не передано, то будут доступны все способы, доступные магазину. Подробное описание доступно по ссылке |
Дополнительные параметры поставщика | Определяется поставщиком | Нет | Все поля формы, имеющие в названии префикса "userField_N", "userFieldName_N" (где N порядковый номер), обрабатываются системой IntellectMoney автоматически и передаются на сайт поставщика. Максимальная длина всех дополнительных полей в сумме - 4000 символов |
Подпись для переданных данных из счёта | purchaseHash | Нет | Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя. Не включает в себя hash. Если в настройках магазина включен пункт "Требовать HASH", данный параметр передавать обязательно. Если не передать, то в ответ придет Exception. Проверить включен пункт "Требовать HASH" или нет можно в настройках магазина https://intellectmoney.ru/ru/enter/ps_organization_shop/ вкладка "Прием платежей" -> "Расширенные настройки". Алгоритм формирования описан в протоколе IntellectMoney в разделе " Проверка данных формы запроса ". |
Подпись для преданных данных | hash | Да | Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя. Включает purchaseHash. Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности: Строка подписи eshopId::orderId::serviceName::recipientAmount::recipientCurrency ::userName::email::successUrl::failUrl::backUrl::resultUrl::expireDate ::holdMode::preference Далее, к этой строке применяется алгоритм криптографии из пункта ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ |
В ответ возвращается код операции и возможны 3 варианта:
Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <CreateInvoiceData> (синхронная обработка). ( Код операции - 0 )
Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). ( Код операции - 1 )
Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 2 )
Post /merchant/createInvoice/ HTTP/1.1 Host: api.intellectmoney.ru Content-Type: application/x-www-form-urlencoded; charset=utf-8 eshopId=450123 orderId=test_order recipientAmount=10.00 recipientCurrency=RUB hash=dHA6Ly9jcmwuZ2xvYmFsc2lnbi5jb20v3MvZ3Nkb21haW52YWxzaGEyZzIuY3JsMIG
HTTP/1.1 200 OK Content-Type: text/xml <?xml version="1.0" encoding="utf-8"?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OperationState> <Code>0</Code> <Desc>Успешно обработана</Desc> </OperationState> <OperationId>8f6a8487-98a6-4c03-b8b6-904cffd91749</OperationId> <EshopId>700025</EshopId> <Result> <State> <Code>0</Code> <Desc>Успешно обработан</Desc> </State> <InvoiceId>3470488641</InvoiceId> </Result> </Response>
BANKCARDPAYMENT - ОПЛАТА БАНКОВСКОЙ КАРТОЙ
Запрос регистрации реквизитов
Для передачи реквизитов банковской карты и для дальнейшей оплаты счета необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/merchant/<api_version>/bankcardpayment
В запросе необходимо передать следующие параметры:
Название | Имя параметра | Обязательный | Описание |
---|---|---|---|
ID магазина | eshopId | Да | Номер магазина в системе IntellectMoney, на который пользователь (покупатель) должен совершить платеж. Можно увидеть на странице https://intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID" |
Номер СКО | invoiceId | Да | Счёт К Оплате - уникальный номер в системе IntellectMoney, с помощью которого идентифицируется любой платеж. Для получения воспользуйтесь операцией “ Запрос выставления счета ” |
Номер карты плательщика | pan | Да | Номер карты плательщика |
Держатель карты | cardHolder | Нет | Имя и фамилия плательщика |
Срок действия месяц | expiredMonth | Да | Месяц, до которого действует карта |
Срок действия год | expiredYear | Да | Год, до которого действует карта |
CVV2/CVC2 код | cvv | Нет | Секретный код CVV2 (CVC2), как правило написан на обороте карты (последние три цифры на полосе для подписи). Данный параметр должен быть обязательно передан если банковская карта снабжена cvv. Если попытаться оплатить такой картой и не указать cvv, то банк-эквайер вернет ошибку. Максимальная длина - 512 символов. |
IP адрес сайта магазина | ipAddress | Да | IP адрес сайта, с которого выставляется платеж. |
Подпись для преданных данных | hash | Да | Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя. Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности: Пример формирования строки eshopId::invoiceId::pan::cardHolder::expiredMonth::expiredYear::cvv ::returnUrl::ipAddress Далее, к этой строке применяется алгоритм криптографии из пункта ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ |
В ответ возвращается код операции и возможны 3 варианта:
- Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <BankCardData> (синхронная обработка). ( Код операции - 0 )
- Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). ( Код операции - 1 )
- Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 2 )
Post /merchant/bankCardPayment/ HTTP/1.1 Host: api.intellectmoney.ru Content-Type: application/x-www-form-urlencoded; charset=utf-8 eshopId=450123 invoiceId=356421216 pan=55555555444444 cardHolder=DEFAULT CARDHOLDER expiredMonth=10 expiredYear=19 cvv=123 hash=dHA6Ly9jcmwuZ2xvYmFsc2lnbi5jb20v3MvZ3Nkb21haW52YWxzaGEyZzIuY3JsMIG
HTTP/1.1 200 OK Content-Type: text/xml <?xml version="1.0" encoding="utf-8"?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OperationState> <Code>0</Code> <Desc>Успешно обработана</Desc> </OperationState> <OperationId>8f6a8487-98a6-4c03-b8b6-904cffd91749</OperationId> <EshopId>700025</EshopId> <Result> <State> <Code>0</Code> <Desc>Успешно обработан</Desc> </State> </Result> </Response>
Пример использования
- Запрашиваем у Покупателя данные по карте.
- Обращаемся к методу bankCardPayment(). После отправки данных о карте, состояние банковского платежа можно отслеживать через метод getBankCardPaymentState().
- Дальше возможны два варианта:
- Платёж 3-DS (Статус Платежа 3 - Отправлен на 3DS):
- отображаем Пользователю (Покупателю) код из параметра Form3DS.
- Пользователь Пользователь (Покупатель) проходит 3-DS идентификацию. Состояние банковского платежа можно узнать обратившись к методу getBankCardPaymentState(). Как только данный метод вернет статус 0, можно считать, что счёт оплачен.
- Платёж активационный (Статус Платежа 4 - отправлен на активационный платеж):
- Обращаемся к методу activationPay().
- Платеж не 3-DS, то ничего не делаем (Статус Платежа 2 - в обработке).
- Платёж 3-DS (Статус Платежа 3 - Отправлен на 3DS):
- Сообщаем Пользователю (Покупателю) о завершении оплаты.
GETBANKCARDPAYMENTSTATE - СОСТОЯНИЕ ПЛАТЕЖА
Запрос состояния платежа
Для запроса состояния оплаты счета необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/merchant/<api_version>/getbankcardpaymentstate
В запросе необходимо передать следующие параметры:
Название | Имя параметра | Обязательный | Описание |
---|---|---|---|
ID магазина | eshopId | Да | Номер магазина в системе IntellectMoney, на который пользователь (покупатель) должен совершить платеж. Можно увидеть на странице https://intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID" |
Номер СКО | invoiceId | Да | Счёт К Оплате - уникальный номер в системе IntellectMoney, с помощью которого идентифицируется любой платеж. Для получения воспользуйтесь операцией “ Запрос выставления счета ” |
Подпись для преданных данных | hash | Да | Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя. Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности: Пример формирования строки eshopId::invoiceId Далее, к этой строке применяется алгоритм криптографии из пункта ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ |
В ответ возвращается код операции и возможны 3 варианта:
Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <BankCardPaymentStateData> (синхронная обработка). ( Код операции - 0 )
Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). ( Код операции - 1 )
Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 2 )
Post /merchant/getBankCardPaymentState/ HTTP/1.1 Host: api.intellectmoney.ru Content-Type: application/x-www-form-urlencoded; charset=utf-8 eshopId=450123 invoiceId=356421216 activationAmount=8.14 hash=dHA6Ly9jcmwuZ2xvYmFsc2lnbi5jb20v3MvZ3Nkb21haW52YWxzaGEyZzIuY3JsMIG
HTTP/1.1 200 OK Content-Type: text/xml <?xml version="1.0" encoding="utf-8"?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OperationState> <Code>0</Code> <Desc>Успешно обработана</Desc> </OperationState> <OperationId>8f6a8487-98a6-4c03-b8b6-904cffd91749</OperationId> <EshopId>700025</EshopId> <Result> <State> <Code>0</Code> <Desc>Успешно обработан</Desc> </State> </Result> </Response>
ACTIVATIONPAY - АКТИВАЦИОННЫЙ ПЛАТЁЖ
Передача параметров платежа
Для завершения активационного платежа необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/merchant/<api_version>/activationpay
В запросе необходимо передать следующие параметры:
Название | Имя параметра | Обязательный | Описание |
---|---|---|---|
ID магазина | eshopId | Да | Номер магазина в системе IntellectMoney, на который пользователь (покупатель) должен совершить платеж. Можно увидеть на странице https://intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID" |
Номер СКО | invoiceId | Да | Счёт К Оплате - уникальный номер в системе IntellectMoney, с помощью которого идентифицируется любой платеж. Для получения воспользуйтесь операцией “ Запрос выставления счета ” |
Сумма активационного платежа | activationAmount | Да | Сумма, которая заблокирована у клиента на карте. Сумму блокировки можно узнать в банке, либо из СМС, в случае если услуга поnключена |
CVV2/CVC2 код | cvv | Нет | Секретный код CVV2 (CVC2), как правило написан на обороте карты (последние три цифры на полосе для подписи). Данный параметр должен быть обязательно передан если банковская карта снабжена cvv. Если попытаться оплатить такой картой и не указать cvv, то банк-эквайер вернет ошибку. Максимальная длина - 512 символов. |
Подпись для преданных данных | hash | Да | Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя. Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности: Пример формирования строки eshopId::invoiceId::activationAmount::cvv Далее, к этой строке применяется алгоритм криптографии из пункта ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ |
В ответ возвращается код операции и возможны 3 варианта:
Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <ActivationPayData> (синхронная обработка). ( Код операции - 0 )
Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). ( Код операции - 1 )
Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 2 )
Post /merchant/activationPay/ HTTP/1.1 Host: api.intellectmoney.ru Content-Type: application/x-www-form-urlencoded; charset=utf-8 eshopId=450123 invoiceId=356421216 activationAmount=8.14 hash=dHA6Ly9jcmwuZ2xvYmFsc2lnbi5jb20v3MvZ3Nkb21haW52YWxzaGEyZzIuY3JsMIG
HTTP/1.1 200 OK Content-Type: text/xml <?xml version="1.0" encoding="utf-8"?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OperationState> <Code>0</Code> <Desc>Успешно обработана</Desc> </OperationState> <OperationId>8f6a8487-98a6-4c03-b8b6-904cffd91749</OperationId> <EshopId>700025</EshopId> <Result> <State> <Code>0</Code> <Desc>Успешно обработан</Desc> </State> </Result> </Response>
INNERPAYMENT - ОПЛАТА ВНУТРЕННИМ ПЛАТЕЖОМ
Передача параметров
Для оплаты в системе IntellectMoney необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/merchant/<api_version>/innerpayment
В запросе необходимо передать следующие параметры:
Название | Имя параметра | Обязательный | Описание |
---|---|---|---|
ID магазина | eshopId | Да | Номер магазина в системе IntellectMoney, на который пользователь (покупатель) должен совершить платеж. Можно увидеть на странице https://intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID" |
Номер СКО | invoiceId | Да | Счёт К Оплате - уникальный номер в системе IntellectMoney, с помощью которого идентифицируется любой платеж. Для получения воспользуйтесь операцией “ Запрос выставления счета ” |
Сумма платежа | userToken | Да | Цифровая подпись пользователя (покупателя). Алгоритм получения userToken описан в разделе Как получить userToken |
Пин-код | pinCode | Нет | Код для подтверждения платёжных операций. Указывается пользователем (покупателем) при регистрации на сайте IntellectMoney. Состоит из 4 цифр. |
Подпись для преданных данных | hash | Да | Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя. Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности: Пример формирования строки eshopId::invoiceId::userToken::pinCode Далее, к этой строке применяется алгоритм криптографии из пункта ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ |
В ответ возвращается код операции и возможны 3 варианта:
Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <MerchantServiceData> (синхронная обработка). ( Код операции - 0 )
Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). ( Код операции - 1 )
Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 2 )
Post /merchant/innerPayment/ HTTP/1.1 Host: api.intellectmoney.ru Content-Type: application/x-www-form-urlencoded; charset=utf-8 eshopId=450123 invoiceId=356421216 userToken=BD2rQq%2Fh6P6tUEeSWLb5ur%2BIX3TIKckWjTKzmNwDoUI%3D pinCode=4562 hash=dHA6Ly9jcmwuZ2xvYmFsc2lnbi5jb20v3MvZ3Nkb21haW52YWxzaGEyZzIuY3JsMIG
HTTP/1.1 200 OK Content-Type: text/xml <?xml version="1.0" encoding="utf-8"?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OperationState> <Code>0</Code> <Desc>Успешно обработана</Desc> </OperationState> <OperationId>3cf78bc5-63f4-4fe3-86a0-8ce9d60e8228</OperationId> <EshopId>455551</EshopId> <Result> <State> <Code>0</Code> <Desc>Успешно обработан</Desc> </State> </Result> </Response>
Пример использования
Данный метод переводит денежные средства с кошелька IntellectMoney Пользователя (Покупателя) на кошеле IntellectMoney или Банковскую карту Партнера (Продавца).
- Запрашиваем у Пользователя (Покупателя) Пин-код (pinCode), который он указал при регистрации в системе IntellectMoney.
- Обращаемся к методу innerPayment().
- Проверяем какой статус вернулся в ответ, если (0 - ОК), значит платёж прошел. Если пришел другой статус, проверьте корректность передаваемых полей.
- Сообщаем Пользователю (Покупателю) о завершении оплаты.
GETPOSTPAYBLANK - ПОЛУЧИТЬ БЛАНК ДЛЯ ОПЛАТЫ ПОЧТОВЫМ ПЕРЕВОДОМ
Передача параметров
Для получения бланка оплаты необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/merchant/<api_version>/getpostpayblank
В запросе необходимо передать следующие параметры:
Название | Имя параметра | Обязательный | Описание |
---|---|---|---|
ID магазина | eshopId | Да | Номер магазина в системе IntellectMoney, на который пользователь (покупатель) должен совершить платеж. Можно увидеть на странице https://intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID" |
Номер СКО | invoiceId | Да | Счёт К Оплате - уникальный номер в системе IntellectMoney, с помощью которого идентифицируется любой платеж. Для получения воспользуйтесь операцией “Запрос выставления счета” |
Сумма платежа | amount | Да | Сумма платежа, которую поставщик желает получить от пользователя (покупателя). Сумма должна быть больше нуля, дробная часть отделяется точкой, два знака после точки. Максимальная длина - 13 цифр вместе с десятичными знаками. |
Адрес | address | Нет | Адрес прописки Пользователя (Покупателя). Указывается полностью без сокращений |
Почтовый индекс | postcode | Нет | Почтовый индекс Пользователя (Покупателя). |
Имя покупателя | fio | Нет | Фамилия Имя Отчество Пользователя (Покупателя). Указывается полностью без сокращений. |
ИНН | inn | Нет | Индивидуальный номер налогоплательщика Пользователя (Покупателя). |
Гражданство | residentofrussia | Да | Здесь нужно указать, является ли Пользователь (Покупатель) гражданином РФ или нет. Передать 0, если Пользователь (Покупатель) не является гражданином РФ. |
Серия | series | Да | Серия паспорта Пользователя (Покупателя). |
Номер | number | Да | Номер паспорта Пользователя (Покупателя). |
День выдачи паспорта | day | Нет | Дата выдачи паспорта Пользователя (Покупателя). |
Месяц выдачи пасспорта | month | Нет | |
Год выдачи пасспорта | year | Нет | |
Кем выдан | kem | Нет | Управление выдавшее паспорт. |
Для Пользователя (Покупателя) не резидент РФ, передаются данные о сроке пребывания. | |||
День | beginday | Нет | С какого числа начинает действовать разрешение на работу Пользователя (Покупателя). |
Месяц | beginmonth | Нет | |
Год | beginyear | Нет | |
День | endday | Нет | Срок окончания разрешения работу Пользователя (Покупателя). |
Месяц | endmonth | Нет | |
Год | endyear | Нет | |
Подпись для преданных данных | hash | Да | Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя. Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности: Пример формирования строки eshopId::invoiceId::amount::address::postCode::fio::inn ::residentOfRussia::series::number::day::month::year ::kem::beginDay::beginMonth::beginYear::endDay::endMonth ::endYear Далее, к этой строке применяется алгоритм криптографии из пункта ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ |
В ответ возвращается код операции и возможны 3 варианта:
Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <PostPayBlankData> (синхронная обработка). ( Код операции - 0 )
Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). ( Код операции - 1 )
Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 2 )
Post /merchant/createInvoice/ HTTP/1.1 Host: api.intellectmoney.ru Content-Type: application/x-www-form-urlencoded; charset=utf-8 eshopId=450123 invoiceId=356421216 activationAmount=8.14 hash=dHA6Ly9jcmwuZ2xvYmFsc2lnbi5jb20v3MvZ3Nkb21haW52YWxzaGEyZzIuY3JsMIG
HTTP/1.1 200 OK Content-Type: text/xml <?xml version="1.0" encoding="utf-8"?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OperationState> <Code>0</Code> <Desc>Успешно обработана</Desc> </OperationState> <OperationId>3cf78bc5-63f4-4fe3-86a0-8ce9d60e8228</OperationId> <EshopId>455551</EshopId> <Result> <State> <Code>0</Code> <Desc>Успешно обработан</Desc> </State> <PostPayBlank> iVBORw0KGgoAAAANSUhEUgAABHQAAASkCAI... </PostPayBlank> </Result> </Response>
Пример использования
Данный метод возвращает изображение готового бланк для оплаты в отделениях почты России. Изображение возвращается в виде строки (data:image/png;base64). Если обязательные поля не заполнить, то и в бланке они не будут заполнены и в момент перевода могут возникнуть проблемы, например: Пользователь (Покупатель) не является резидентом, тогда при не заполненных полях о сроке пребывания кассир потребует заполнить данные поля.
- Запрашиваем у Пользователя (Покупателя) личные данные.
- Обращаемся к методу getPostPayBlank().
- Получаем в ответ изображение бланка для оплаты в отделениях почты России, обрабатываем полученный код "data:image/png;base64,{полученный код}" и отображаем получившееся изображение Пользователю (Покупателю).
- Пользователь (Покупатель) распечатывает бланк или заполняет чистый бланк,который можно получить в отделениях почты России.
- Пользователь (Покупатель) идет с бланком в отделение почты России и производит оплату.
Вы можете отслеживать состояние счета методом getPurchaseInfo (надо обязательно передать номер платежа), когда в State из <InvoiceData> будет в статусе Paid=2 Полностью оплачен значит платеж завершен.
ОПЛАТА ЧЕРЕЗ ОБМЕННИКИ
Альфа-Клик
Для оплаты через Альфа-Клик необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/merchant/<api_version>/alfaclickpayment
Сбербанк Онлайн
Для оплаты через Сбербанк Онлайн необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/merchant/<api_version>/sberbankpayment
Яндекс.Деньги
Для оплаты через Яндекс.Деньги необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/merchant/<api_version>/yandexpayment
WebMoney
Для оплаты через Yandex.Money необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/merchant/<api_version>/wmrpayment
QIWI Кошелёк
Для оплаты через QIWI Кошелёк необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/merchant/<api_version>/qiwipursepayment
В запросе необходимо передать следующие параметры из таблицы
Название | Имя параметра | Обязательный | Методы, в которых данный параметр является обязательным | Описание |
---|---|---|---|---|
ID магазина | eshopId | Да | Во всех | Номер магазина в системе IntellectMoney, на который пользователь (покупатель) должен совершить платеж. Можно увидеть на странице https://intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID" |
Номер СКО | invoiceId | Да | Во всех | Счёт К Оплате - уникальный номер в системе IntellectMoney, с помощью которого идентифицируется любой платеж. Для получения воспользуйтесь операцией “ Запрос выставления счета ” |
Адрес удачного платежа | successUrl | Не использовать, если не является обязательным | alfaclickpayment, wmrpayment, qiwipursepayment | Адрес, на который будет перенаправлен пользователь (покупатель) в случае успешной оплаты |
Адрес не удачного платежа | failUrl | Не использовать, если не является обязательным | wmrpayment, qiwipursepayment | Адрес, на который будет перенаправлен пользователь (покупатель) в случае не успешной оплаты |
Дополнительные параметры | additionalParams | Не использовать, если не является обязательным | qiwipursepayment | Дополнительные параметры.Строка вида "to=+39106231449|from=+569323442", где: "|" - разделитель между параметрами, "=" разделитель в паре ключ-значение. |
Подпись для преданных данных | hash | Да | Во всех | Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя. Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности: Пример формирования строки eshopId::invoiceId::successUrl::failUrl ::additionalParams Далее, к этой строке применяется алгоритм криптографии из пункта ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ |
В ответ возвращается код операции и возможны 3 варианта:
Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <ExchangerPaymentData> (синхронная обработка). ( Код операции - 0 )
Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). ( Код операции - 1 )
Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 2 )
Post /merchant/createInvoice/ HTTP/1.1 Host: api.intellectmoney.ru Content-Type: application/x-www-form-urlencoded; charset=utf-8 eshopId=450123 invoiceId=356421216 successUrl=http://Ваш_сайт/successUrl.php failUrl=http://Ваш_сайт/failUrl.php additionalParams=to=+791085488 hash=dHA6Ly9jcmwuZ2xvYmFsc2lnbi5jb20v3MvZ3Nkb21haW52YWxzaGEyZzIuY3JsMIG
HTTP/1.1 200 OK Content-Type: text/xml <?xml version="1.0" encoding="utf-8"?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OperationState> <Code>0</Code> <Desc>Успешно обработана</Desc> </OperationState> <OperationId>3cf78bc5-63f4-4fe3-86a0-8ce9d60e8228</OperationId> <EshopId>455551</EshopId> <Result> <State> <Code>0</Code> <Desc>Успешно обработан</Desc> </State> <PostPayBlank> iVBORw0KGgoAAAANSUhEUgAABHQAAASkCAI... </PostPayBlank> </Result> </Response>
ПОЛУЧИТЬ ИНФОРМАЦИЮ О ПЛАТЕЖЕ/МАГАЗИНЕ
Передача параметров
Для получения информации о платеже (платежах) необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/merchant/<api_version>/getpurchaseinfo
В запросе необходимо передать следующие параметры:
Название | Имя параметра | Обязательный | Описание |
---|---|---|---|
ID магазина | eshopId | Да, если не передан invoiceId | Номер магазина в системе IntellectMoney, на который пользователь (покупатель) должен совершить платеж. Можно увидеть на странице https://intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID". |
Номер СКО | invoiceId | Да, если не передан eshopId | Счёт К Оплате - уникальный номер в системе IntellectMoney, с помощью которого идентифицируется любой платеж. Для получения воспользуйтесь операцией “ Запрос выставления счета ”. |
Способ оплаты | inputType | Нет | Способ, которым оплачивался СКО. Если данный параметр передан вместе с invoiceId, будет показана сумма к оплате с учётом комиссии, если таковая имеется. |
Подпись для преданных данных | hash | Да | Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя. Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности: Пример формирования строки eshopId::invoiceId::inputType Далее, к этой строке применяется алгоритм криптографии из пункта ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ |
В ответ возвращается код операции и возможны 3 варианта:
Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <PurchaseInfoData> (синхронная обработка). ( Код операции - 0 )
Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). ( Код операции - 1 )
Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 2 )
Post /merchant/getPurchaseInfo/ HTTP/1.1 Host: api.intellectmoney.ru Content-Type: application/x-www-form-urlencoded; charset=utf-8 eshopId=455551 invoiceId=3486654395 inputType= hash=58c16afcaac298dda6d84b7a3bd476da
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OperationState> <Code>0</Code> <Desc>Успешно обработана</Desc> </OperationState> <OperationId>974a1029-07f5-4797-ae12-f104101fa6b6</OperationId> <EshopId>455551</EshopId> <Result> <State> <Code>0</Code> <Desc>Успешно обработан.</Desc> </State> <Invoice> <InvoiceId>3486654395</InvoiceId> <LeftToPayAmount> <Amount>10.0000</Amount> <Currency>RUB</Currency> </LeftToPayAmount> <TotalAmount> <Amount>10.0000</Amount> <Currency>RUB</Currency> </TotalAmount> <OrderId>1498651094</OrderId> <Name>test</Name> <State>Created</State> <CreationDate>2017-06-28T15:06:21.777</CreationDate> <ChangeDate>2017-06-28T15:06:21.777</ChangeDate> <UserEmail>s.zhukov+1@intellectmoney.ru</UserEmail> </Invoice> <Eshop> <EshopId>455551</EshopId> <Name>bookshop</Name> <Url>http://test1.ru/</Url> <TemplateId>1</TemplateId> </Eshop> <SuccessUrl>https://successurl.ru</SuccessUrl> <BackUrl>http://backurl.ru</BackUrl> <FormType xsi:nil="true"/> </Result> </Response>
АСИНХРОННЫЕ ОПЕРАЦИИ
Для получения результата по операциям, обработка по которым была поставлена в очередь необходимо отправить GET- или POST-запрос на URL по целевым методам, добавив в окончание адреса “State”:
https://api.intellectmoney.ru/merchant/<api_version>/createinvoicestate
https://api.intellectmoney.ru/merchant/<api_version>/bankcardpaymentstate
https://api.intellectmoney.ru/merchant/<api_version>/getbankcardpaymentstate
https://api.intellectmoney.ru/merchant/<api_version>/activationpaystate
https://api.intellectmoney.ru/merchant/<api_version>/getpurchaseinfostate
https://api.intellectmoney.ru/merchant/<api_version>/getpaymentwaysstate
В запросе к любому методу необходимо передать следующие параметры:
Название | Имя параметра | Обязательный | Описание |
---|---|---|---|
ID магазина | eshopId | Да | Номер магазина в системе IntellectMoney, на который пользователь (покупатель) должен совершить платеж. Можно увидеть на странице https://intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID" |
Операция | operationId | Да | Идентификатор операции, по которой Вы хотите получить информацию |
Подпись для преданных данных | hash | Да | Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя. Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности: Пример формирования строки eshopId::operationId Далее, к этой строке применяется алгоритм криптографии из пункта ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ |
В ответ возвращается код операции и возможны 3 варианта:
Запрос обработался. Ответ типа <Response> будет содержать структуру одного из методов. ( Код операции - 0 )
Запрос еще находится в очереди на обработку. Нужно запросить статус позже. ( Код операции - 1 )
Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 2 )
ИНТЕРФЕЙС УВЕДОМЛЕНИЙ ПРОВАЙДЕРА
В протоколе предусмотрена стандартная возможность получения провайдером уведомлений о статусе платежа. Если в настройках магазина в личном кабинете IntellectMoney выбран протокол IntellectMoney, то данные передаются в соответствии с п.3.2.2. Форма оповещения о платеже протокола IntellectMoney . Если в настройках магазина в личном кабинете IntellectMoney выбран протокол WebMoney, то данные передаются в соответствии с п.3.3.3. Форма оповещения о платеже протокола WebMoney . Какой протокол указан можно посмотреть на странице https://intellectmoney.ru/ru/enter/options/ps_organization_shop/ в столбце “Протокол“.
ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ
К строке для подписи (сформированной по правилам формирования подписи отдельного метода) в конец добавляется параметр “Секретный ключ ( secretKey )” из настроек магазина ЛК IntellectMoney через разделитель “::“, после чего к итоговой строке применяется хеш-функция MD5, результат работы который считается подписью запроса.
КАК ПОЛУЧИТЬ userToken
Для получения userToken нужно перенаправить пользователя (покупателя) на страницу https://intellectmoney.ru/ru/enter/ с параметрами:
Параметр | Описание |
---|---|
returnUrl | URL куда перенаправить пользователя (покупателя) после регистрации, на данный URL будет перед userToken методом get. |
email пользователя (покупателя) |
После того, как пользователь (покупатель) авторизуется, он будет перенаправлен на страницу указанную в returnUrl с параметром UserToken.
Пример:https://<Ваш_сайт>/returnUrl.php?&userToken=5a8WAwjuOb5g7P5VGdmxSt2ogNCysC7UirnQDmWFNP4%3D
ТИПЫ ДАННЫХ
<Response>
Поле | Тип | Описание |
---|---|---|
OperationState | <OperationState> | Статус выполнения операции |
OperationId | GUID | Идентификатор операции |
EshopId | int | ID магазина |
Result | MethodResult | Результат выполнения запроса. Зависит от типа запроса. В случае асинхронной обработки запроса данного поля не будет. |
<OperationState>
Поле | Тип | Описание |
---|---|---|
Code | int | |
Desc | string | Описание кода статуса выполнения запроса |
<CreateInvoiceData>
Поле | Тип | Описание |
---|---|---|
State | <RequestState> | |
InvoiceId | long | Номер выставленного СКО |
<BankCardData>
Поле | Тип | Описание |
---|---|---|
State | <RequestState> | |
PaymentStep | <PaymentStep> | |
Message | string | Текстовое представление последнего статуса операции в банке (RC) |
Form3DS | string | Обычно это html, выданный эмитентом для прохождения процедуры прохождения 3ds |
<ActivationPayData>
Поле | Тип | Описание |
---|---|---|
State | <RequestState> |
<PaymentWayListData>
Поле | Тип | Описание |
---|---|---|
State | <RequestStata> | Статусы выполнения запросов |
PaymentWays | <PaymentWayData> | Описание возвращаемых параметров |
<PaymentWayData>
Поле | Тип | Описание |
---|---|---|
Id | int | Уникальный идентификатор способа оплаты |
Amount | <Money> | |
InputType | <InputType> | Способы оплаты |
PreferenceTypes | <PreferenceTypeSpecification> | Способ оплаты |
ServiceTimeOfEnrollmentType | <MerchantServiceTimeOfEnrollmentType> | Сроки зачисления |
Commission | decimal | Сумма комиссии |
<Money>
Поле | Тип | Описание |
---|---|---|
Amount | decimal | Статусы выполнения запросов |
Currency | <Currency> | Описание возвращаемых параметров |
<MerchantServiceData>
Поле | Тип | Описание |
---|---|---|
State | <RequestState> |
<PostPayBlankData>
Поле | Тип | Описание |
---|---|---|
State | <RequestStata> | Статусы выполнения запросов |
PostPayBlank | String | Возвращает строку для вставки в html. Пример обработки данной строки, где {$PostPayBlank} результат запроса: Пример кода <img class="printed__img" src="data:image/png;base64,{$PostPayBlank}"> <script> var PostPayBlank = "data:image/png;base64,{$PostPayBlank}"; </script> |
<ExchangerData>
Поле | Тип | Описание |
---|---|---|
State | <RequestState> | |
ExchangerData | <ExchangerPaymentData> | Информация о способе оплаты |
<ExchangerPaymentData>
Поле | Тип | Описание |
---|---|---|
ExchangeCurrency | string | Валюта оплаты |
ExchangeAmount | string | Сумма оплаты |
RedirectToUrl | string | Адрес, куда отправлять запрос |
ExchangeState | Enum | Состояние способа оплаты. OK - способ работает ERROR - способ не работает |
IsNewWindow | String | Если true, отображение в новом окне. Если false, отображается в том же окне |
FormFields | Array[ключ, значение] | Поля для формы которые надо заполнить |
ShowFields | Array[ключ, значение] | Поля для отображения информации |
Method | <UrlMethod> | Способ которым будет происходить процесс оплаты. Подробнее смотрите в разделе <UrlMethod>. |
<ExchangerData>
Поле | Тип | Описание |
---|---|---|
State | <RequestState> | |
Invoice | <InvoiceData> | Информация о способе оплаты |
Eshop | <EshopData> | Информация о магазине |
SuccessUrl | string | Строка с url, куда пользователя перенаправят после успешной оплаты |
BackUrl | string | Строка с url, куда перенаправят покупателя после оплаты |
FormType | <UserPaymentFormType> | Настройка для физиков, если true деньги зачисляются на карту (перевод на карту), если false деньги зачисляются в личный кошелек (в кошелек IntellectMoney) |
<InvoiceData>
Поле | Тип | Описание |
---|---|---|
InvoiceId | long | Номер СКО, по которому была найдена информация |
LeftToPayAmount | Money | В узле <LeftToPayAmount> сумма СКО к оплате, если счёт ежу оплачен покажет 0. |
TotalAmount | Money | В узле <TotalAmount> сумма с учётом комиссии для указанного способа оплаты , если счёт уже оплачен покажет 0 . |
OrderId | string | Внутренний номер покупки поставщика |
Name | string | Описание товара или услуги. Соответствует serviceName |
State | <InvoiceState> | Статус СКО, подробное описание перечислителя смотрите ниже |
CreateionDate | DateTime | Дата создания СКО |
ChangeDate | DateTime | Дата последних изменений СКО |
UserEmail | string | Email указанный покупателем. Соответствует пол. |
<EshopData>
Содержит информацию о магазине
Поле | Тип | Описание |
---|---|---|
EshopId | int | Номер магазина в системе IntellectMoney |
Name | string | Название магазина |
Description | string | Описание магазина |
Url | string | Сайт магазина |
string | Email, на который отправляются оповещения | |
Phone | string | Номер телефона магазина |
WorkTime | string | Время работы магазина |
TemplateId | int | Версия страницы оплаты |
ПЕРЕЧИСЛЕНИЯ
Коды операций
Код ошибки | Описание |
---|---|
0 | Успешно обработана |
1 | В процессе выполнения |
2 | Ошибка |
Статусы запросов
Код ошибки | Описание |
---|---|
0 | Успешно обработан |
1 | Ошибка сервера |
2 | Не защищенное соединение. Отправляйте запрос по https |
50 | Ошибка. Счет уже был оплачен ранее |
150 | Ошибка. Параметр eshopId передан неверно |
151 | Ошибка. Параметр invoiceId передан неверно |
152 | Ошибка. Обязательно должен быть передан либо eshopId либо invoiceId |
153 | Ошибка. Параметр inputType передан неверно |
154 | Ошибка. Не передан обязательный параметр hash или передан неверно |
155 | Ошибка. Не передан обязательный параметр amount или передан неверно |
156 | Ошибка. Параметр preferences передан неверно |
157 | Ошибка. Не передан обязательный параметр recipientAmount или передан неверно |
158 | Ошибка. Не передан обязательный параметр recipientCurrency или передан неверно |
159 | Ошибка. Не передан обязательный параметр email или передан неверно |
160 | Ошибка. Параметр serviceName передан неверно |
161 | Ошибка. Не передан обязательный параметр userName или передан неверно |
162 | Ошибка. Параметр successUrl передан неверно |
163 | Ошибка. Параметр failUrl передан неверно |
164 | Ошибка. Параметр backUrl передан неверно |
165 | Ошибка. Параметр resultUrl передан неверно |
166 | Ошибка. Параметр returnUrl передан неверно |
167 | Ошибка. Параметр expireDate передан неверно |
168 | Ошибка. Параметр holdMode передан неверно |
169 | Ошибка. Параметр(ы) userFields передан(ы) неверно |
170 | Ошибка. Не передан обязательный параметр orderId или передан неверно |
200 | Ошибка. Не передан обязательный параметр pinCode или передан неверно |
201 | Ошибка. Не передан обязательный параметр userToken или передан неверно |
202 | Ошибка. Данный счет не принадлежит владельцу кошелька IntellectMoney |
203 | Ошибка. В кошельке IntellectMoney нет подходящего счета с нужной валютой |
204 | Ошибка. Для проведения оплаты необходимо пройти идентификацию в личном кабинете IntellectMoney |
205 | Ошибка. Превышен лимит на оплату для кошелька IntellectMoney |
250 | Ошибка. Не передан обязательный параметр pan или передан неверно. |
251 | Ошибка. Не передан обязательный параметр cvv или передан неверно |
252 | Ошибка. Не передан обязательный параметр cardHolder или передан неверно |
253 | Ошибка. Не передан обязательный параметр expiredYear или передан неверно |
254 | Ошибка. Не передан обязательный параметр expiredMonth или передан неверно |
255 | Ошибка. Не передан обязательный параметр activationAmount или передан неверно |
256 | Ошибка. Карта плательщика заблокирована. |
257 | Ошибка. Счет в неверном статусе. Оплата не возможна. |
258 | Ошибка. Есть не завершенные платежи. Дождитесь обработки. |
259 | Ошибка. Платеж запрещен. |
300 | Ошибка. Неверно передан параметр Pparameter. |
301 | Ошибка. Неверно передан параметр inn. |
302 | Ошибка. Неверно передан параметр residentofrussia. |
303 | Ошибка. Неверно передан параметр series. |
304 | Ошибка. Неверно передан параметр number. |
Статусы платежа
Код ошибки | Описание |
---|---|
0 | Успешно завершен (Счет оплачен) |
1 | Создан |
2 | В обработке |
3 | Отправлен на 3DS |
4 | Отправлен на активационный платеж |
10 | Ошибка платежа |
Название группы | Описание |
---|---|
All | Все |
Popular | Популярные |
Online | Онлайн |
NonComission | Без комиссии |
Flash | Мгновенные |
Сроки зачисления
Название | Описание |
---|---|
None | До 30 рабочих дней |
Flash | Мгновенно |
FiveDays | До 5 рабочих дней |
ThreeDays | До 3 рабочих дней |
Способы оплаты
InputType | Описание |
---|---|
InnerPayment | Внутренний перевод |
Acquiring | Оплата с банковской карты |
BankRF | Банковский перевод |
WMR | WebMoney |
Yandex | Яндекс.Деньги |
QiwiPurse | QIWI Кошелёк |
AlfaClickPayU | Альфа-Клик |
IBank | Интернет банкинг |
Bankomats | В банкоматах |
Terminals | В терминалах |
RapidaOnline | RapidaOnline |
GoogleADS | GoogleADS |
PostPay | Через почту РФ |
Mvideo | Mvideo |
QBank | QBank через Rapida |
SberBank | Сбербанк Онлайн |
AlfaClick | АльфаКлик |
Euroset | В салонах Евросеть |
Svyaznoy | В салонах Связной |
Метод проведения оплаты через обменники
< UrlMethod > | Описание |
---|---|
POST | Данные на обменник передаются POST-ЗАПРОСОМ, после чего происходит оплата |
GET | Данные на обменник передаются GET-ЗАПРОСОМ, после чего происходит оплата |
LINK | Возвращает ссылку |
REDIRECT | Означает что пользователя надо перенаправить |
STATIC | Перенаправление не требуется |
IFRAME | Данные возвращаются в IFrame, где и происходит оплата |
Состояния СКО
InvoiceState | Описание |
---|---|
Created | Создан |
PartPaid | Частично оплачен |
Paid | Полностью оплачен |
ToPaid | В процессе обработки |
Refund | Возврат |
Held | Захолдирован |
Разница в версиях API
Документация описывает последнюю версию API.
Latest | В методе CreateInvoice появились новые не обязательные параметры: resultUrl, UserFieldName_N, purchaseHash. Метод PayInvoiceBankCard переименован в BankCardPayment. Метод CheckInvoice переименован в GetBankCardPaymentState. В методе ActivationPay стал не обязательным параметр cvv. Появились новые методы:
|
v1 | Начальная версия |
- No labels