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

Compare with Current View Page History

« Previous Version 27 Next »

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

Данное API на текущий момент реализации позволяет запросить реестр платежей. Взаимодействие между сервером IntellectMoney и клиентом API происходит по HTTP-протоколу.

В ответ приходят два состояния запроса это <OperationState> и <Response>:

  1. <OperationState> сообщает - смогла ли система IntellectMoney обработать данный запрос. Возможны три варианта:
    1. Система обработала запрос.
    2. Система поставила запрос в очередь на обработку.
    3. Система не смогла обработать запрос.
  2. <Response> сообщает статус запроса - был ли найден данный метод, все ли параметры переданы верно и так далее. 

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

СЛОВАРЬ ТЕРМИНОВ

  • СКО — Счет К Оплате, инвойс

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

Для доступа к API следует получить ключ доступа через операцию аутентификации клиента getUserToken. Данный ключ является обязательным параметром для всех операций API.

GETUSERTOKEN() — АУТЕНТИФИКАЦИЯ КЛИЕНТА API

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

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

https://api.intellectmoney.ru/personal/user/getUserToken

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

Название

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

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

Описание

Логин

Login

Да

Логин пользователя юридического лица (магазина).

Пароль

Password

Да

Пароль пользователя юридического лица (магазина).

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

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

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

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


Пример запроса
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
Пример ответа
<?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>


GETINVOICESHISTORY() — ПОЛУЧЕНИЕ РЕЕСТРА ПЛАТЕЖЕЙ

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

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

https://api.intellectmoney.ru/personal/payment/getPaymentsHistory

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

Название

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

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

Описание

Ключ доступаUserTokenДаКлюч доступа клиента к API, запрашиваемый операцией аутентификации клиента getUserToken.

ID магазина

EshopId

Да

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

Статус СКО

State

Нет

Запрос реестра платежей только с указанным статусом СКО (см. <InvoiceState>)
Номер СКОInvoiceIdНетЗапрос информации только по одному СКО по его номеру
Дата начала выборкиDateFromНетЗапрос реестра платежей с датой последних изменений СКО, входящей в период выборки в формате ДД.ММ.ГГГГ.
Дата окончания выборкиDateToНет
Ограничение выборки по количеству объектовSkipНет

Количество объектов, пропускаемых перед отдачей

Поддержка параметра планируется в будущих релизах


Ограничение выборки по количеству объектовTakeНет

Ограничение на количество возвращаемых объектов

Поддержка параметра планируется в будущих релизах


Использование параметров

При выборке данных используется конъюнкция параметров. Например, в случае, если переданы параметры "Статус СКО" и "Номер СКО", то результат запрос вернет объект СКО только при его наличии с переданными номером и статусом.

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

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

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

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


Пример запроса
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
Пример ответа
<?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>


ТИПЫ ДАННЫХ

<Response>

Поле

Тип

Описание

OperationState

<OperationState>

Статус выполнения операции

OperationId

GUID

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

EshopId

int

ID магазина

Result

MethodResult

Результат выполнения запроса. Зависит от типа запроса. В случае асинхронной обработки запроса данного поля не будет.

<OperationState>

Поле

Тип

Описание

State

<ServiceOperatonState>

Статусы выполнения запросов

Desc

string

Описание кода статуса выполнения запроса

<UserTokenData>

Поле

Тип

Описание

State

<RequestState>

Статусы выполнения запросов

UserToken

string

Ключ доступа клиента к API

<InvoicesHistoryListData>

Поле

Тип

Описание

State

<RequestState>

Статусы выполнения запросов

InvoicesHistoryList

List<InvoiceData>

Список (реестр) платежей

<InvoiceData>

Поле

Тип

Описание

Id

long

Номер СКО

State

<InvoiceState>

Статус состояния СКО

CreationDateDateTimeДата создания СКО
ChangeDateDateTimeДата последних изменений СКО
Amount<Money>Сумма СКО с учётом комиссии
CurrentAmount<Money>Оплаченная сумма СКО
SurchargeAmount<Money>Сумма СКО, которую осталось оплатить, если счёт уже оплачен - покажет 0
CommentstringКомментарий к платежу
EShopIdlongНомер магазина в системе IntellectMoney
PurchaseOrderIdstringВнутренний номер покупки (заказа) в магазине

Свойства <InvoiceData>

Свойства типа данных <InvoiceData>, приведенные в примере ответа на запрос, но не описанные выше, следует игнорировать в текущей версии API.

<Money>

Поле

Тип

Описание

AmountdecimalКоличество денежных средств.
Currency<Currency>В какой валюте исчисляются денежные средства.

ПЕРЕЧИСЛЕНИЯ

Коды операций

ServiceOperatonState

Описание

0

Успешно обработана

1

В процессе выполнения

2

Ошибка

Статусы запросов

Код ошибки

Описание

0

Успешно обработан

1

Обработан с предупреждениями

2

Аутентификация не пройдена

Описание принимаемых валют

Название

Описание

RUB

Валюта оплаты - Российский рубль
TSTВнутренняя тестовая валюта оплаты

Статусы состояния СКО

InvoiceState

Числовое представление

Описание

Пояснение

Created0СозданСчёт к оплате создан и теперь его состояние можно отслеживать методом getPurchaseInfo(). Никаких платёжных операций не производилось.
PartPaid1Частично оплаченПользователь (Покупатель), внес часть средств. Пользователю (Покупателю) надо внести оставшуюся часть суммы.
Paid2Полностью оплаченПользователь внес всю сумму.
ToPaid3В процессе обработки

Над денежными средствами производятся действия.

Refund4ВозвратСредства будут возвращены Пользователю (Покупателю).
Held6Захолдирован

Средства заморожены (захолдированы/ holded) на счёте Пользователя (Покупателя).

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

Поведение денежных средств определяется в настройках магазина на вкладке "Приём платежей" в разделе "Расширенные настройки".

  • No labels