Техническая поддержка

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

ВЫСТАВЛЕНИЕ СЧЁТА

Запрос выставления счёта

Для выставления счета необходимо отправить GET- или POST-запрос на следующий адрес URL

https://api.intellectmoney.ru/merchant/createInvoice

В запросе необходимо передать следующие параметры:

 

НазваниеИмя параметраОбязательныйОписание

ID магазина

eshopId

Да

Номер сайта интернет-магазина, на который пользователь (покупатель) должен совершить платеж. Можно увидеть на странице   https://www.intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID"

Внутренний номер покупки интернет-магазина

orderId

Да

В этом поле интернет-магазин задает номер покупки в соответствии со своей системой учета. Уникальный номер для каждого платежа.

Максимальная длина - 50 символов.

Назначение платежа

serviceName

Нет

Описание товара или услуги. Формируется интернет-магазином.

Максимальная длина - 1024 символов.

Сумма

платежа

recipientAmount

Да

Сумма платежа, которую Интернет-магазин желает получить от пользователя (покупателя). Сумма должна быть больше нуля, дробная часть отделяется точкой, два знака после точки.

Максимальная длина - 13 цифр вместе с десятичными знаками.

Валюта

платежа

recipientCurrency

Да

Валюта платежа. Может принимать значения: RUB и RUR для  платежей в рублях и TST для тестовых платежей

Имя Пользователя

userName

Нет

Полное имя пользователя (покупателя). Вводится самим пользователем (покупателем).

Максимальная длина – 255 символов.

E-mail пользователя

email

Да

Email пользователя (покупателя).

Максимальная длина – 100 символов.

Адрес удачного платежа

successUrl

Нет

Адрес, на который будет перенаправлен пользователь (покупатель) в случае успешной оплаты

Максимальная длина - 512 символов.

Адрес не удачного платежаfailUrl

Нет

Адрес, на который будет перенаправлен пользователь (покупатель) в случае не успешной оплаты

Максимальная длина - 512 символов.

Адрес окончания платежаbackUrl

Нет

Адрес, на который будет перенаправлен пользователь (покупатель) при выборе не моментального способа оплаты

Максимальная длина - 512 символов.

АдресresultUrl

Нет

Адрес, на который система IntellectMoney посылает HTTP/S POST запросы об изменении состояния СКО

Максимальная длина - 512 символов.

Дата и время истечения срока блокировки

expireDate

Нет

Дата и время, через которое заблокированные средства зачислятся на счет магазина, либо будут возвращены пользователю (формат “yyyy-MM-dd HH:mm:ss”). Используется в случае использования блокировки (холдирования) средств на СКО.

Режим холдирования

holdMode

Нет

Устанавливает режим холдированного счета.
Boolean (1 или 0) 

Способ оплаты

preference

Нет

Способы оплаты, которые будут доступны для выбора при оплате покупки. В случае указания одного параметра пользователь будет перенаправлен на страницу ввода реквизитов. (при задании параметра  bankCard и указании email пользователя,  пользователь перейдет сразу к вводу номера банковской карты, при этом счёт уже будет создан. В случае, если не указан email ,то пользователь будет перенаправлен на страницу ввода email)

Подробное описание доступно по ссылке

Дополнительные параметры интернет-магазина

Определяется интернет-магазином

Нет

Все поля формы, имеющие в названии префикса "userField_N", "userFieldName_N" (где N порядковый номер), обрабатываются системой IntellectMoney автоматически и передаются на сайт интернет-магазина.

Максимальная длина всех дополнительных полей в сумме - 4000 символов

Подпись для преданных данных

hash

Да

Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя.

Алгоритм формирования описан в разделе " Подпись запроса выставления счета ".

В ответ возвращается  код операции  и возможны 3 варианта:

  1. Запрос обработался моментально. Ответ типа  <Response>  будет содержать структуру  <CreateInvoiceResult>  (синхронная обработка). (  Код операции - 0  )

  2. Запрос был поставлен в очередь на обработку. Ответ типа  <Response>  будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). (  Код операции - 1  )

  3. Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 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>

 

