Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
ОБЩАЯ ИНФОРМАЦИЯ
Данное API на текущий момент реализации позволяет запросить реестр платежей. Взаимодействие между сервером IntellectMoney и клиентом API происходит по HTTP-протоколу.
В ответ приходят два состояния запроса это <OperationState> и <Response>:
- <OperationState> сообщает - смогла ли система IntellectMoney обработать данный запрос. Возможны три варианта:
- Система обработала запрос.
- Система поставила запрос в очередь на обработку.
- Система не смогла обработать запрос.
- <Response> сообщает статус запроса - был ли найден данный метод, все ли параметры переданы верно и так далее.
Данные при запросах на сервер IntellectMoney передаются в формате параметров HTTP-запроса в кодировке UTF-8 с типом контента "application/x-www-form-urlencoded". В ответ данные возвращаются в формате XML, либо в формате JSON. Что бы получить ответ в формате JSON нужно в заголовки запроса передать "Accept: text/json".
СЛОВАРЬ ТЕРМИНОВ
- СКО — Счет К Оплате, инвойс
ПОРЯДОК ВЫЗОВА МЕТОДОВ
Для доступа к API следует получить ключ доступа через операцию аутентификации клиента Документация Personal API. Данный ключ является обязательным параметром для всех операций API.
Anchor | ||||
---|---|---|---|---|
|
Передача параметров
Для запроса ключа доступа клиента к API необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/personal/user/getUserToken
В запросе необходимо передать следующие параметры:
Название | Имя параметра | Обязательный | Описание |
---|---|---|---|
Логин | Login | Да | Логин пользователя юридического лица (магазина). |
Пароль | Password | Да | Пароль пользователя юридического лица (магазина). |
В ответ возвращается код операции и возможны 3 варианта:
Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <UserTokenData> (синхронная обработка). (Код операции - 0)
Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). (Код операции - 1)
Ошибка обработки операции. Операция выполнена не будет. (Код операции - 2)
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Post /pds/user/getUserToken/ HTTP/1.1 Host: api.intellectmoney.ru Content-Type: application/x-www-form-urlencoded; charset=utf-8 Login=somelogin Password=somepassword |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
<?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>f2c33a48-17c8-4889-a327-5ad1b6260cd5</OperationId> <EshopId>0</EshopId> <Result> <State> <Code>0</Code> <Desc>Успешно обработан.</Desc> </State> <UserToken>bs/fZNe0CE+b/Ze1xvVaNdEbjxm2wkRqMBSnBXJO9nFeEM57Hg17+AS8nF0Cs7+0</UserToken> </Result> </Response> |
Anchor | ||||
---|---|---|---|---|
|
Передача параметров
Для запроса реестра платежей необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/personal/payment/getInvoicesHistory
В запросе необходимо передать следующие параметры:
Название | Имя параметра | Обязательный | Описание |
---|---|---|---|
Ключ доступа | UserToken | Да | Ключ доступа клиента к API, запрашиваемый операцией аутентификации клиента Документация Personal API. |
ID магазина | EshopId | Да | Номер магазина в системе IntellectMoney, по которому запрашивается реестр. Можно увидеть на странице https://intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID". |
Статус СКО | State | Нет | Запрос реестра платежей только с указанным статусом СКО (см. <InvoiceState>) |
Номер СКО | InvoiceId | Нет | Запрос информации только по одному СКО по его номеру |
Дата начала выборки | DateFrom | Нет | Запрос реестра платежей с датой последних изменений СКО, входящей в период выборки в формате ММ.ДД.ГГГГ. |
Дата окончания выборки | DateTo | Нет | |
Ограничение выборки по количеству объектов | Skip | Нет | Количество объектов, пропускаемых перед отдачей |
Ограничение выборки по количеству объектов | Take | Да | Ограничение на количество возвращаемых объектов. |
Info | ||
---|---|---|
| ||
При выборке данных используется конъюнкция параметров. Например, в случае, если переданы параметры "Статус СКО" и "Номер СКО", то результат запрос вернет объект СКО только при его наличии с переданными номером и статусом. |
В ответ возвращается код операции и возможны 3 варианта:
Запрос обработался моментально. Ответ типа <Response> будет содержать структуру <InvoicesHistoryListData> (синхронная обработка). (Код операции - 0)
Запрос был поставлен в очередь на обработку. Ответ типа <Response> будет содержать идентификатор операции, по которому можно запросить результат выполнения операции (асинхронная обработка). (Код операции - 1)
Ошибка обработки операции. Операция выполнена не будет. (Код операции - 2)
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Post /pds/payment/getPaymentsHistory/ HTTP/1.1 Host: api.intellectmoney.ru Content-Type: application/x-www-form-urlencoded; charset=utf-8 userToken=bs/fZNe0CE+b/Ze1xvVaNdEbjxm2wkRqMBSnBXJO9nFeEM57Hg17+AS8nF0Cs7+0 eshopId=452101 dateTo=07.15.2017 take=10 invoiceId=3804939856 |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
<?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>2da855c8<OperationId>50a55d0c-538ea754-471a47ca-bb1db355-83be01652e72<56362cf52a98</OperationId> <EshopId>0</EshopId> <Result> <State> <Code>0</Code> <Desc>Успешно обработан.</Desc> </State> <InvoicesHistoryList> <InvoicesHistoryList> <InvoiceData> <InvoiceData><Id>3930949846</Id> <State>Paid</State> <Id>3804939856</Id><HoldModeFlag>false</HoldModeFlag> <ChangeDate>2017-06-02T10:12:00.457</ChangeDate> <CreationDate>2017-06-02T10:11:03.383</CreationDate> <State>Created</State> <ExpirationDate>0001-01-01T00:00:00</ExpirationDate> <Amount> <Amount>11.0000</Amount> <Currency>RUB</Currency> </Amount> <CurrentAmount> <Amount>0.0000</Amount> <Currency>RUB</Currency> </CurrentAmount> <SurchargeAmount> <Amount>0</Amount> <Currency>RUB</Currency> </SurchargeAmount> <AdditionalInfo> <KeyValue> <Key>Магазин</Key> <Value xsi:type="xsd:string">ShopReal</Value> </KeyValue> <KeyValue> <Key>Url</Key> <Value xsi:type="xsd:string">http://yandex.ru</Value> </KeyValue> </AdditionalInfo> <HistoryList> <HistoryData> <Id>27907531</Id> <PaymentNumber>2036160602</PaymentNumber> <State>Confirm</State> <CreationDate>2017-09-22T17:30:01.04</CreationDate> <PaymentAmount> <Amount>11.0000</Amount> <Currency>RUB</Currency> </PaymentAmount> <RecipientAmount> <Amount>11.0000</Amount> <Currency>RUB</Currency> </RecipientAmount> <PaymentAccount>IMOUT4936010998</PaymentAccount> <RecipientAccount>IM1028693534</RecipientAccount> <Comment>Возврат по ордеру 538</Comment> <Description>Внутренний на s.suvorinov@intellectmoney.ru</Description> <Direction>Withdraw</Direction> <HoldModeFlag>false<<PurchaseOrderId>123456789000</HoldModeFlag>PurchaseOrderId> <ChangeDate>2017-07-14T09:22:14.717</ChangeDate><AdditionalInfo /> <CreationDate>2017-07-14T09:22:14.717</CreationDate><InvoicePaymentType>Refund</InvoicePaymentType> <InvoiceId>3930949846</InvoiceId> <ExpirationDate>0001-01-01T00:00:00</ExpirationDate> <IsElectedPayment>false</IsElectedPayment> <Amount> <TypeOfRePayment xsi:nil="true" /> <ProviderId <Amount>120.0000</Amount> xsi:nil="true" /> <CatalogPaymentId>0</CatalogPaymentId> <Currency>TST</Currency> <ShortPan /> <Country </Amount>> <CurrentAmount><UserEmail>s.suvorinov@intellectmoney.ru</UserEmail> </HistoryData> <Amount>0.0000</Amount><HistoryData> <Id>27905689</Id> <Currency>TST</Currency> <PaymentNumber>2036150166</PaymentNumber> <<State>Confirm</CurrentAmount>State> <CreationDate>2017-06-02T10:12:00.517</CreationDate> <SurchargeAmount> <PaymentAmount> <Amount>120<Amount>11.0000</Amount> <Currency>RUB</Currency> <Currency>TST</Currency> </PaymentAmount> </SurchargeAmount> <RecipientAmount> <Comment>Test Invoice</Comment> <Amount>10.6200</Amount> <Currency>RUB</Currency> <AdditionalInfo> </RecipientAmount> <KeyValue> <PaymentAccount>Счет к оплате 3930949846</PaymentAccount> <RecipientAccount>IM4406528006</RecipientAccount> <Key>Магазин</Key> <Description>Зачисление денежных средств на счет магазина "ShopReal" со счета "3930949846"</Description> <Value xsi:type="xsd:string">TestEShop</Value> <Direction>Withdraw</Direction> <PurchaseOrderId>123456789000</PurchaseOrderId> </KeyValue> <AdditionalInfo /> <KeyValue><InvoicePaymentType>Purchase</InvoicePaymentType> <InvoiceId>3930949846</InvoiceId> <Key>Url<<IsElectedPayment>false</Key>IsElectedPayment> <TypeOfRePayment xsi:nil="true" /> <Value<ProviderId xsi:typenil="xsd:string">http://TestEShop.ru</Value> true" /> <CatalogPaymentId>0</CatalogPaymentId> <ShortPan /> </KeyValue> <Country /> </AdditionalInfo><UserEmail>s.suvorinov@intellectmoney.ru</UserEmail> </HistoryData> <OwnerEmail>v.satushev+100@intellectmoney.ru</OwnerEmail> <HistoryData> <OwnerFIO>RFAAUD<<Id>27905686</OwnerFIO>Id> <PaymentNumber>2036150165</PaymentNumber> <PurchaseOrderId>10030</PurchaseOrderId> <State>Confirm</State> <UserId>0</UserId> <CreationDate>2017-06-02T10:11:20.767</CreationDate> <PaymentAmount> <PassthroughModeFlag>false</PassthroughModeFlag> <Amount>11.1100</Amount> <LoginId xsi:nil="true" /> <Currency>RUB</Currency> <EShopId>452101<</EShopId>PaymentAmount> <RecipientAmount> <HttpRequestErrorCount>0</HttpRequestErrorCount> <Amount>11.0000</Amount> <HttpRequests /> <Currency>RUB</Currency> <Rrn </>RecipientAmount> <PaymentAccount>IM1028693534</PaymentAccount> <PurchaseData> <RecipientAccount>Счет к оплате 3930949846</RecipientAccount> <Id>37166</Id> <Comment /> <Description>Пополнение счета № "3930949846" <PurchaseMoney>через "IM1028693534"</Description> <Direction>Deposit</Direction> <Amount>120.0000<<PurchaseOrderId>123456789000</Amount>PurchaseOrderId> <AdditionalInfo /> <InvoicePaymentType>Entry</InvoicePaymentType> <Currency>TST</Currency> <InvoiceId>3930949846</InvoiceId> <<IsElectedPayment>false</PurchaseMoney>IsElectedPayment> <TypeOfRePayment xsi:nil="true" /> <OrderId>10030</OrderId> <ProviderId xsi:nil="true" /> <Name>Test Invoice<<CatalogPaymentId>0</Name>CatalogPaymentId> <InputType>InnerPayment</InputType> <BackUrl /> <ShortPan /> <SuccessMethod xsi:nil="true"<Country /> <UserEmail>s.suvorinov@intellectmoney.ru</UserEmail> <FailMethod xsi:nil="true" </>HistoryData> </HistoryList> <OwnerEmail>s.suvorinov@intellectmoney.ru</OwnerEmail> <EshopId>452101</EshopId> <OwnerFIO>Суворинов Сергей eauoau</OwnerFIO> <PurchaseOrderId>123456789000</PurchaseOrderId> <EshopUrl>http://TestEShop.ru</EshopUrl> <PurchaseData> <Id>36007</Id> <EshopName>TestEShop</EshopName> <PurchaseMoney> <Amount>11.0000</Amount> <SMSEnable>true<<Currency>RUB</SMSEnable>Currency> </PurchaseMoney> <UserEmail>v.satushev+100@intellectmoney.ru</UserEmail> <OrderId>123456789000</OrderId> <BackUrl>http://google.com/backurl</BackUrl> <SuccessMethod xsi:nil="true" <IsHeldByEshop>false</IsHeldByEshop>> <FailMethod xsi:nil="true" /> <ParseUserFields <EshopId>450063</>EshopId> <EshopUrl>http://yandex.ru</EshopUrl> <<EshopName>ShopReal</PurchaseData>EshopName> <SMSEnable>true</SMSEnable> <IsCanEnrollmentByDisabledMethod>false</IsCanEnrollmentByDisabledMethod> <UserName>Суворинов Сергей</UserName> <InvoiceChangeAmountHistoryData /> <UserEmail>s.suvorinov@intellectmoney.ru</UserEmail> <IsHeldByEshop>true</IsHeldByEshop> <OriginalAmount> <ParseUserFields /> </PurchaseData> <Amount>120.0000</Amount> <IsCanEnrollmentByDisabledMethod>false</IsCanEnrollmentByDisabledMethod> <InvoiceChangeAmountHistoryData /> <OriginalAmount> <Currency>TST</Currency> <Amount>11.0000</Amount> <<Currency>RUB</OriginalAmount>Currency> </OriginalAmount> <FormType>None</FormType> <OrganizationName>Маша <OrganizationName>RFAAUD<и Медведи</OrganizationName> <IsHaveCashboxReceipts>false</IsHaveCashboxReceipts> </InvoiceData> </InvoicesHistoryList> </Result> </Response> |
Anchor | ||||
---|---|---|---|---|
|
ТИПЫ ДАННЫХ
Anchor <Response> <Response>
<Response>
<Response> | |
<Response> |
Поле | Тип | Описание |
---|---|---|
OperationState | Статус выполнения операции | |
OperationId | GUID | Идентификатор операции |
EshopId | int | ID магазина |
Result | MethodResult | Результат выполнения запроса. Зависит от типа запроса. В случае асинхронной обработки запроса данного поля не будет. |
Anchor <OperationState> <OperationState>
<OperationState>
<OperationState> | |
<OperationState> |
Поле | Тип | Описание |
---|---|---|
State | Статусы выполнения запросов | |
Desc | string | Описание кода статуса выполнения запроса |
Anchor <UserTokenData> <UserTokenData>
<UserTokenData>
<UserTokenData> | |
<UserTokenData> |
Поле | Тип | Описание |
---|---|---|
State | Статусы выполнения запросов | |
UserToken | string | Ключ доступа клиента к API |
Anchor <InvoicesHistoryListData> <InvoicesHistoryListData>
<InvoicesHistoryListData>
<InvoicesHistoryListData> | |
<InvoicesHistoryListData> |
Поле | Тип | Описание |
---|---|---|
State | Статусы выполнения запросов | |
InvoicesHistoryList | Список (реестр) платежей |
Anchor <InvoiceData> <InvoiceData>
<InvoiceData>
<InvoiceData> | |
<InvoiceData> |
Поле | Тип | Описание |
---|---|---|
Id | long | Номер СКО |
State | Статус состояния СКО | |
CreationDate | DateTime | Дата создания СКО |
ChangeDate | DateTime | Дата последних изменений СКО |
Amount | <Money> | Сумма СКО с учётом комиссии |
CurrentAmount | <Money> | Оплаченная сумма СКО |
SurchargeAmount | <Money> | Сумма СКО, которую осталось оплатить, если счёт уже оплачен - покажет 0 |
Comment | string | Комментарий к платежу |
EShopId | long | Номер магазина в системе IntellectMoney |
PurchaseOrderId | string | Внутренний номер покупки (заказа) в магазине |
Info | ||
---|---|---|
| ||
Свойства типа данных <InvoiceData>, приведенные в примере ответа на запрос, но не описанные выше, следует игнорировать в текущей версии API. |
Anchor <Money> <Money>
<Money>
<Money> | |
<Money> |
Поле | Тип | Описание |
---|---|---|
Amount | decimal | Количество денежных средств. |
Currency | <Currency> | В какой валюте исчисляются денежные средства. |
ПЕРЕЧИСЛЕНИЯ
Anchor ServiceOperatonState ServiceOperatonState
Коды операций
ServiceOperatonState | |
ServiceOperatonState |
ServiceOperatonState | Описание |
---|---|
0 | Успешно обработана |
1 | В процессе выполнения |
2 | Ошибка |
Anchor PDSServiceState PDSServiceState
Статусы запросов
PDSServiceState | |
PDSServiceState |
Код ошибки | Описание |
---|---|
0 | Успешно обработан |
1 | Обработан с предупреждениями |
2 | Аутентификация не пройдена |
Anchor <Currency> <Currency>
Описание принимаемых валют
<Currency> | |
<Currency> |
Название | Описание |
---|---|
RUB | Валюта оплаты - Российский рубль |
TST | Внутренняя тестовая валюта оплаты |
Anchor | ||||
---|---|---|---|---|
|
InvoiceState | Числовое представление | Описание | Пояснение |
---|---|---|---|
Created | 0 | Создан | Счёт к оплате создан и теперь его состояние можно отслеживать методом getPurchaseInfo(). Никаких платёжных операций не производилось. |
PartPaid | 1 | Частично оплачен | Пользователь (Покупатель), внес часть средств. Пользователю (Покупателю) надо внести оставшуюся часть суммы. |
Paid | 2 | Полностью оплачен | Пользователь внес всю сумму. |
ToPaid | 3 | В процессе обработки | Над денежными средствами производятся действия. |
Refund | 4 | Возврат | Средства будут возвращены Пользователю (Покупателю). |
Held | 6 | Захолдирован | Средства заморожены (захолдированы/ holded) на счёте Пользователя (Покупателя). Данные средства будут зачислены или расхолдированы (вернутся Пользователю) по истечению времени заморозки (холдирования) или пока не будут зачислены вручную. Поведение денежных средств определяется в настройках магазина на вкладке "Приём платежей" в разделе "Расширенные настройки". |
Table of Contents | ||
---|---|---|
|