Методы
Last updated
Last updated
POST /api/v2/token
генерация токена для доступа к API ZaleyCash по секретному ключу
| Name | Type | Description |
|---|---|---|
GET /api/v2/services
Cписок внешних рекламных сетей (без учета скрытых рекламных сетей). Параметр need_oauth указывает, возможно ли создание аккаунта через метод POST /api/v2/account/create или нет (если need_oauth - yes, то создание аккаунта по API невозможно).
GET /api/v2/user?email={email}
Получение информации о пользователе по email. Если email не передан, то метод вернет информацию об учетной записи клиента API. Также вернет статус клиента, активен он или нет (is_active:true/false).
POST /api/v2/user
Регистрация нового пользователя. Между регистратором и новым пользователем устанавливается связь “родитель - сын”. Также новый пользователь становится рефералом клиента
GET /api/v2/user/balance
Получение данных финансовых балансов пользователя. OriginalBalance подразумевает число, которое пользователь видит в шапке сайта, а balance - сумму, доступную к использованию.
GET /api/v2/user/balance/detailed
Получение подробных данных распределения средств по финансовым балансам пользователя. Если счета в списке нет, значит он не существует.
GET /api/v2/user/account?id={id}
Получение информации о своем аккаунте. В id может быть передан любой из идентификаторов, принадлежащих аккаунту.
external_id = ExternalAccount.external_id - внешний идентификатор в системе external_billing_account_id - ExternalAccount.external_billing_account_id - внешний идентификатор счета в системе (релевантно для ВК и Яндекса).
Возможные статусы:
active Активен
blocked Заблокирован
deleted Удален
pending В обработке
rejected Отклонен
blocked_by_system Заблокирован системой
POST /api/v2/user/children
Создание связи между пользователем и пользователем API. Связка позволяет выполнять операции перевода денег
GET /api/v2/user/accounts/list?type={account_alias}&id={ids}&user={id}&account=acc@gmail.com&limit={}&offset={}
Получение списка аккаунтов пользователя для заданного сервиса. Список допустимых значений для account_alias возвращается методом /api/v2/services
Возможна фильтрация аккаунтов по id для заданного параметра type. В id может быть передано несколько идентификаторов разделенных запятой, также в id может быть передан любой из идентификаторов принадлежащих аккаунту, однако все они должны быть одинакового типа. Также в методе присутствует пагинация, по умолчанию возвращается 500 первых аккаунтов. Используйте параметр limit для выбора количества аккаунтов (не рекомендуем отправлять более 1000) и offset для смещения по страницам.
Например у вас 10 акков 1,2,3,4,5,6,7,8,9,10
Вы посылаете limit=3,offset=0
В ответе придут 3 акка: 1,2,3
Вы посылаете limit=3,offset=3
В ответе придут 3 акка: 4,5,6 (то есть произошло смещение на offset))
Возможна выборка аккаунтов по полю account.
Должен присутствовать или параметр id или account. Если указан id, то account будет проигнорирован.
Необязательный параметр user={id} - получение списка аккаунтов дочернего пользователя
Для аккаунтов MyTarget и VK выводится accessToken для прямого доступа к клиентским методам API MyTarget
POST /api/v2/money/transfer
Перевод средств со счета клиента на аккаунты в Yandex.Direct, MyTarget, Google Adwords, VK. Обратите внимание на то, что в запросе присутствуют необязательный параметр “type” он означает тип средств отправляемых в сеть (для некоторых сетей доступен отдельный счет с типом adv, который является рекламным - с него можно перевести деньги исключительно в данную сеть, получить информацию о статусе данных счетов можно в методе GET api/v2/user/balance/detailed), если параметр type НЕ передан, то по умолчанию передается type:normal - средства будут списываться с обычного счета пользователя. В качестве параметра "service" передается alias данного сервиса - информацию о сервисах можно получить в GET api/v2/services. В ответ на /transfer /transfer internal и exchange приходят статусы "accepted" ВСЕГДА, либо код ошибки из начала документа, это означает что транзакция принята сервисом Zaleycash и далее ее статус можно узнать запросив GET /api/v2/money/transaction?operation_id={string}. Это связано с тем, что не все транзакции обрабатываются здесь и сейчас, а попадают в очередь.
NB! Для некоторых площадок существуют лимиты минимально переводимых сумм
POST /api/v2/money/transfer/internal
Перевод средств со счета пользователя на счет пользователя .Параметр currency используется для внутренних переводов
GET /api/v2/money/currencies
Возврат список возможных валют, курс валют в системе и значение комиссии за обмен валют на момент запроса.
POST /api/v2/money/exchange?user={id}
Создание операции обмена валюты на пользователе. В ответ придет 3 операции с разными id - списание, начисление, комиссия
POST /api/v2/money/refund
Возврат средств со счета клиента с аккаунтов в рекламных сетях
GET /api/v2/money/transaction?operation_id={string}
Получение статуса транзакций с номером операции operation_id. Типы транзакций в ответе:
non_cash - безналичный перевод
direct - перевод средств на аккаунт в Yandex.Direct
internal_transfer - перевод дочернему пользователю
Поле direction - направление движения средств: in - пополнение, out - списание
Поле status - статус обработки транзакции: approved - успешное завершение, pending - ожидание подтверждения, blocked - заблокировано по техническим причинам, declined - операция отклонена.
Поле recipient - пользователь, которому проведено начисление.
GET /api/v2/user/transactions?date_from={unix timestamp}&date_to={unix timestamp}
Получение списка транзакций для пользователя API.
date_from - с какой даты получить транзакции (Epoch timestamp)
date_to - до какой даты получить транзакции. (Epoch timestamp)
Если параметры date_from и date_to не заданы, то метод вернет транзакции с начала текущего месяца.
Поле recipient - пользователь, которому проведено начисление.
GET GET /api/v2/countries
Возврат списка алиасов стран
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
access_token*
String
expires_at*
String
name*
String
alias*
String
need_oauth*
String
id*
String
email*
String
is_active*
Boolean
name*
String
email*
String
plainPassword*
String
user*
int
service*
String
account_id*
int
amount*
int
operation_id*
String
type
String
user_id*
int
currency*
String
amount*
int
operation_id*
String
from_currency*
String
to_currency*
String
amount*
int
service*
String
account_id*
int
amount*
String
operation_id*
int