ИСПОЛЬЗОВАНИЕ API

Данное API позволит Вам выставить счёт, контролировать состояние счёта, отправлять пользователя (покупателя) на выбранный способ оплаты или получить необходимые данные для оплаты.  Взаимодействие между сервером IntellectMoney и сайтом поставщика (далее поставщика) происходит по HTTP-протоколу.

Перечисленные в данной статье методы, доступны только для аккаунтов организаций, если у Вас аккаунт физического лица, вы можете отредактировать и установить модуль для CMS или воспользоваться PeerToPeer (P2P) API.

БИЗНЕС СХЕМА

Примерная схема взаимодействия системы IntellectMoney, Интернет-магазина и Покупателя (данная схема не является обязательно обязательной и служит только для демонстрации):

Image Modified

1. Покупатель оформляет заказ: вводит персональные данные, выбирает способ доставки и так далее.
2. После того как пользователь отправил персональные данные, система Интернет-магазина получает доступные (активные) магазину способы оплаты, использую используя метод getpaymentways getPaymentWays().
   Этот шаг можно пропустить, если способ оплаты выбирается на шаге 1.
   Этот шаг можно выполнить после выставления счёта к оплате.
   Это шаг можно пропустить, если есть четкое понимание каким способом будет проводиться оплата.
   Этот шаг можно выполнить до шага 1. 
3. Система IntellectMoney возвращает в систему магазина все доступные (активные) способы оплаты. Система Интернет-магазина предлагает пользователю выбрать способ оплаты.
   Данный шаг выполняется всегда, когда выполняется шаг 2.
4. Покупатель выбирает способ оплаты.
   Этот шаг можно пропустить, если способ оплаты выбирается на шаге 1 или   есть четкое понимание каким способом будет проводиться оплата.
   
5. Система Интернет-магазина показывает информацию о выбранном способе оплаты, предлагает подтвердить согласие с условиями и прочее.
   Этот шаг можно пропустить, если способ оплаты выбирается на шаге 1 или   есть четкое понимание каким способом будет проводиться оплата.
   
6. Покупатель заполняет какие-либо поля, выполняет инструкции.
   Этот шаг можно пропустить, если способ оплаты выбирается на шаге 1 или   есть четкое понимание каким способом будет проводиться оплата.
7. Система Интернет-магазина, на основании выбранного способа оплаты, выставляет счёт к оплате через метод createinvoice createInvoice().
8. Система IntellectMoney возвращает в систему магазина номер созданного счёта к оплате - invoiceId.
9. Система Интернет-магазина вызывает метод оплаты в зависимости от выбранного способа оплаты.
10. Система IntellectMoney возвращает всю необходимую информацию для проведения оплаты.
11. Система Интернет-магазина отображает покупателю информацию об оплате. 
12. Если был выбран не моментальный способ оплаты, например почтой России, то пользователь асинхронно оплачивает покупку, сделанную в Интернет магазине.
13. Когда деньги поступили на счёт, система IntellectMoney оповещает систему Интернет-магазина, посредством отправки формы оповещения (см. протокол IntellectMoney) на URL оповещения о платеже - Result URL.
14. Если был выбран моментальный способ оплаты. Пользователь заполняет поля, производит необходимые действия и отправляет эти данные в систему Интернет-магазина.
15. Система Интернет-магазина, в зависимости от выбранного способа оплаты, отображает форму для ввода 3-DS пароля или переводит Покупателя на страницу личного кабинета(напр. Сбербанк, AlfaClick и др.).
16. Если был выбран способ оплаты через обменники (exchangers - AlfaClick, Qiwi и т.д.), пользователь завершает оплату в личном кабинете обменника.
17. Когда деньги поступили на счёт, система IntellectMoney оповещает систему Интернет-магазина, посредством отправки формы оповещения (см. протокол IntellectMoney) на URL оповещения о платеже - Result URL.
18. Система Интернет-магазина показывает страницу с сообщением об успешной оплате, если это требуется.

