Эта статья - вступление в работу с API IntellectMoney. Информацию по всему доступному функционалу можно найти в последующих статьях раздела Методы API.
Без запроса доступа к API можно использовать методы из этой статьи с валютой TST.
Чтобы начать пользоваться всем доступным функционалом, после заключения договора запросите доступ к API. Подробнее здесь.
Для вызова методов API нужно придумать и задать свой секретный ключ в настройках магазина, на вкладке "Подключение магазина". Также, после заключения договора, нужно получить Bearer токен с доп. ключом на странице Безопасность, они понадобятся для авторизации:
Уровень PCI DSS нужен для методов API, в которых передаются карточные данные, например для метода BankCardPayment
До заключения договора можно использовать валюту TST, она не требует авторизации (для нее не обязательно передавать заголовки Authorization
и Sign)
.
CreateInvoice - ВЫСТАВЛЕНИЕ СЧЁТА К ОПЛАТЕ
Заголовки:
Authorization: Bearer <ваш токен>
Sign: <хеш рассчитанный по шаблону>
- Content-Type:
application/json
илиapplication/x-www-form-urlencoded
- Accept:
application/json
илиapplication/xml
eshopId::orderId::serviceName::recipientAmount::recipientCurrency::userName::email::successUrl::failUrl::backUrl::resultUrl::expireDate::holdMode::preference::signSecretKey
eshopId::orderId::serviceName::recipientAmount::recipientCurrency::userName::email::successUrl::failUrl::backUrl::resultUrl::expireDate::holdMode::preference::secretKey
Запрос
Имя параметра | Описание |
---|---|
eshopId Обязательный | ID магазина |
orderId Обязательный | Уникальный идентификатор покупки из вашей системы. до 50 символов |
recipientAmount Обязательный | Сумма платежа, разделенная точкой. Минимальное значение - 10.00 .До 13 символов, до 2 цифр после точки. |
recipientCurrency Обязательный | Валюта платежа.
|
email Обязательный | E-mail покупателя. До 100 символов. |
hash Обязательный | Контрольная подпись запроса |
serviceName | Назначение платежа - описание товара или услуги. До 1024 символов. |
userName | Имя покупателя До 255 символов. |
successUrl | Адрес, на который происходит перенаправление плательщика с платежной страницы после успешной оплаты До 512 символов. |
failUrl | Адрес, на который происходит перенаправление плательщика с платежной страницы в случае неуспешной оплаты До 512 символов. |
backUrl | Адрес ссылки "Вернуться в магазин" на платежной странице До 512 символов. |
resultUrl | Адрес, на который система IntellectMoney посылает HTTP/S POST запросы об изменении состояния cчёта До 512 символов. |
preference | Возможные способы оплаты счёта. Если не передавать, счет можно будет оплатить любым из подключенных способов. |
holdMode | Сразу списывать средства с карты, или холдировать (замораживать) |
expireDate | Срок существования счёта - дата и время, по достижению которых оплатить счёт станет невозможно. Формат: yyyy-MM-dd HH:mm:ss . |
holdTime Обязательный при holdMode = 1 | Время, через которое захолдированные средства будут автоматически зачислены на счёт магазина или возвращены покупателю, измеряется в часах. |
В этой таблице опущена часть параметров, например параметры связанные с онлайн кассой и рекаррингом. См. полный список параметров в описании Merchant 2.0 API.
Ответ
OperationState
Code
- Статус предвалидации запросаDesc
- Описание статуса предвалидации запроса
EshopId
- ID магазина, в котором выставляется счётResult
State
Code
- Результат выполнения запросаDesc
- Описание результата выполнения запроса
InvoiceId
- Номер созданного счётаPaymentWays
- Список возможных способов оплатыId
- ID способа оплатыAmount
Amount
- Сумма оплатыCurrency
- Валюта оплаты
InputType
- Тип способа оплатыPreference
- Название способа оплатыCommission
- КомиссияIsVisible
- Будет ли этот способ оплаты отображаться на платежной страницеIsActive
- Доступен ли этот способ оплатыPosition
- Положение в списке относительно остальных способов
GetBankCardPaymentState - СОСТОЯНИЕ ПЛАТЕЖА
POST https://api.intellectmoney.ru/merchant/getbankcardpaymentstate
Заголовки:
Authorization: Bearer <ваш токен>
Sign: <хеш рассчитанный по шаблону>
- Content-Type:
application/json
илиapplication/x-www-form-urlencoded
- Accept:
application/json
илиapplication/xml
eshopId::invoiceId::signSecretKey
eshopId::invoiceId::secretKey
Запрос
Имя параметра | Описание |
---|---|
eshopId Обязательный | ID магазина, в котором был выставлен счёт |
invoiceId Обязательный | Номер счёта |
hash Обязательный | Контрольная подпись запроса |
Ответ
OperationState
Code
- Статус предвалидации запросаDesc
- Описание статуса предвалидации запроса
EshopId
- ID магазина, в котором выставляется счётResult
State
Code
- Результат выполнения запросаDesc
- Описание результата выполнения запроса
PaymentStep
- Текущее состояние платежа
BankCardPayment - ОПЛАТА БАНКОВСКОЙ КАРТОЙ
POST https://api.intellectmoney.ru/merchant/bankcardpayment
Заголовки:
Authorization: Bearer <ваш токен>
Sign: <хеш рассчитанный по шаблону>
- Content-Type:
application/json
илиapplication/x-www-form-urlencoded
- Accept:
application/json
илиapplication/xml
eshopId::invoiceId::pan::cardHolder::expiredMonth::expiredYear::cvv::returnUrl::ipAddress::signSecretKey
eshopId::invoiceId::pan::cardHolder::expiredMonth::expiredYear::cvv::returnUrl::ipAddress::secretKey
Используется для передачи реквизитов банковской карты и дальнейшей оплаты счета.
Для использования этого метода у вашей организации должна быть сертификация PCI DSS. Если у вас её нет, то оплату можно реализовать перенаправлением покупателя на нашу платежную страницу, либо внедрением нашего платежного виджета на сайт.
Запрос
Имя параметра | Описание |
---|---|
eshopId Обязательный | ID магазина, где был выставлен счёт |
invoiceId Обязательный | Номер счёта к оплате |
ipAddress Обязательный | IP адрес сайта, с которого выставляется платеж. |
returnUrl Обязательный | Адрес, на который перенаправляет плательщика после завершения 3DS. |
cardHolder | Имя и фамилия с карты |
pan Обязательный | Номер карты плательщика |
cvv Обязательный для карт имеющих CVV2 (CVC2) | Секретный код CVV2 (CVC2), как правило написан на обороте карты (последние три цифры на полосе для подписи). Параметр не нужно передавать, если карта не имеет кода. |
expiredYear Обязательный | Год, до которого действует карта |
expiredMonth Обязательный | Месяц, до которого действует карта |
hash Обязательный | Контрольная подпись запроса |
Ответ
OperationState
Code
- Статус предвалидации запросаDesc
- Описание статуса предвалидации запроса
EshopId
- ID магазина, в котором выставляется счётResult
State
Code
- Результат выполнения запросаDesc
- Описание результата выполнения запроса