Подпись запроса выставления счёта

Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности:

eshopId::orderId::serviceName::recipientAmount::recipientCurrency

Далее, к этой строке применяется алгоритм криптографии из пункта    ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ

ПЕРЕДАЧА РЕКВИЗИТОВ БАНКОВСКОЙ КАРТЫ

Запрос регистрации реквизитов

Для передачи реквизитов банковской карты и для дальнейшей оплаты счета необходимо отправить GET- или POST-запрос на следующий адрес URL:

https://api.intellectmoney.ru/merchant/payInvoiceBankCard

В запросе необходимо передать следующие параметры: 

 

Название

Имя параметра

Обязательный

Описание

ID магазина

eshopId

Да

Номер сайта интернет-магазина, на который пользователь (покупатель) должен совершить платеж.

Номер СКО

invoiceId

Да

СКО, в пользу которого производится попытка полаты, полученный операцией “ Запрос выставления счета ”

Номер карты плательщика

pan

Да

Номер карты плательщика

Дрежатель карты

cardHolder

Нет

Имя и фамилия плательщика карты

Срок действия месяц

expiredMonth

Да

Месяц, до которого действует карта

Срок действия год

expiredYear

Да

Год, до которого действует карта

CVV2/CVC2 код

cvv

Нет

CVV2 (CVC2) как правило написан на обороте карты (последние три цифры на полосе для подписи).

Максимальная длина - 512 символов.

Подпись для преданных данных

hash

Да

Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя.

Алгоритм формирования описан в разделе " Подпись запроса передачи данных карты ".

В ответ возвращается код операции и возможны 3 варианта:

  1. Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <PayInvoiceBankCardResult> (синхронная обработка). ( Код операции - 0 )
  2. Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). ( Код операции - 1 )
  3. Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 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
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>

Подпись запроса передачи данных карты

Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности:

eshopId::invoiceId::pan::cardHolder::expiredMonth::expiredYear::cvv

Далее, к этой строке применяется алгоритм криптографии из пункта   ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ

Состояние платежа

Запрос состояния платежа

Для запроса состояния оплаты счета необходимо отправить GET- или POST-запрос на следующий адрес URL:

https://api.intellectmoney.ru/merchant/GetBankCardPaymentState

В запросе необходимо передать следующие параметры:

 

Название

Имя параметра

Обязательный

Описание

ID магазина

eshopId

Да

Номер сайта интернет-магазина, на который пользователь (покупатель) должен совершить платеж.

Номер СКО

invoiceId

Да

СКО, в пользу которого производится попытка полаты, полученный операцией “Запрос выставления счета”

Подпись для преданных данных

hash

Да

Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя.

Алгоритм формирования описан в разделе "Подпись запроса состояния платежа".

