EscrowService
Сервис по продаже услуг/товаров с гарантией.
Escrow — депонирование у третьего лица денежной суммы на имя другого лица с тем, чтобы она была выдана ему лишь после выполнения известного условия.
The following operations are supported. For a formal definition, please review the Service Description.
-
ArbitrageCreateClaim
Создание претензии в WebMoney.Arbitrage
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе, например WMID пользователя
dealId - ID сделки
hash - подпись запроса (способ формирования поля hash)
Возвращаемые параметры
claimUrl - ссылка на созданную претензию в WebMoney.Arbitrage
Возвращаемое значение
код ошибки или 0, если ошибок нет (список кодов) -
ArbitrageCreateLawsuit
Создание иска в WebMoney.Arbitrage
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе, например WMID пользователя
dealId - ID сделки
hash - подпись запроса
Возвращаемые параметры
claimUrl - ссылка на созданный иск в WebMoney.Arbitrage
Возвращаемое значение
код ошибки или 0, если ошибок нет -
CheckContractStateAndNotifyIfRequired
Отправка нотификаций для предложения
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
id - ID предложения
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
CheckDealStateAndNotifyIfRequired
Отправка нотификаций для сделки
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
id - ID сделки
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractAccept
Подтверждение предложения с выписыванием счета
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
contractId - ID предложения
purse - кошелек пользователя
tranId - ID транзакции, по которой была произведена оплата залога
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractAcceptMerchant
Подтверждение предложения при использовании WebMoney.Merchant
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
contractId - ID предложения
purse - кошелек пользователя
tranId - ID транзакции, по которой была произведена оплата залога
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractCancel
Отмена предложения
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
contractId - ID предложения
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractCheckInvoice
Проверка оплаты счета
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
contractId - ID предложения
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractCreate
Создание предложения
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
amount - сумма сделки
amountCurrencyId - ID валюты для поля amount
seller - класс ExtUserInfo описывающий параметры продавца
buyer - класс ExtUserInfo описывающий параметры покупателя
currencyId - ID валюты
description - описание сделки
count - количество
duration - длительность оферты в днях
durationToDeal - срок в днях для заключения сделки
depositToSeller - признак оплаты залогом покупателя
hash - подпись запроса
Возвращаемые параметры
contractId - ID созданного предложения
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractGetById
Получить предложение по ID
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
contractId - ID предложения
hash - подпись запроса
Возвращаемые параметры
contractInfo - строка в формате JSON описывающая объект ContractInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractGetByVersionId
Получить предложение по номеру версии
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
contractId - ID предложения
versionId - ID версии
hash - подпись запроса
Возвращаемые параметры
contractInfo - строка в формате JSON описывающая объект ContractInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractGetChanges
История изменений предложения
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
contractId - ID предложения
hash - подпись запроса
Возвращаемые параметры
contracts - строка в формате JSON описывающая массив объектов ContractInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractGetChangesLite
История изменений предложения (облегченная версия)
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
contractId - ID предложения
hash - подпись запроса
Возвращаемые параметры
contracts - строка в формате JSON описывающая массив объектов ContractInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractStepsCanCreate
Проверка возможности создать этап выполнения предложения
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
contractId - ID предложения
stepDate - дата следующего этапа
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractStepsDelete
Удаление этапа предложения
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
stepId - ID этапа
contractId - ID предложения
hash - подпись запроса
Возвращаемые параметры
newStepId - ID этапа предложения
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractStepsGet
Получить этапы выполнения предложения
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
contractId - ID предложения
duration - длительность
hash - подпись запроса
Возвращаемые параметры
steps - строка в формате JSON описывающая массив объектов ContractStepInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractStepsUpdate
Редактирование этапа сделки
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
stepId - ID этапа
contractId - ID предложения
stepDate - дата следующего этапа
description - описание
complete - флаг, отвечающий за завершенность этапа
hash - подпись запроса
Возвращаемые параметры
newStepId - ID этапа предложения
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractUpdate
Изменить предложение
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
contractId - ID предложения
amount - сумма сделки
amountCurrencyId - ID валюты для поля amount
seller - класс ExtUserInfo описывающий параметры продавца
buyer - класс ExtUserInfo описывающий параметры покупателя
currencyId - ID валюты
description - описание сделки
count - количество
duration - длительность оферты в днях
durationToDeal - срок в днях для заключения сделки
depositToSeller - признак оплаты залогом покупателя
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
ContractsGet
Получить предложения отфильтрованные по статусу
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
status - статус. 0 – без фильтра по статусу
hash - подпись запроса
Возвращаемые параметры
contracts - строка в формате JSON описывающая массив объектов ContractInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
CurrenciesGet
Список доступных валют для сервиса
Входные параметры
serviceId - ID сервиса
Возвращаемые параметры
currencies - строка в формате JSON описывающая массив объектов CurrencyInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
DealCancel
Отмена сделки
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
dealId - ID сделки
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
DealGetById
Получить сделки по ID
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
dealId - ID сделки
hash - подпись запроса
Возвращаемые параметры
offerInfo - строка в формате JSON описывающая объект DealInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
DealProlong
Продлить сделку
Входные параметры
serviceId - ID сервиса
dealId - ID сделки
userId - ID пользователя в системе
days - количество дней на которое нужно продлить сделку
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
DealSuccess
Подтверждение сделки
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
dealId - ID сделки
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
DealsGet
Получить сделки отфильтрованные по статусу
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
status - статус. 0 – без фильтра по статусу
hash - подпись запроса
Возвращаемые параметры
deals - строка в формате JSON описывающая массив объектов DealInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
GetErrorMessage
Расшифровка кода ошибки
Входные параметры
serviceId - ID сервиса
code - код ошибки
locale - локаль, язык на котором будет выведено сообщение. например (ru, ru-Ru, en, en-US и т.д.)
Возвращаемые параметры
message - расшифровка ошибки на выбранной локали
Возвращаемое значение
код ошибки или 0, если ошибок нет -
GetStatusMessage
Расшифровка кода статуса
Входные параметры
serviceId - ID сервиса
code - код статуса
statusType - тип. 1 - оферта, 2 - предложение, 3 - сделка
locale - локаль, язык на котором будет выведено сообщение. например (ru, ru-Ru, en, en-US и т.д.)
Возвращаемые параметры
message - расшифровка ошибки на выбранной локали
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OfferAccept
Принять оферту
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
offerId - ID оферты
phone - мобильный телефон пользователя
purse - кошелек пользователя
count - количество, на которое претендует пользователь в оферте
hash - подпись запроса
Возвращаемые параметры
contractId - ID созданного предложения
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OfferCreate
Создать оферту
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
amount - сумма сделки
amountCurrencyId - ID валюты для поля amount
seller - класс ExtUserInfo описывающий параметры продавца
buyer - класс ExtUserInfo описывающий параметры покупателя
currencyId - ID валюты
description - описание сделки
tags - теги, описывающие сделку
count - количество
countMeasure - размерность для параметра count
duration - длительность оферты в днях
durationToContract - срок в днях для заключения предложения
durationToDeal - срок в днях для заключения сделки
offerType - тип оферты. 1 - адресная оферта, 2 - оферта, на которою может подписаться любой пользователь
depositToSeller - признак оплаты залогом покупателя
hash - подпись запроса
Возвращаемые параметры
offerId - ID созданной оферты
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OfferDelete
Удалить оферту
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
offerId - ID оферты
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OfferGetById
Получить оферту по ID
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
offerId - ID оферты
hash - подпись запроса
Возвращаемые параметры
offerInfo - строка в формате JSON описывающая объект OfferInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OfferPublish
Опубликовать оферту
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
offerId - ID оферты
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OfferUnpublish
Снять оферту с публикации
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
offerId - ID оферты
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OfferUpdate
Изменить оферту
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
offerId - ID оферты
amount - сумма сделки
amountCurrencyId - ID валюты для поля amount
seller - класс ExtUserInfoJson описывающий параметры продавца
buyer - класс ExtUserInfoJson описывающий параметры покупателя
currencyId - ID валюты
description - описание сделки
tags - теги, описывающие сделку
count - количество
countMeasure - размерность для параметра count
duration - длительность оферты в днях
durationToContract - срок в днях для заключения предложения
durationToDeal - срок в днях для заключения сделки
offerType - тип оферты. 1 - адресная оферта, 2 - оферта, на которою может подписаться любой пользователь
depositToSeller - признак оплаты залогом покупателя
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OfferUsersAdd
Подписка пользователя на оферту
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
offerId - ID оферты
purse - кошелек пользователя
phone - мобильный телефон пользователя
count - количество, на которое претендует пользователь в оферте
userId - ID пользователя в системе
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OfferUsersDelete
Отписка пользователя от оферты
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
offerId - ID оферты
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OfferUsersGet
Получить информацию о пользователях по ID оферты
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
offerId - ID оферты
hash - подпись запроса
Возвращаемые параметры
offers - строка в формате JSON описывающая массив объектов OfferUserInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OfferUsersGetById
Получить информацию о пользователе по ID оферты
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
offerId - ID оферты
hash - подпись запроса
Возвращаемые параметры
offerUserInfo - строка в формате JSON описывающая массив объектов OfferUserInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OfferUsersGetByUserId
Получить список пользователей оферты
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
hash - подпись запроса
Возвращаемые параметры
offers - строка в формате JSON описывающая массив объектов OfferInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OffersGet
Получить оферты отфильтрованные по статусу
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
status - статус. 0 – без фильтра по статусу
hash - подпись запроса
Возвращаемые параметры
offers - строка в формате JSON описывающая массив объектов OfferInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OffersGetByCategory
Получить оферты по категории
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
categoryId - ID категории
hash - подпись запроса
Возвращаемые параметры
offers - строка в формате JSON описывающая массив объектов OfferInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OffersGetByService
Получить оферты отфильтрованые по ID сервиса
Входные параметры
serviceId - ID сервиса
hash - подпись запроса
Возвращаемые параметры
offers - строка в формате JSON описывающая массив объектов OfferInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
OffersSearch
Поиск по офертам
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
search - строка для поиска
hash - подпись запроса
Возвращаемые параметры
offers - строка в формате JSON описывающая массив объектов OfferInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
SetUserLocale
Установка локали пользователя
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
locale - локаль, язык. например (ru, ru-Ru, en, en-US и т.д.)
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет -
UserProfileGet
Профиль пользователя
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе, например WMID пользователя
hash - подпись запроса
Возвращаемые параметры
userInfo - строка в формате JSON описывающая объект UserProfileInfo
Возвращаемое значение
код ошибки или 0, если ошибок нет -
UserProfileUpdate
Обновление профиля пользователя
Входные параметры
serviceId - ID сервиса
userId - ID пользователя в системе
tags - теги, для описания и поиска пользователя
hash - подпись запроса
Возвращаемое значение
код ошибки или 0, если ошибок нет