ADVCash. Merchant APIsystemAccountName String Ник пользователя в системе, который владеет API arg1 Enumeration Тип транзакции (раздел

Платёжная система AdvCash.Merchant API. Версия 1.4

Merchant APIВерсия 1.0

1

Merchant APIВерсия 1.4


Содержание:

Merchant APIТребованияСоздание нового Merchant APIРасположение WSDL-файлаДоступные операции

1. validateAccounts. Проверка наличия аккаунтов.2. validateTransfer. Валидация внутрисистемного перевода.3. validateAdvcashCardTransfer. Валидация перевода средств на карту

Advanced Cash.4. validateBankCardTransfer. Валидация вывода средств на внешнюю карту,

не привязанную к системе.5. validateWithdrawalThroughExternalPaymentSystem. Валидация вывода

средств на стороннюю платежную систему.6. validateCurrencyExchange . Валидация обмена валют .7. validateEmailTransfer. Валидация перевода средств

незарегистрированному пользователю по e-mail.8. makeTransfer. Внутрисистемный платеж.9. transferAdvcashCard. Перевод средств на карту Advanced Cash.10. transferBankCard. Вывод средств на внешнюю банковскую карту.11. withdrawalThroughExternalPaymentSystem. Вывод средств на стороннюю

платежную систему.12. makeCurrencyExchange. Внутрисистемный обмен валют.13. emailTransfer. Вывод средств незарегистрированному пользователю по

e-mail.14. history. История транзакций.15. findTransaction. Поиск транзакции по ID.16. getBalance s. Получение баланса по кошелькам пользователя.17. v alidateAccount. Проверка совпадения имени и фамилии пользователя в

системе Advanced Cash с именем и фамилией пользователя в сторонней системе.

Перечисляемые типы данныхТипы транзакцийВалютыСтатусы транзакцийИмена транзакцийС торонние платежные системыИсключения

АутентификацияСоздание authentication token

История изменений

2


Merchant API

Требования

● Работа по HTTPS протоколу.● Блокирование API запросов через proxy servers.● HTTP запрос должен содержать корректный “User-Agent” HTTP заголовок и

должен быть включен во все запросы. В разделе Merchant инструменты на фронтенде доступны операции управлениясвоими Merchant API:

● создание нового,● просмотр и редактирование существующих● удаление

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

Создание нового Merchant API

● API Name - любое уникальное (в рамках данного аккаунта) слово илисловосочетание (обязательно)

● Requesting IP Addresses — IP-адрес, с которого клиент (клиентское приложение)будет обращаться к Advanced Cash приложению (необязательно, норекомендуется)

● Security Word - сочетание латинских букв и цифр, не менее 6 знаков (обязательно)● Enabled/Disabled — включение/выключение Merchant API● Выбор операций (API operations) (Если не включено, то не доступно)

1. Check accounts. Проверка наличия аккаунтов2. See balance per wallet. Получение баланса по своим кошелькам3. Find transaction. Поиск транзакций по имени4. Transaction history. Получение истории транзакций5. Make transaction. Выполнение транзакций

● Выбор лимитов по кошелькам. Список всех кошельков с полем ввода лимита. Поумолчанию у всех «0»

● Пароль текущего ППП

3


Расположение WSDL-файлаhttps://wallet.advcash.com:8443/wsm/merchantWebService

Доступные операции

1. validateAccounts. Проверка наличия аккаунтов.

Параметры запросаПараметр Внутренний параметр Тип Описаниеarg0 apiName String Название API в системе Advanced Cash

authenticationToken String Сгенерированный токен (раздел “Аутентификация”)systemAccountName String Ник пользователя в системе, который владеет API

arg1 String Ник пользователя для проверки на наличие

Параметры успешного ответаПараметр Внутренний параметр Тип Описаниеreturn systemAccountName String Ник пользователя в системе Advanced Cash

present Boolean Индикатор наличия пользователя в системе Advanced Cash

Пример запроса:soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:validateAccounts> <arg0> <apiName>api_name</apiName>

<authenticationToken>token</authenticationToken> <systemAccountName>account_name</systemAccountName> </arg0> <arg1>hebe</arg1> <arg1>jnixable</arg1> <arg1>maxim</arg1> <arg1>business</arg1> <arg1>account</arg1> </wsm:validateAccounts> </soapenv:Body></soapenv:Envelope>

4

https://wallet.advcash.com:8443/wsm/merchantWebService


Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:validateAccountsResponse xmlns:ns2="http://wsm.advcash/"> <return> <present>true</present> <systemAccountName>hebe</systemAccountName> </return> <return> <present>true</present> <systemAccountName>jnixable</systemAccountName> </return> <return> <present>false</present> <systemAccountName>maxim</systemAccountName> </return> <return> <present>false</present> <systemAccountName>business</systemAccountName> </return> <return> <present>false</present> <systemAccountName>account</systemAccountName> </return> </ns2:validateAccountsResponse> </soap:Body></soap:Envelope>

5


2. validateTransfer. Валидация внутрисистемного перевода.



arg1 Enumeration Тип транзакции (раздел “Типы транзакций”)arg2 amount Double Сумма транзакции (точность - до двух знаков после

запятой)comment String Комментарий к транзакцииdestWalletId String Кошелек получателя платежаsavePaymentTemplate Boolean Индикатор сохранения текущего шаблона платежаsrcWalletId String Кошелек отправителя платежа

В случае успешной валидации предполагаемого платежа, ответ от сервера будетсодержать пустое сообщение. При не успешной валидации в теле сообщениявернется ошибка.

Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:validateTransfer> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1>TRANSFER_INNER_SYSTEM</arg1> <arg2> <amount>10</amount> <comment>Some comment</comment> <destWalletId>U000000000000</destWalletId> <savePaymentTemplate>false</savePaymentTemplate> <srcWalletId>U993960083199</srcWalletId> </arg2> </wsm:validateTransfer> </soapenv:Body></soapenv:Envelope>

Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:validateTransferResponse xmlns:ns2="http://wsm.advcash/"/> </soap:Body></soap:Envelope>

6


3. validateAdvcashCardTransfer. Валидация перевода средств на карту Advanced Cash.



arg1 amount Double Сумма транзакции (точность - до двух знаков после запятой)

cardNumber String Номер карты Advanced Cash для вывода средствsrcWalletId String Кошелек отправителя платежа

В случае успешной валидации предполагаемого платежа, ответ от сервера будет содержать пустое сообщение. При не успешной валидации в теле сообщения вернется ошибка.

Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:validateAdvcashCardTransfer> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1> <amount>10</amount> <cardNumber>5144478627620523</cardNumber> <srcWalletId>U993960083199</srcWalletId> </arg1> </wsm:validateAdvcashCardTransfer> </soapenv:Body></soapenv:Envelope>

Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:validateAdvcashCardTransferResponse xmlns:ns2="http://wsm.advcash/"/> </soap:Body></soap:Envelope>

7


4. validateBankCardTransfer. Валидация вывода средств на внешнюю карту, не привязанную к системе.

Параметры запроса:Параметр Внутренний параметр Тип Описаниеarg0 apiName String Название API в системе Advanced Cash



cardNumber String Номер внешней карты для вывода средствtransferCurrency String Валюта перевода (3 символа ISO 4217, раздел “Валюты”)

expiryMonth Numeric Две цифры, означающие месяц, в котором истечет срок действия карты (к примеру, 09 для сентября)

expiryYear Numeric Две последние цифры года, в котором истечет срок действия карты (к примеру, 17 для 2017 года)

savePaymentTemplate Boolean Индикатор сохранения текущего шаблона платежаsrcWalletId String Кошелек отправителя платежа


Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:validateBankCardTransfer> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1> <amount>5</amount> <cardNumber>4149605912035536</cardNumber> <transferCurrency>USD</transferCurrency> <expiryMonth>08</expiryMonth> <expiryYear>17</expiryYear> <savePaymentTemplate>false</savePaymentTemplate> <srcWalletId>U993960083199</srcWalletId> </arg1> </wsm:validateBankCardTransfer> </soapenv:Body></soapenv:Envelope>

8


Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:validateBankCardTransferResponse xmlns:ns2="http://wsm.advcash/"/> </soap:Body></soap:Envelope>

9


5. validateWithdrawalThroughExternalPaymentSystem. Валидация вывода на стороннюю платежную систему.




currency Enumeration

Валюта перевода (3 символа ISO 4217, раздел “Валюты”)

externalPaymentSystem Enumeration

Сторонняя платежная система (раздел “Сторонние платежные системы”)

receiver String Идентификатор или кошелек получателя в сторонней платежной системе

savePaymentTemplate Boolean Индикатор сохранения текущего шаблона платежаcomment String Комментарий к транзакции


Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:validateWithdrawalThroughExternalPaymentSystem> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1> <amount>1.00</amount> <comment>Some comment</comment> <currency>RUR</currency> <externalPaymentSystem>YANDEX_ELECTRONIC_MONEY</externalPaymentSystem> <receiver>410022528972199</receiver> <savePaymentTemplate>false</savePaymentTemplate> </arg1> </wsm:validateWithdrawalThroughExternalPaymentSystem> </soapenv:Body></soapenv:Envelope>

Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:validateWithdrawalThroughExternalPaymentSystem xmlns:ns2="http://wsm.advcash/"/> </soap:Body></soap:Envelope>

10


6. validateCurrencyExchange. Валидация обмена валют.




comment String Комментарий к транзакцииdestWalletId String Кошелек получателя платежаsavePaymentTemplate Boolean Индикатор сохранения текущего шаблона платежаsrcWalletId String Кошелек отправителя платежа


Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:validateCurrencyExchange> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1> <amount>5</amount> <comment>Some comment</comment> <destWalletId>E060990630681</destWalletId> <savePaymentTemplate>false</savePaymentTemplate> <srcWalletId>U993960083199</srcWalletId> </arg1> </wsm:validateCurrencyExchange> </soapenv:Body></soapenv:Envelope>

Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:validateCurrencyExchangeResponse xmlns:ns2="http://wsm.advcash/"/> </soap:Body></soap:Envelope>

11


7. validateEmailTransfer. Валидация перевода средств незарегистрированному пользователю по e-mail.




comment String Комментарий к транзакцииtransferCurrency String Валюта перевода (3 символа ISO 4217, раздел

“Валюты”)email String Электронный почтовый адрес незарегистрированного в

Advanced Cash получателя платежа (Сразу после регистрации в системе Advanced Cash пользователь получит денежный перевод)

srcWalletId String Кошелек отправителя платежа


Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:validateEmailTransfer> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1> <amount>5</amount> <comment>Some comment</comment> <transferCurrency>USD</transferCurrency> <email>[email protected]</email> <srcWalletId>U993960083199</srcWalletId> </arg1> </wsm:validateEmailTransfer> </soapenv:Body></soapenv:Envelope>

12


Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:validateEmailTransferResponse xmlns:ns2="http://wsm.advcash/"/> </soap:Body></soap:Envelope>

13


8. makeTransfer. Внутрисистемный платеж.



arg1 Enumeration Тип транзакции (раздел “Типы транзакций”)arg2 amount Double Сумма транзакции (точность - до двух знаков после

запятой)comment String Комментарий к транзакцииdestWalletId String Кошелек получателя платежаsavePaymentTemplate Boolean Индикатор сохранения текущего шаблона платежаsrcWalletId String Кошелек отправителя платежа

Параметры успешного ответаПараметр Внутренний параметр Тип Описаниеreturn String ID совершенной транзакции

Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:makeTransfer> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1>TRANSFER_INNER_SYSTEM</arg1> <arg2> <amount>5</amount> <comment>Some comment</comment> <destWalletId>U000000000000</destWalletId> <savePaymentTemplate>false</savePaymentTemplate> <srcWalletId>U993960083199</srcWalletId> </arg2> </wsm:makeTransfer> </soapenv:Body></soapenv:Envelope>

Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:makeTransferResponse xmlns:ns2="http://wsm.advcash/"> <return>d1062eba-29b7-456c-b6ad-2ca734af4924</return> </ns2:makeTransferResponse> </soap:Body></soap:Envelope>

14


9. transferAdvcashCard. Перевод средств на карту Advanced Cash.




cardNumber String Номер карты Advanced Cash для вывода средствsrcWalletId String Кошелек отправителя платежа


Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:transferAdvcashCard> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1> <amount>5</amount> <cardNumber>5144478627620523</cardNumber> <srcWalletId>U993960083199</srcWalletId> </arg1> </wsm:transferAdvcashCard> </soapenv:Body></soapenv:Envelope>

Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:transferAdvcashCardResponse xmlns:ns2="http://wsm.advcash/"> <return>7514204c-d4fe-4617-ac79-241703443946</return> </ns2:transferAdvcashCardResponse> </soap:Body></soap:Envelope>

15


10. transferBankCard. Вывод средств на внешнюю банковскую карту.




cardNumber String Номер внешней карты для вывода средствtransferCurrency String Валюта перевода (3 символа ISO 4217, раздел

“Валюты”)expiryMonth Numeric Две цифры, означающие месяц, в котором истечет срок

действия карты (к примеру, 09 для сентября)expiryYear Numeric Две последние цифры года, в котором истечет срок

действия карты (к примеру, 17 для 2017 года)savePaymentTemplate Boolean Индикатор сохранения текущего шаблона платежаsrcWalletId String Кошелек отправителя платежа


Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:transferBankCard> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1> <amount>5</amount> <cardNumber>4149605912035536</cardNumber> <transferCurrency>USD</transferCurrency> <expiryMonth>08</expiryMonth> <expiryYear>17</expiryYear> <savePaymentTemplate>false</savePaymentTemplate> <srcWalletId>U993960083199</srcWalletId> </arg1> </wsm:transferBankCard> </soapenv:Body></soapenv:Envelope>

16


Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:transferBankCardResponse xmlns:ns2="http://wsm.advcash/"> <return>20931ce4-f4c9-4cc5-84f7-f7efb38c939c</return> </ns2:transferBankCardResponse> </soap:Body></soap:Envelope>

17


11. withdrawalThroughExternalPaymentSystem. Вывод средств на стороннюю платежную систему.




currency Enumeration

Валюта перевода (3 символа ISO 4217, раздел “Валюты”)

externalPaymentSystem Enumeration

Сторонняя платежная система (раздел “Сторонние платежные системы”)

receiver String Идентификатор или кошелек получателя в сторонней платежной системе

savePaymentTemplate Boolean Индикатор сохранения текущего шаблона платежаcomment String Комментарий к транзакции


Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:withdrawalThroughExternalPaymentSystem> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1> <amount>1.00</amount> <comment>Some comment</comment> <currency>RUR</currency> <externalPaymentSystem>YANDEX_ELECTRONIC_MONEY</externalPaymentSystem> <receiver>410022528972199</receiver> <savePaymentTemplate>false</savePaymentTemplate> </arg1> </wsm:withdrawalThroughExternalPaymentSystem> </soapenv:Body></soapenv:Envelope>

18


Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:withdrawalThroughExternalPaymentSystem xmlns:ns2="http://wsm.advcash/"> <return>d1062eba-29b7-456c-b6ad-2ca734af4924</return> </ns2:withdrawalThroughExternalPaymentSystem> </soap:Body></soap:Envelope>

19


12. makeCurrencyExchange. Внутрисистемный обмен валют.




comment String Комментарий к транзакцииdestWalletId String Кошелек получателя платежаsavePaymentTemplate Boolean Индикатор сохранения текущего шаблона платежаsrcWalletId String Кошелек отправителя платежа

arg2 isAmountInSrcWalletCurrency

Boolean Сумма указана в валюте кошелька отправителя

Параметры успешного ответа:Параметр Внутренний параметр Тип Описаниеreturn String ID совершенной транзакции

Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:makeCurrencyExchange> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1> <amount>5</amount> <comment>Some comment</comment> <destWalletId>E060990630681</destWalletId> <savePaymentTemplate>false</savePaymentTemplate> <srcWalletId>U993960083199</srcWalletId> </arg1> <arg2>true</arg2> </wsm:makeCurrencyExchange> </soapenv:Body></soapenv:Envelope>

Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:makeCurrencyExchangeResponse xmlns:ns2="http://wsm.advcash/"> <return>1575948b-6ead-426f-8ecf-ee7ffaa3969c</return> </ns2:makeCurrencyExchangeResponse> </soap:Body></soap:Envelope>

20


13. emailTransfer. Вывод средств незарегистрированному пользователю по e-mail.




comment String Комментарий к транзакцииtransferCurrency String Валюта перевода (3 символа ISO 4217, раздел “Валюты”)email String Электронный почтовый адрес незарегистрированного в

Advanced Cash получателя платежа (Сразу после регистрации в системе Advanced Cash пользователь получит денежный перевод)

srcWalletId String Кошелек отправителя платежа

Параметры успешного ответа:Параметр Внутренний параметр Тип Описаниеreturn String ID совершенной транзакции

Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:emailTransfer> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1> <amount>5</amount> <comment>Some comment</comment> <transferCurrency>USD</transferCurrency> <email>[email protected]</email> <srcWalletId>U993960083199</srcWalletId> </arg1> </wsm:emailTransfer> </soapenv:Body></soapenv:Envelope>

Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:emailTransferResponse xmlns:ns2="http://wsm.advcash/"> <return>8fa3a69a-c792-4f77-ba06-c880cd836ebc</return> </ns2:emailTransferResponse> </soap:Body></soap:Envelope>

21


14. history. История транзакций.



arg1 accountName Double Сумма транзакции (точность - до двух знаков после запятой)

startTimeFrom Date&Time Начальная дата для выборки транзакций (шаблон - yyyy-MM-dd'T'HH:mm:ss)

startTimeTo Date&Time Конечная дата для выборки транзакций (шаблон - yyyy-MM-dd'T'HH:mm:ss)

transactionName Enumeration Имя транзакции (раздел “Имена транзакций”)transactionStatus Enumeration Статус транзакции (раздел “Статусы транзакций”)updatedFrom Date&Time Начальная дата обновления статуса транзакции для

выборки (шаблон - yyyy-MM-dd'T'HH:mm:ss)updatedTo Date&Time Конечная дата обновления статуса транзакции для

выборки (шаблон - yyyy-MM-dd'T'HH:mm:ss)walletId String Кошелек отправителя платежа (параметр не

обязателен)

Параметры успешного ответаПараметр Внутренний параметр Тип Описаниеreturn id String ID совершенной транзакции

activityLevel Integer Уровень активности инициатора платежа в системеamount Double Сумма транзакции (точность - до двух знаков после

запятой)amountInUSD Double Сумма транзакции в USD (точность - до двух знаков

после запятой)fullCommission Double Комиссия текущей транзакции (точность - до двух

знаков после запятой)startTime Date Дата создания транзакции (шаблон - yyyy-MM-

dd'T'HH:mm:ss'.'SZ)status Enumeration Статус транзакции (раздел “Статусы транзакций”)transactionName Enumeration Имя транзакции (раздел “Имена транзакций”)walletDestId String Кошелек получателя платежаwalletSrcId String Кошелек отправителя платежа

Поля “walletDestId” и “walletSrcId” присутствуют не во всех типах транзакций (“Пример успешного ответа ниже”). “walletSrcId” используется в транзакциях вывода и внутрисистемных транзакциях. “walletDestId” используется в транзакцияхввода и внутрисистемных транзакциях.

Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body>

22


<wsm:history> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1> <accountName>hebe</accountName> <startTimeFrom>2011-01-01T00:00:00</startTimeFrom> <startTimeTo>2014-03-25T12:17:00</startTimeTo> <transactionName>ALL</transactionName> <transactionStatus>COMPLETED</transactionStatus> <updatedFrom>2011-01-01T00:00:00</updatedFrom> <updatedTo>2014-03-25T12:17:00</updatedTo> <walletId>U993960083199</walletId> </arg1> </wsm:history> </soapenv:Body></soapenv:Envelope>

Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:historyResponse xmlns:ns2="http://wsm.advcash/"> <return> <id>1575948b-6ead-426f-8ecf-ee7ffaa3969c</id> <activityLevel>0</activityLevel> <amount>6.97</amount> <amountInUSD>6.97</amountInUSD> <fullCommission>0.07</fullCommission> <startTime>2014-03-25T10:21:59.901+01:00</startTime> <status>COMPLETED</status> <transactionName>CURRENCY_EXCHANGE</transactionName> <walletDestId>E060990630681</walletDestId> <walletSrcId>U993960083199</walletSrcId> </return> <return> <id>20931ce4-f4c9-4cc5-84f7-f7efb38c939c</id> <activityLevel>0</activityLevel> <amount>5.05</amount> <amountInUSD>5.05</amountInUSD> <fullCommission>0.05</fullCommission> <startTime>2014-03-25T10:14:32.203+01:00</startTime> <status>COMPLETED</status> <transactionName>BANK_CARD_TRANSFER</transactionName> </return> <return> <id>7514204c-d4fe-4617-ac79-241703443946</id> <activityLevel>0</activityLevel> <amount>5.05</amount> <amountInUSD>5.05</amountInUSD> <fullCommission>0.05</fullCommission> <startTime>2014-03-25T10:06:38.824+01:00</startTime> <status>COMPLETED</status> <transactionName>ADVCASH_CARD_TRANSFER</transactionName> </return> <return> <id>d1062eba-29b7-456c-b6ad-2ca734af4924</id> <activityLevel>0</activityLevel> <amount>5.05</amount> <amountInUSD>5.05</amountInUSD>

23


<comment>Some comment</comment> <fullCommission>0.05</fullCommission> <startTime>2014-03-25T09:56:02.332+01:00</startTime> <status>COMPLETED</status> <transactionName>INNER_SYSTEM</transactionName> <walletDestId>U000000000000</walletDestId> <walletSrcId>U993960083199</walletSrcId> </return> <return> <id>19a414cb-6c6b-4932-8244-394607d44914</id> <activityLevel>0</activityLevel> <amount>198.00</amount> <amountInUSD>198.00</amountInUSD> <comment/> <fullCommission>2.00</fullCommission> <startTime>2014-03-25T09:42:10.349+01:00</startTime> <status>COMPLETED</status> <transactionName>CHECK_DEPOSIT</transactionName> <walletDestId>U993960083199</walletDestId> </return> <return> <id>4db253ce-2fa4-4a2c-b57b-8ac786cb2f42</id> <activityLevel>0</activityLevel> <amount>5.05</amount> <amountInUSD>5.05</amountInUSD> <fullCommission>0.05</fullCommission> <startTime>2014-03-25T07:46:21.891+01:00</startTime> <status>COMPLETED</status> <transactionName>ADVCASH_CARD_TRANSFER</transactionName> </return> <return> <id>10311368-d5c9-46ca-945a-63bc6b2069ae</id> <activityLevel>0</activityLevel> <amount>6.12</amount> <amountInUSD>8.45</amountInUSD> <comment/> <fullCommission>0.12</fullCommission> <startTime>2014-03-24T15:08:23.943+01:00</startTime> <status>COMPLETED</status> <transactionName>INNER_SYSTEM</transactionName> <walletDestId>U993960083199</walletDestId> <walletSrcId>E814009369319</walletSrcId> </return> <return> <id>79789306-ed1b-4def-a2b4-359eab9e895f</id> <activityLevel>0</activityLevel> <amount>5.05</amount> <amountInUSD>5.05</amountInUSD> <comment>This is transfer inner transaction</comment> <fullCommission>0.05</fullCommission> <startTime>2014-03-24T13:16:02.580+01:00</startTime> <status>COMPLETED</status> <transactionName>INNER_SYSTEM</transactionName> <walletDestId>U000000000000</walletDestId> <walletSrcId>U993960083199</walletSrcId> </return> <return> <id>44bfaf6d-9028-4d9c-8e4b-5129f98ec250</id> <activityLevel>0</activityLevel> <amount>6.00</amount> <amountInUSD>6.00</amountInUSD> <comment/>

24


<fullCommission>0.06</fullCommission> <startTime>2014-03-21T16:07:00.436+01:00</startTime> <status>COMPLETED</status> <transactionName>INNER_SYSTEM</transactionName> <walletDestId>U993960083199</walletDestId> <walletSrcId>U881039916801</walletSrcId> </return> <return> <id>8c75ba94-8042-45f9-ac2d-5ed3781ea9d2</id> <activityLevel>0</activityLevel> <amount>6.00</amount> <amountInUSD>6.00</amountInUSD> <comment/> <fullCommission>0.06</fullCommission> <startTime>2014-03-21T15:41:14.220+01:00</startTime> <status>COMPLETED</status> <transactionName>INNER_SYSTEM</transactionName> <walletDestId>U993960083199</walletDestId> <walletSrcId>U881039916801</walletSrcId> </return> <return> <id>c4d093ee-6e2c-498f-b6e2-994f5ce77e64</id> <activityLevel>0</activityLevel> <amount>6.00</amount> <amountInUSD>6.00</amountInUSD> <comment/> <fullCommission>0.06</fullCommission> <startTime>2014-03-21T10:34:06.269+01:00</startTime> <status>COMPLETED</status> <transactionName>INNER_SYSTEM</transactionName> <walletDestId>U993960083199</walletDestId> <walletSrcId>U881039916801</walletSrcId> </return> <return> <id>e5383553-f66c-4073-b81d-86e7c3756cdb</id> <activityLevel>0</activityLevel> <amount>6.00</amount> <amountInUSD>6.00</amountInUSD> <comment/> <fullCommission>0.06</fullCommission> <startTime>2014-03-21T10:33:37.663+01:00</startTime> <status>COMPLETED</status> <transactionName>INNER_SYSTEM</transactionName> <walletDestId>U993960083199</walletDestId> <walletSrcId>U881039916801</walletSrcId> </return> </ns2:historyResponse> </soap:Body></soap:Envelope>

25


15. findTransaction. Поиск транзакции по ID.



arg1 String ID совершенной транзакции

Параметры успешного ответаПараметр Внутренний параметр Тип Описаниеreturn id String ID совершенной транзакции

activityLevel Integer Уровень активности инициатора платежа в системеamount Double Сумма транзакции (точность - до двух знаков после

запятой)amountInUSD Double Сумма транзакции в USD (точность - до двух знаков

после запятой)fullCommission Double Комиссия текущей транзакции (точность - до двух

знаков после запятой)startTime Date Дата создания транзакции (шаблон - yyyy-MM-

dd'T'HH:mm:ss'.'SZ)status Enumeration Статус транзакции (раздел “Статусы транзакций”)transactionName Enumeration Имя транзакции (раздел “Имена транзакций”)walletDestId String Кошелек получателя платежаwalletSrcId String Кошелек отправителя платежа

Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:findTransaction> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1>e5383553-f66c-4073-b81d-86e7c3756cdb</arg1> </wsm:findTransaction> </soapenv:Body></soapenv:Envelope>

26


Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:findTransactionResponse xmlns:ns2="http://wsm.advcash/"> <return> <id>e5383553-f66c-4073-b81d-86e7c3756cdb</id> <activityLevel>0</activityLevel> <amount>6.00</amount> <amountInUSD>6.00</amountInUSD> <fullCommission>0.06</fullCommission> <startTime>2014-03-21T10:33:37.663+01:00</startTime> <status>COMPLETED</status> <transactionName>INNER_SYSTEM</transactionName> <walletDestId>U993960083199</walletDestId> <walletSrcId>U881039916801</walletSrcId> </return> </ns2:findTransactionResponse> </soap:Body></soap:Envelope>

27


16. getBalances. Получение баланса по кошелькам пользователя.



Параметры успешного ответаПараметр Внутренний параметр Тип Описаниеreturn amount Double Сумма на кошельке (точность - до двух знаков после

запятой)id String Номер кошелька

Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:getBalances> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> </wsm:getBalances> </soapenv:Body></soapenv:Envelope>

Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getBalancesResponse xmlns:ns2="http://wsm.advcash/"> <return> <amount>197.82</amount> <id>U993960083199</id> </return> <return> <amount>5.00</amount> <id>E060990630681</id> </return> <return> <amount>0</amount> <id>R375997875321</id> </return> <return> <amount>0</amount> <id>G112983230977</id> </return> </ns2:getBalancesResponse> </soap:Body></soap:Envelope>

28


17. validateAccount. Проверка совпадения имени и фамилии пользователя в системе Advanced Cash c именем и фамилией пользователя в сторонней системе.



arg1 email String Email пользователя в системе Advanced Cash, для которогобудет производиться сверка имени и фамилии (обязательный, если не указан login)

login String Login пользователя в системе Advanced Cash, для которогобудет производиться сверка имени и фамилии (обязательный, если не указан email)

firstName String Имя пользователя в сторонней системе для сверки с именем пользователя в системе Advanced Cash

lastName String Фамилия пользователя в сторонней системе для сверки с фамилией пользователя в системе Advanced Cash

Параметры успешного ответаПараметр Внутренний параметр Тип Описаниеreturn firstNameMatchingPercent

ageDouble Процент совпадения имени пользователя системы

Advanced Cash с именем пользователя сторонней системы (принимает значения от 0 до 1)

lastNameMatchingPercentage

Double Процент совпадения фамилии пользователя системы Advanced Cash с фамилией пользователя сторонней системы (принимает значения от 0 до 1)

Пример запроса:<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsm="http://wsm.advcash/"> <soapenv:Header/> <soapenv:Body> <wsm:validateAccount> <arg0> <apiName>api_name</apiName> <authenticationToken>token</authenticationToken> <systemAccountName>hebe</systemAccountName> </arg0> <arg1> <email>[email protected]</email> <login></login> <firstName>John</firstName> <lastName>Smith</lastName> </arg1> </wsm:validateAccount> </soapenv:Body></soapenv:Envelope>

29


Пример успешного ответа:<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:validateAccountResponse xmlns:ns2="http://wsm.advcash/"> <return> <firstNameMatchingPercentage>0.75341</firstNameMatchingPercentage> <lastNameMatchingPercentage>1</lastNameMatchingPercentage> </return> </ns2:validateAccountResponse> </soap:Body></soap:Envelope>

30


Перечисляемые типы данных

Типы транзакцийПараметр Возможные значения ОписаниеtransactionType TRANSFER_INNER_SYSTEM Перевод внутри системы Advanced Cash

TRANSFER_INNER_ACCOUNT Перевод внутри аккаунта Advanced Cash

31


Валюты

Параметр Возможные значения ОписаниеtransferCurrency USD Доллар США

EUR ЕвроRUR Российский рубльGBP Фунт стерлингов

32


Статусы транзакций

Параметр Возможные значения

Описание

transactionStatus PENDING Транзакции ждет обработкиPROCESS Транзакция обрабатываетсяCOMPLETED Транзакция завершенаCANCELED Транзакция отмененаCONFIRMED Транзакция подтверждена

33


Имена транзакций

Параметр Возможные значения ОписаниеtransactionName ALL Все транзакции независимо от типа

CHECK_DEPOSIT Ввод средств банковским чекомWIRE_TRANSFER_DEPOSIT Ввод средств с банковского счетаWIRE_TRANSFER_WITHDRAW Вывод средств на банковский счетINNER_SYSTEM Внутрисистемный переводCURRENCY_EXCHANGE Обмен валют внутри аккаунтаBANK_CARD_TRANSFER Вывод средств на внешнюю банковскую картуADVCASH_CARD_TRANSFER Перевод средств на карту Advanced CashEXTERNAL_SYSTEM_DEPOSIT Ввод средств через стороннюю системуEXTERNAL_SYSTEM_WITHDRAWAL Вывод средств на стороннюю системуREPAYMENT Возврат средств

34


Сторонние платежные системы

Параметр Возможные значения ОписаниеexternalPaymentSystem

COINBASE_ELECTRONIC_MONEY Вывод в криптовалюту BTC

EGO_PAY_ELECTRONIC_MONEY Платежная система EgoPayPAXUM_ELECTRONIC_MONEY Платежная система PaxumPAYEER_ELECTRONIC_MONEY Платежная система PayeerPERFECT_MONEY_ELECTRONIC_MONEY

Платежная система Perfect Money

OK_PAY_ELECTRONIC_MONEY Платежная система OkPayYANDEX_ELECTRONIC_MONEY Платежная система Яндекс.Деньги

35


Исключения

Параметр Возможные значения Описаниеexception AccessDeniedException Доступ запрещен

AlreadyExistException Объект уже существуетApiException Ошибка от сторонней системыAttemptsHaveEndedException Количество попыток превзошло максимальноеBadParametersException Некорректный набор параметровBadFormatAmountException Неправильно указана сумма платежаEmailAlreadyExistException Пользователь с таким e-mail адресом уже

зарегистрирован в системе Advanced CashExchangeCurrencyException Ошибка обмена валютIpAddressIsWrongException Неправильный IP-адресLimitPerMonthException Превышен месячный лимит по сумме транзакцийLimitPerDayException Превышен суточный лимит по сумме транзакцийLimitPerTransactionException Превышен лимит транзакцииNotEnoughMoneyException Недостаточно средств для совершения платежаPasswordExpiredException Пароль просроченPasswordIncorrectException Неправильный парольRecipientDoesNotExistException Получатель платежа не найденSenderDoesNotExistException Отправитель платежа не найденTooManyAttemptsException Превышен максимум попытокTooManyWalletsException Превышен максимум кошельковUnsupportedTransaction Данный тип или имя транзакции не поддерживаютсяUserBlockedException Пользователь заблокирован и не может

принимать/совершать платежиUserDoesNotExistException Такого пользователя нет в системе Advanced CashVeryBigAmountException Превышен максимальный лимит для суммы платежаWalletCurrencyIncorrectException Указанная валюта не соответствует валюте на

кошелькеWalletDoesNotExist Такого кошелька не существуетWrongParametersException Некорректные параметры запросаWrongEmailException Некорректный формат e-mail адресаIpInBlackListException Данный IP-адрес находится в черном списке и

пользователь не может производить каких-либо действий с этого IP-адреса

CardDoesNotExistException Такой карты не существуетCardIsNotActiveException Карты с данным номером не активнаCardNumberIsNotValidException Некорректный формат номера карты

36


Аутентификация

Все запросы к API должны содержать информацию, которая позволит серверуподтвердить подлинность обращающегося пользователя. Этот запрос будетсодержать Account name и другую информацию, которая поможет серверу точноидентифицировать пользователя, представляющего запрос. Каждый запроссервера к API должен содержать следующую информацию аутентификации:

● API name.● Authentication token, Этот параметр состоит из захешированного текста,

сформированного связью secret word и даты UTC.● Account name.

37


Создание authentication token

Вы должны создать authentication token с помощью следующего алгоритма:1. Сформировать текст связкой параметров Security Word:Date UTC in YYYYMMDD

format:Time UTC in HH format (only hours, not minutes).2. Данный текст захешировать при помощи алгоритма SHA256.

Пример: secret word - MySecWord, date UTC - 2007.02.25 14:55 (24h format)Текст на основе связки параметров: MySecWord:20070225:14Hash SHA256 для данного текста:

2496da449ae8cd7872a257a1d9bfdf03cf11eb18d2bf1fbcaa68aca135ce1856

38


История изменений

Версия Изменения1.0 -1.1 Удален getWireTransferRequiredData метод.1.2 Из transferadvcashcard и vakidateAdvancedCardTransfer удалены параметры

«destCurrency», «expirlyMonth», «expirlyYear», «savePaymentTemplate» Параметр «destCurrency» переименовано в «transferCurrency» во всех методах.

1.3 Добавлен метод «validateAccount»1.4 Добавлены методы «validateWithdrawalThroughExternalPaymentSystem»,

«withdrawalThroughExternalPaymentSystem»

39

Documents

ADVCash. Merchant APIsystemAccountName String Ник пользователя в системе, который владеет API arg1 Enumeration Тип транзакции (раздел