В ответ возвращается код операции и возможны 3 варианта:

  1. Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <ActivationPayResult> (синхронная обработка). (Код операции - 0)

  2. Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). (Код операции - 1)

  3. Ошибка обработки операции. Операция выполнена не будет. (Код операции - 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>8f6a8487-98a6-4c03-b8b6-904cffd91749</OperationId>
	<EshopId>700025</EshopId>
	<Result>
		<State>
			<Code>0</Code>
			<Desc>Успешно обработан</Desc>
		</State>
	</Result>
</Response>

Подпись запроса состояния платежа

Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности:

eshopId::invoiceId

Далее, к этой строке применяется алгоритм криптографии из пункта  ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ

Активационный платёж

Передача параметров платежа

Для заверщения активационного платежа необходимо отправить GET- или POST-запрос на следующий адрес URL:

https://api.intellectmoney.ru/merchant/activationPay

В запросе необходимо передать следующие параметры:

 

Название

Имя параметра

Обязательный

Описание

ID магазина

eshopId

Да

Номер сайта интернет-магазина, на который пользователь (покупатель) должен совершить платеж.

Номер СКО

invoiceId

Да

СКО, в пользу которого производится попытка полаты, полученный операцией “Запрос выставления счета”

Сумма активационного платежа

activationAmount

Да

Сумма, которая заблокирована у клиента на карте.

Сумму блокировки можно узнать в банке, либо из СМС, в случае если услуга поключена

CVV2/CVC2 код

cvv

Нет

CVV2 (CVC2) как правило написан на обороте карты (последние три цифры на полосе для подписи).

Подпись для преданных данных

hash

Да

Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя.

Алгоритм формирования описан в разделе "Подпись запроса активационного платежа".

В ответ возвращается код операции и возможны 3 варианта:

  1. Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <ActivationPayResult> (синхронная обработка). (Код операции - 0)

  2. Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). (Код операции - 1)

  3. Ошибка обработки операции. Операция выполнена не будет. (Код операции - 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>8f6a8487-98a6-4c03-b8b6-904cffd91749</OperationId>
	<EshopId>700025</EshopId>
	<Result>
		<State>
			<Code>0</Code>
			<Desc>Успешно обработан</Desc>
		</State>
	</Result>
</Response>

Подпись запроса активационного платежа

Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности:

eshopId::invoiceId::activationAmount::cvv

Далее, к этой строке применяется алгоритм криптографии из пункта  ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ

АСИНХРОННЫЕ ОПЕРАЦИИ

Для получения результата по операциям, обработка по которым была поставленна в очередь необходимо отправить GET- или POST-запрос на URL по целевым методам, добавив в окончание адреса “State”:

https://api.intellectmoney.ru/merchant/createInvoiceState

https://api.intellectmoney.ru/merchant/payInvoiceBankCardState

https://api.intellectmoney.ru/merchant/checkInvoiceState

https://api.intellectmoney.ru/merchant/activationPayState


В запросе к любому методу необходимо передать следующие параметры:

 

Название

Имя параметра

Обязательный

Описание

ID магазина

eshopId

Да

Номер сайта интернет-магазина, на который пользователь (покупатель) должен совершить платеж.

Операция

operationId

Да

Идентификатор операции

Подпись для преданных данных

hash

Да

Контрольная подпись запроса, которая используется для проверки целостности полученной от магазина информации и однозначной идентификации отправителя.

Алгоритм формирования описан в разделе "Подпись запроса активационного платежа".

В ответ возвращается код операции и возможны 3 варианта:

  1. Запрос обработался. Ответ типа <Response> будет содержать структуру одного из методов. (Код операции - 0)

  2. Запрос еще находится в очереди на обработку. Нужно запросить статус позже. (Код операции - 1)

  3. Ошибка обработки операции. Операция выполнена не будет. (Код операции - 2)

Подпись запроса статуса асинхронной операции

Строка для подписи получается путем конкатенации параметров с разделителем “::“ и формируется из следующих параметров в строгой последовательности:

eshopId::guid

Далее, к этой строке применяется алгоритм криптографии из пункта  ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ

ИНТЕРФЕЙС УВЕДОМЛЕНИЙ ПРОВАЙДЕРА

В протоколе предусмотрена стандартная возможность получения провайдером уведомлений о статусе платежа. Если в настройках магазина в личном кабинете IntellectMoney выбран протокол IntellectMoney, то данные передаются в соответствии с п.3.2.2. Форма оповещения о платеже протокола IntellectMoney. Если в настройках магазина в личном кабинете IntellectMoney выбран протокол WebMoney, то данные передаются в соответствии с п.3.3.3. Форма оповещения о платеже протокола WebMoney. Какой протокол указан можно посмотреть на странице https://intellectmoney.ru/ru/enter/options/ps_organization_shop/ в столбце “Протокол“.

ФОРМИРОВАНИЕ КОНТРОЛЬНОЙ ПОДПИСИ



  • No labels