После того как Система Интернет-магазина получила ID счета к оплате (invoiceId), можно получить информацию по данному счету к оплате, через метод getPuschaseInfo getPurchaseInfo(). Через этот метод дополнительно можно получить информацию о настройках магазина в системе 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 нужно выполнить POST- запрос на URL, который состоит из следующих частей: host(https://api.intellectmoney.ru/merchant/)+номер версии API(<api_version>) + название метода к которому идёт обращение (createinvoice).

Номер версии API(<api_version>) - может иметь следующий формат: "v1.0", "v2.0", "latest".

Пример:

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

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

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

Список всех доступных версий с описанием доступны в разделе "Разница в версиях API".

ПОРЯДОК ВЫЗОВА МЕТОДОВ

Работу с представленным API можно разделить на 2 шага:

1. Выставляем счёт к оплате посредством метода createInvoice(). После того как счёт выставлен, его состояние можно отслеживать через метод getPurchaseInfo().
2. Если нужно получить все доступные магазину способы оплаты, вызываем метод getPaymentWays(). Если данная информация не нужна и Вы проводить оплату зафиксированным способом оплаты (например, принимаете только оплату с банковской карты), данный метод можно не вызывать.
3. В зависимости от выбранного способа оплаты, проводим оплату:
   1. Оплата с кошелька IntellectMoney:
   1. Получаем userToken.
   2. Запрашиваем у Покупателя код для подтверждения платёжных операций (pinCode).
   3. Обращаемся к методу innerPayment().
   2. Оплата банковской картой:
      1. Обращаемся к методу bankCardPayment(). После отправки данных о карте, состояние банковского платежа можно отслеживать через метод getBankCardPaymentState().
      2. Если платёж 3-DS отображаем Покупателю iFrame с окном для ввода 3-DS пароля.
         Если проводим активационный платеж, то обращаемс к методу activationPay().
         
   3. Оплата через почту России:
      1. Запрашиваем у пользователя данные для заполнения бланка.
      2. Обращаемся к методу getPostPayBlank().
   4. Оплата через обменники (alfaClick, Яндекс.Деньги и тд):
      1. Обращаемся к методу обменника:
         1. Альфа-Клик: alfaClickPayment().
         2. Сбербанк Онлайн: sberbankPapment().
         3. Яндекс.Деньги: yandexPayment().
         4. С кошелька WebMoney: WMRPayment().
         5. С QIWI-кошелька: QIWIPursePayment().

GETPAYMENTWAYS() - ЗАПРОС СПОСОБОВ ОПЛАТЫ

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

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

https://api.intellectmoney.ru/merchant/<api_version>/getpaymentways

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

ПОРЯДОК ВЫЗОВА МЕТОДОВ

Работу с представленным API можно разделить на 2 шага:

1. Выставляем счёт к оплате посредством метода createInvoice(). После того как счёт выставлен, его состояние можно отслеживать через метод getPurchaseInfo().
   1. Если нужно получить все доступные магазину способы оплаты, вызываем метод getPaymentWays(). Если данная информация не нужна и Вы проводить оплату зафиксированным способом оплаты (например, принимаете только оплату с банковской карты), данный метод можно не вызывать.
2. В зависимости от выбранного способа оплаты, проводим оплату:
   1. Оплата с кошелька IntellectMoney:
      1. Получаем userToken.getPaymentWays()
      2. Запрашиваем у Покупателя код для подтверждения платёжных операций (pinCode).
      3. Обращаемся к методу innerPayment().
   2. Оплата банковской картой:
      1. Обращаемся к методу bankCardPayment(). После отправки данных о карте, состояние банковского платежа можно отслеживать через метод getBankCardPaymentState().
      2. Если платёж 3-DS отображаем Покупателю iFrame с окном для ввода 3-DS пароля.
         Если проводим активационный платеж, то обращаемся к методу activationPay().
         
   3. Оплата через почту России:
      1. Запрашиваем у пользователя данные для заполнения бланка.
      2. Обращаемся к методу getPostPayBlank().
   4. Оплата через обменники (alfaClick, Яндекс.Деньги и т.д.):
      1. Обращаемся к методу обменника:
         1. Альфа-Клик: alfaClickPayment().
         2. Сбербанк Онлайн: sberbankPayment().
         3. Яндекс.Деньги: yandexPayment().
         4. С кошелька WebMoney: WMRPayment().
         5. С QIWI-кошелька: QIWIPursePayment().

ОБЩАЯ ИНФОРМАЦИЯ

ФОРМИРОВАНИЕ ЗАПРОСА

Для обращения к методам API нужно выполнить POST-запрос на URL, который состоит из следующих частей: host(https://api.intellectmoney.ru/merchant/) + название метода к которому идёт обращение (напр. https://api.intellectmoney.ru/merchant/createinvoice).

Данные при запросах на сервер IntellectMoney передаются в формате параметров HTTP-запроса в кодировке UTF-8 с заголовком Content-type: application/x-www-form-urlencoded. В ответ данные возвращаются в формате XML, либо в формате JSON. Что бы получить ответ в формате JSON нужно в заголовки запроса передать "Accept: text/json".

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

К строке для подписи в конец добавляется параметр “Секретный ключ (secretKey)”, из настроек магазина в личном кабинете IntellectMoney, через разделитель “::“. После чего, к итоговой строке применяется хеш-функция MD5, результат работы который считается подписью запроса. Обратите внимание, что строка передаваемая в MD5 должна иметь кодировку UTF-8.

• Подпись запроса передается в параметр hash.

Пример формирования контрольной подписи:

МЕТОД GetPaymentWays - ЗАПРОС СПОСОБОВ ОПЛАТЫ

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

Доступ к методу

URL: https://api.intellectmoney.ru/merchant/getpaymentways

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign: eshopId::invoiceId::amount::preferences::signSecretKey

Передаваемые параметры

eshopId::invoiceId::amount::preferences

Ответ сервера

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

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

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

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

URL:

https://api.intellectmoney.ru/merchant/<api_version>/createInvoiceВ запросе необходимо передать следующие параметры:

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign:  eshopId::orderId::serviceName::recipientAmount::recipientCurrency::userName::email::successUrl::failUrl::backUrl::resultUrl::expireDate::holdMode::preference::signSecretKey

Передаваемые параметры

{
	"Splits": [
		{
			"EshopId": 400001, "Amount": 200
		},
		{
			"EshopId": 400002, "Amount": 600
		},
	]
}

eshopId::orderId::serviceName::recipientAmount::recipientCurrency::userName::email::successUrl::failUrl::backUrl::resultUrl::expireDate::holdMode::preference

Ответ сервера

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

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

МЕТОД BankCardPayment - ОПЛАТА БАНКОВСКОЙ КАРТОЙ

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

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

Доступ к методу

URL:https://api.intellectmoney.ru/merchant/<api_version>/bankcardpaymentВ запросе необходимо передать следующие параметры: 

Доступные HTTP-методы: POST

Требуемый уровень доступа: PCI DSS

Правило формирования заголовка Sign: eshopId::invoiceId::pan::cardHolder::expiredMonth::expiredYear::cvv::returnUrl::ipAddress::signSecretKey

Передаваемые параметры

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

Ответ сервера

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

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

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

Пример запроса

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>

Пример использования

1. Запрашиваем у Покупателя данные по карте.
2. Обращаемся к методу bankCardPayment(). После отправки данных о карте, состояние банковского платежа можно отслеживать через метод getBankCardPaymentState().
3. Дальше возможны два варианта:
   
   1. Платёж 3-DS (Статус Платежа 3 - Отправлен на 3DS):
      1.  отображаем Пользователю (Покупателю) код из параметра Form3DS.
      2. Пользователь Пользователь (Покупатель) проходит 3-DS идентификацию. Состояние банковского платежа можно узнать обратившись к методу getBankCardPaymentState(). Как только данный метод вернет статус 0, можно считать, что счёт оплачен. 
   2. Платёж активационный (Статус Платежа 4 - отправлен на активационный платеж):
      1. Обращаемся к методу activationPay(). 
   3. Платеж не 3-DS, то ничего не делаем (Статус Платежа 2 - в обработке).
4. Сообщаем Пользователю (Покупателю) о завершении оплаты.
   

МЕТОД GetBankCardPaymentState - СОСТОЯНИЕ ПЛАТЕЖА

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

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

Используется для получения информации о состоянии оплаты счета.

Доступ к методу

URL: https://api.intellectmoney.ru/merchant/<api_version>/getbankcardpaymentstateВ запросе необходимо передать следующие параметры:

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign: eshopId::invoiceId::signSecretKey

Передаваемые параметры

eshopId::invoiceId

Ответ сервера

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

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

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

3. Ошибка обработки операции. Операция выполнена не будет. ( Код операции - 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 В запросе необходимо передать следующие параметры: /activationpay

Доступные HTTP-методы: POST

Требуемый уровень доступа: PCI DSS

Правило формирования заголовка Sign: eshopId::invoiceId::activationAmount::cvv::signSecretKey

Передаваемые параметры

eshopId::invoiceId::activationAmount::cvv

Ответ сервера

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

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

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

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

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

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign: eshopId::invoiceId::userToken::pinCode::signSecretKey

Передаваемые параметры

eshopId::invoiceId::userToken::pinCode

Ответ сервера

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

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

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

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

1. Запрашиваем у Пользователя (Покупателя) Пин-код (pinCode), который он указал при регистрации в системе IntellectMoney.
2. Обращаемся к методу innerPayment().
3. Проверяем какой статус вернулся в ответ, если (0 - ОК), значит платёж прошел. Если пришел другой статус, проверьте корректность передаваемых полей.
4. Сообщаем Пользователю (Покупателю) о завершении оплаты.

GETPOSTPAYBLANK - ПОЛУЧИТЬ БЛАНК ДЛЯ ОПЛАТЫ ПОЧТОВЫМ ПЕРЕВОДОМ

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

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

https://api.intellectmoney.ru/merchant/<api_version>/getpostpayblank

ОПЛАТА ЧЕРЕЗ Qiwi-кошелек

Оплата используя Киви-кошелек состоит из 3-х этапов, путем вызова методов:

1. CreateQiwiWalletToken, для формирования токена;    
2. CheckQiwiWalletToken, для подтверждения;
3. QiwiWalletPayment, для финальной оплаты.

Доступ к методу CreateQiwiWalletToken

URL: https://api.intellectmoney.ru/merchant/createqiwiwallettoken

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign: eshopId::invoiceId::::phone::::signSecretKey

Передаваемые параметры

eshopId::invoiceId::phone

Ответ сервера

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

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

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

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

Пример запроса

Post /merchant/createqiwiwallettoken/ HTTP/1.1
Host: api.intellectmoney.ru
Content-Type: application/x-www-form-urlencoded; charset=utf-8

eshopId=450123
invoiceId=356421216
phone=79214567895
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>
    <Result>
		<RequestId>0a7ce499-631e-4ef7-a7c0-335157c0cd87</RequestId>
        <State>
            <Code>0</Code>
            <Desc>Успешно обработан</Desc>
        </State>
    </Result>
</Response> 

Доступ к методуCheckQiwiWalletToken

URL: https://api.intellectmoney.ru/merchant/checkqiwiwallettoken

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign: eshopId::invoiceId::requestId::::smsCode::signSecretKey

Передаваемые параметры

eshopId::invoiceId::requestId::smsCode

Ответ сервера

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

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

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

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

Пример запроса

Post /merchant/checkqiwiwallettoken/ HTTP/1.1
Host: api.intellectmoney.ru
Content-Type: application/x-www-form-urlencoded; charset=utf-8

eshopId=450123
invoiceId=356421216
smsCode=123456
requestId=0a7ce499-631e-4ef7-a7c0-335157c0cd87
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>
    <Result>
          <Token>7B226B223A22344F57465A3537576B4E763685673452636E764C446A33416D4B6C3758665449363143653769227D</Token>
          <State>
            <Code>0</Code>
            <Desc>Успешно обработан</Desc>
        </State>
    </Result>
</Response> 

Доступ к методу QiwiWalletPayment

URL: https://api.intellectmoney.ru/merchant/qiwiwalletpayment

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign: eshopId::invoiceId::successUrl::failUrl::::ipAddress::signSecretKey

Передаваемые параметры

eshopId::invoiceId::successUrl::failUrl::additionalParams::ipAddress

Ответ сервера

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

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

Пример запроса

Post /merchant/qiwiwalletpayment/ HTTP/1.1
Host: api.intellectmoney.ru
Content-Type: application/x-www-form-urlencoded; charset=utf-8

eshopId=450123
invoiceId=356421216
ipaddress=127.0.0.1
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> 

Пример использования

1. Выставляем счёт (метод CreateInvoice).
2. Обращаемся к методу createqiwiwallettoken, в ответе получаем идентификатор запроса RequestId. 
3. После чего вызываем метод checkqiwiwallettoken, в ответе получем токен.
4. Вызываем метод оплаты qiwiwalletpayment.
5. После отправки данных, состояние банковского платежа можно отслеживать через метод getBankCardPaymentState().
6. Дополнительно статус успешного платежа будет отправлен на resultUrl. 

МЕТОД SbpPayment- ПОЛУЧИТЬ QR-КОД ДЛЯ ОПЛАТЫ ЧЕРЕЗ СБП

Используется для получения qr-кода и ссылки для оплаты.

Доступ к методу

URL: https://api.intellectmoney.ru/merchant/sbppayment

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign: eshopId::invoiceId::successUrl::failUrl::additionalParams::ipAddress::signSecretKey

Передаваемые параметры

eshopId::invoiceId::successUrl::failUrl::additionalParams::ipAddress

Ответ сервера

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

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

Пример запроса

Post /merchant/sbppayment/ HTTP/1.1
Host: api.intellectmoney.ru
Content-Type: application/x-www-form-urlencoded; charset=utf-8

eshopId=450123
invoiceId=356421216
ipaddress=127.0.0.1
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> 

Пример использования

1. Выставляем счёт (метод CreateInvoice).
2. Обращаемся к методу sbppayment. После отправки данных, состояние банковского платежа можно отслеживать через метод getBankCardPaymentState().
3. При запросе статуса платежа (getBankCardPaymentState()) отслеживаем появление статуса "SendTo3DS":
   1. 1.  В данном статусе в параметре  Form3DS будут присланы параметры SbpQrCode и SbpLink в формате JSON.
4. После получения Qr-кода и оплаты счёта покупателем, статус платежа можно определить перезапросом метода getBankCardPaymentState(). Дополнительно статус успешного платежа будет отправлен на resultUrl.

Anchor
ApiMethodBnplPayment ApiMethodBnplPayment

МЕТОД BnplPayment- ПЕРЕХОД НА СТРАНИЦУ ОПЛАТЫ В РАССРОЧКУ

Используется для получения ссылки на сервис оплаты в рассрочку.

Доступ к методу

URL: https://api.intellectmoney.ru/merchant/bnplpayment

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign: eshopId::invoiceId::successUrl::failUrl::additionalParams::ipAddress::signSecretKey

Передаваемые параметры

eshopId::invoiceId::successUrl::failUrl::additionalParams::ipAddress

Ответ сервера

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

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

Пример запроса

Post /merchant/bnplpayment/ HTTP/1.1
Host: api.intellectmoney.ru
Content-Type: application/x-www-form-urlencoded; charset=utf-8

eshopId=450123
invoiceId=356421216
ipaddress=127.0.0.1
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> 

Пример использования

1. Выставляем счёт (метод CreateInvoice).
2. Обращаемся к методу bnplpayment. После отправки данных следует отслеживать получение ссылки через метод getBankCardPaymentState().
3. При запросе статуса платежа (getBankCardPaymentState()) отслеживаем появление статуса "SendTo3DS":
   1. 1.  В данном статусе в параметре  Form3DS будет получена ссылка на сервис оплаты в рассрочку.
4. Выполните перенаправление в браузере плательщика на полученную ссылку.
5. Статус платежа можно определить перезапросом метода getBankCardPaymentState(). Дополнительно статус успешного платежа будет отправлен на resultUrl.

МЕТОД GetPostPayBlank - ПОЛУЧИТЬ БЛАНК ДЛЯ ОПЛАТЫ ПОЧТОВЫМ ПЕРЕВОДОМ

Используется для получения бланка оплаты.

Доступ к методу

URL: https://api.intellectmoney.ru/merchant/getpostpayblank

Доступные HTTP-методы: POST

Требуемый уровень доступа: Базовый

Правило формирования заголовка Sign: eshopId::invoiceid::amount::address::postcode::fio::inn::residentofrussia::series::number::day::month::year::kem::beginday::beginmonth::beginyear::endday::endmonth::endyear::signSecretKey

Передаваемые параметры

eshopId::invoiceId::amount::address::postCode::fio::inn::residentOfRussia::series::number::day::month::year::kem::beginDay::beginMonth::beginYear::endDay::endMonth::endYear

Ответ сервера

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

1. Запрос обработался моментально. Ответ типа  типа <Response> будет содержать структуру  структуру <PostPayBlankData> (синхронная обработка). ( Код операции - 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>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). Если обязательные поля не заполнить, то и в бланке они не будут заполнены и в момент перевода могут возникнуть проблемы, например: Пользователь (Покупатель) не является резидентом, тогда при не заполненных полях о сроке пребывания кассир потребует заполнить данные поля. 

1. Запрашиваем у Пользователя (Покупателя) личные данные.
2. Обращаемся к методу getPostPayBlank().
3. Получаем в ответ изображение бланка для оплаты в отделениях почты России, обрабатываем полученный код "data:image/png;base64,{полученный код}" и отображаем получившееся изображение Пользователю (Покупателю).
4. Пользователь (Покупатель) распечатывает бланк или заполняет чистый бланк, который можно получить в отделениях почты России.
5. Пользователь (Покупатель) идет с бланком в отделение почты России и производит оплату.

Вы можете отслеживать состояние счета методом getPurchaseInfo() (надо обязательно передать номер платежа), когда в State из <InvoiceData> из <InvoiceData> будет в статусе Paid=2 Полностью оплачен значит платеж завершен.

eshopId::orderId::action

Post /merchant/PurchaseToRefund/ HTTP/1.1
Host: api.intellectmoney.ru
Content-Type: application/x-www-form-urlencoded; charset=utf-8

eshopId=450123
InvoiceId=356421216
operationAmount=8.14
hash=dHA6Ly9jcmwuZ2xvYmFsc2lnbi5jb20v3MvZ3Nkb21haW52YWxzaGEyZzIuY3JsMIG

HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="utf-8"?>
<Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<OperationState>
		<Code>0</Code>
		<Desc>Успешно обработана</Desc>
	</OperationState>
	<OperationId>64874ad9-d012-4cae-a149-2d7b5cb57728</OperationId>
	<EshopId xsi:nil="true" />
	<Result>
		<State>
			<Code>0</Code>
			<Desc>Успешно обработан.</Desc>
		</State>
		<Data>OK</Data>
	</Result>
</Response>

eshopId::invoiceId::successUrl::failUrl::additionalParams

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>

eshopId::operationId

eshopId::invoiceId::inputType

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>