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 следует получить ключ доступа через операцию аутентификации клиента Документация PDS API. Данный ключ является обязательным параметром для всех операций API.
Anchor | ||||
---|---|---|---|---|
|
Передача параметров
Для запроса ключа доступа клиента к API необходимо отправить GET- или POST-запрос на следующий адрес URL:
https://api.intellectmoney.ru/pds/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/pds/payment/getPaymentsHistory
В запросе необходимо передать следующие параметры:
Название | Имя параметра | Обязательный | Описание |
---|---|---|---|
Ключ доступа | UserToken | Да | Ключ доступа клиента к API, запрашиваемый операцией аутентификации клиента Документация PDS API. |
ID магазина | EshopId | Да | Номер магазина в системе IntellectMoney, по которому запрашивается реестр. Можно увидеть на странице https://intellectmoney.ru/ru/enter/ps_organization_shop/ в столбце "ID". |
Статус СКО | State | Нет | Запрос реестра платежей только с указанным статусом СКО (см. <InvoiceState>) |
Номер СКО | InvoiceId | Нет | Запрос информации только по одному СКО по его номеру |
Дата начала выборки | DateFrom | Нет | Запрос реестра платежей с датой последних изменений СКО, входящей в период выборки в формате ДД.ММ.ГГГГ. |
Дата окончания выборки | DateFrom | Нет | |
Ограничение выборки по количеству объектов | Skip | Нет | Количество объектов, пропускаемых перед отдачей |
Ограничение выборки по количеству объектов | Take | Нет | Ограничение на количество возвращаемых объектов |
В ответ возвращается код операции и возможны 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-538e-471a-bb1d-83be01652e72</OperationId>
<EshopId>0</EshopId>
<Result>
<State>
<Code>0</Code>
<Desc>Успешно обработан.</Desc>
</State>
<InvoicesHistoryList>
<InvoiceData>
<Id>3804939856</Id>
<State>Created</State>
<HoldModeFlag>false</HoldModeFlag>
<ChangeDate>2017-07-14T09:22:14.717</ChangeDate>
<CreationDate>2017-07-14T09:22:14.717</CreationDate>
<ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
<Amount>
<Amount>120.0000</Amount>
<Currency>TST</Currency>
</Amount>
<CurrentAmount>
<Amount>0.0000</Amount>
<Currency>TST</Currency>
</CurrentAmount>
<SurchargeAmount>
<Amount>120.0000</Amount>
<Currency>TST</Currency>
</SurchargeAmount>
<Comment>Test Invoice</Comment>
<AdditionalInfo>
<KeyValue>
<Key>Магазин</Key>
<Value xsi:type="xsd:string">TestEShop</Value>
</KeyValue>
<KeyValue>
<Key>Url</Key>
<Value xsi:type="xsd:string">http://TestEShop.ru</Value>
</KeyValue>
</AdditionalInfo>
<OwnerEmail>v.satushev+100@intellectmoney.ru</OwnerEmail>
<OwnerFIO>RFAAUD</OwnerFIO>
<PurchaseOrderId>10030</PurchaseOrderId>
<UserId>0</UserId>
<PassthroughModeFlag>false</PassthroughModeFlag>
<LoginId xsi:nil="true" />
<EShopId>452101</EShopId>
<HttpRequestErrorCount>0</HttpRequestErrorCount>
<HttpRequests />
<Rrn />
<PurchaseData>
<Id>37166</Id>
<PurchaseMoney>
<Amount>120.0000</Amount>
<Currency>TST</Currency>
</PurchaseMoney>
<OrderId>10030</OrderId>
<Name>Test Invoice</Name>
<BackUrl />
<SuccessMethod xsi:nil="true" />
<FailMethod xsi:nil="true" />
<EshopId>452101</EshopId>
<EshopUrl>http://TestEShop.ru</EshopUrl>
<EshopName>TestEShop</EshopName>
<SMSEnable>true</SMSEnable>
<UserEmail>v.satushev+100@intellectmoney.ru</UserEmail>
<IsHeldByEshop>false</IsHeldByEshop>
<ParseUserFields />
</PurchaseData>
<IsCanEnrollmentByDisabledMethod>false</IsCanEnrollmentByDisabledMethod>
<InvoiceChangeAmountHistoryData />
<OriginalAmount>
<Amount>120.0000</Amount>
<Currency>TST</Currency>
</OriginalAmount>
<FormType>None</FormType>
<OrganizationName>RFAAUD</OrganizationName>
</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 | Внутренний номер покупки поставщика |
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 | Создан | Счёт к оплате создан и теперь его состояние можно отслеживать методом getPurchaseInfo(). Никаких платёжных операций не производилось. |
PartPaid | Частично оплачен | Пользователь (Покупатель), внес часть средств. Пользователю (Покупателю) надо внести оставшуюся часть суммы. |
Paid | Полностью оплачен | Пользователь внес всю сумму. |
ToPaid | В процессе обработки | Над денежными средствами производятся действия. |
Refund | Возврат | Средства будут возвращены Пользователю (Покупателю). |
Held | Захолдирован | Средства заморожены (захолдированы/ holded) на счёте Пользователя (Покупателя). Данные средства будут зачислены или расхолдированы (вернутся Пользователю) по истечению времени заморозки (холдирования) или пока не будут зачислены вручную. Поведение денежных средств определяется в настройках магазина на вкладке "Приём платежей" в разделе "Расширенные настройки". |
Table of Contents | ||
---|---|---|
|