NAV

Введение

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

На тестовой системе созданы 2 пользователя от имени которых возможен вызов административного API.

Логин Пароль Роли пользователя
user user user
admin admin admin

Многопроектность

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

Постраничная навиция

Пользователи (Администраторы)

Создание пользователей

Параметры

$ curl -H 'Content-type:application/json' -u admin:admin -d '{"login":"testadminuser", "password":"strongpassword"}' https://www.synq.ru/mserver2-dev/admin/users
{
  "meta" : {
    "code" : 200
  },
  "data" : {
    "id" : 134432,
    "login" : "testadminuser"
  }
}

Разблокировка пользователя

$ curl -u admin:admin -X POST https://www.synq.ru/mserver2-dev/admin/users/133829/enable
{
  "meta" : {
    "code" : 200
  }
}

Блокировка пользователя

Параметры

Пэйлоад является необязательным параметром.

$ curl -u admin:admin -d '{"message": "text message", "reason": "text reason"}' https://www.synq.ru/mserver2-dev/admin/users/133829/disable
{
  "meta" : {
    "code" : 200
  }
}

Установка ролей пользователя

Параметры

$ curl -H 'Content-type:application/json' -u admin:admin -d '{"roles": ["user", "spectator"]}' https://www.synq.ru/mserver2-dev/admin/users/133829/roles
{
  "meta" : {
    "code" : 200
  }
}

Кошельки

Поиск по кошелькам проекта

Постраничная навиция

См. выше.

Параметры

Поля ответа:

Поля для сортировки:

Фильтры:

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/wallets?family_name=арсен&active=true&order_by=payment_count&order_direction=desc"
{
   "meta":{
      "page":{
         "total_elements":4
      },
      "code":200
   },
   "data":[
      {
         "phone":"+380503839001",
         "amount":8598.17,
         "enabled":true,
         "active":true,
         "role":"user",
         "created_at":"2014-08-20T15:10:25.943Z",
         "person":{
            "family_name":"Арсеньев",
            "given_name":"Алексей",
            "patronymic_name":"Александрович",
            "passport_series_number":"2202655885",
            "passport_issued_at":"2012-02-27",
            "itn":"330500938709",
            "ssn":"11223344595",
            "status":"data_entered"
         },
         "statistics":{
            "payments":{
               "lifetime":{
                  "turnover":8,
                  "in_turnover":8,
                  "out_turnover":8,
                  "p2p_turnover":8,
                  "count":8,
                  "in_count":8,
                  "out_count":8,
                  "p2p_count":8,

               },
               "last_month":{
                  "turnover":8,
                  "in_turnover":8,
                  "out_turnover":8,
                  "p2p_turnover":8,
                  "count":8,
                  "in_count":8,
                  "out_count":8,
                  "p2p_count":8,

               }
            },
            "cards":{
               "count":4,
               "active_count":2
            }
         }
      }
   ]
}

Аналитика по кошелькам

Параметры

Фильтры:

(См. “Поиск по кошелькам”)

Группировки:

Количество зарегистрированных кошельков с фильтром

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/wallets/count?active=true"
{
   "meta":{
      "code":200
   },
   "data":{
      "count":200
   }
}

Динамика регистраций кошельков с фильтром

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/wallets_count?group_by=created_at&tick=day&created_after=2014-01-01"
{
   "meta":{
      "code":200
   },
   "data":[
      {
         "tick":"2014-06-01",
         "data":{
            "count":125477.16
         }
      },
      {
         "tick":"2014-06-02",
         "data":{
            "count":0
         }
      },
      {
         "tick":"2014-06-03",
         "data":{
            "count":0
         }
      }
   ]
}

Загрузка кошелька

Поля ответа:

$ curl -uuser:user "https://www.synq.ru/mserver2-dev/admin/wallets/%2B79260000006"
{
   "meta":{
      "code":200
   },
   "data":{
      "phone":"+79260000006",
      "amount":65572.14,
      "enabled":true,
      "active":true,
      "role":"user",
      "created_at":"2014-06-01T12:43:52.876Z",
      "person":{
         "family_name":"Арсеньев",
         "given_name":"Алексей",
         "patronymic_name":"Александрович",
         "passport_series_number":"2202655885",
         "passport_issued_at":"2012-02-27",
         "itn":"330500938709",
         "ssn":"11223344595",
         "status":"data_entered"
      },
      "cards":[
         {
            "card_id":14,
            "state":"used",
            "title":"541715******2399",
            "type":"MasterCard",
            "3ds":"none",
            "lifetime_turnover":245435.56,
            "card_holder_name":"Ivanov Ivan",
            "last_payment_status":"completed"
         }
      ],
      "limits":{
         "amount": {
            "in": {
               "limit": 15000,
               "available": 15000
            },
            "out": {
               "limit": 15000,
               "available": 15000
            },
            "p2p": {
               "limit": 15000,
               "available": 15000
            },
            "wallet": {
               "limit": 15000,
               "available": 15000
            },
         },
         "turnover": {
             "monthly": {
                "in": {
                   "limit": 15000,
                   "available": 15000
                },
                "out": {
                   "limit": 15000,
                   "available": 15000
                },
                "p2p": {
                   "limit": 15000,
                   "available": 15000
                },
             },
         },
         "cards": {
            "active": {
               "limit": 10,
               "available": 8,
            }
         }
      },
      "statistics":{
         "payments":{
            "lifetime":{
               "turnover":8,
               "in_turnover":8,
               "out_turnover":8,
               "p2p_turnover":8,
               "count":8,
               "in_count":8,
               "out_count":8,
               "p2p_count":8,

            },
            "last_month":{
               "turnover":8,
               "in_turnover":8,
               "out_turnover":8,
               "p2p_turnover":8,
               "count":8,
               "in_count":8,
               "out_count":8,
               "p2p_count":8,

            }
         },
         "cards":{
            "count":4,
            "active_count":2
         }
      }
   }
}

Загрузка IP адресов кошелька

$ curl -uuser:user "https://www.synq.ru/mserver2-dev/admin/wallets/%2B12345657367/ip"
{
  "meta" : {
    "code" : 200,
    "page" : {
      "total_elements" : 21
    }
  },
  "data" : [ "127.0.0.1", "::1"]
}

Получение кода активации кошелька

$ curl -uuser:user "https://www.synq.ru/mserver2-dev/admin/wallets/%2B12345657367/security_code"
{
   "meta":{
      "code":200
   },
   "data":{
      "security_code":"2899066"
   }
}

Блокировка кошелька

Параметры

$ curl -uuser:user  -H 'Content-type:application/json' --data '{"message": "Заблокирован до выяснения.", "reason": "Клиент - кардер." }' "https://www.synq.ru/mserver2-dev/admin/wallets/%2B12345657367/disable"
{
   "meta":{
      "code":200
   },
   "data":{
      "phone":"+12345657367",
      "amount":10000,
      "reset_password":false,
      "lock_message":"Заблокироваан до выяснения.",
      "verified":false,
      "enabled":false,
      "active":true,
      "lock_reason":"Клиент - кардер.",
      "locked_at":"2014-08-14T16:46:42.122Z"
   }
}

Разблокировка кошелька

$ curl -uuser:user -X POST "https://www.synq.ru/mserver2-dev/admin/wallets/%2B12345657367/enable"
{
   "meta":{
      "code":200
   },
   "data":{
      "phone":"+12345657367",
      "amount":10000,
      "reset_password":false,
      "verified":false,
      "enabled":true,
      "active":true
   }
}

Получение списка персональных данных

Информация выдаётся постранично.

Параметры постраничного запроса

page - номер страницы начиная с 0 size - размер страницы order_by - сортировка по полю, имя поля указывается в snake_case стиле order_direction - направление сортировки status - фильтр по статусу сообщений. Например, для получения списка кошельков ожидающих идентификации

$ curl -uuser:user "https://www.synq.ru/mserver2-dev/admin/persons?page=1&size=2&order_by=givenName&order_direction=desc&status=data_entered
{
   "meta":{
      "page":{
         "total_elements":6
      },
      "code":200
   },
   "data":[
      {
         "family_name":"Дергачёв",
         "given_name":"Андрей",
         "patronymic_name":"Петрович",
         "passport_series_number":"45112456789",
         "passport_issued_at":"2007-06-07",
         "itn":"526317984689",
         "status":"data_entered",
         "verified_at":"2014-10-30T11:11:52.401Z",
         "changed_at":"2014-09-08T15:47:10.411Z",
         "wallet":{
            "phone":"+380631345678"
         }
      },
      {
         "family_name":"Арсеньев",
         "given_name":"Алексей",
         "patronymic_name":"Александрович",
         "passport_series_number":"2202655111",
         "passport_issued_at":"2012-02-02",
         "itn":"330500938709",
         "status":"data_entered",
         "changed_at":"2014-10-24T15:09:12.019Z",
         "wallet":{
            "phone":"+380503839987"
         }
      }
   ]
}

Изменение статуса персональных данных

Параметры

$ curl  -H 'Content-type:application/json' -uuser:user -d '{"status": "data_verified", "level": "identified"}' "https://www.synq.ru/mserver2-dev/admin/persons/%2B79260000006/update_status"

Результат содержит "status": "data_verified", "verified_at": "2014-10-22T10:26:12.035Z"

{
   "meta":{
      "code":200
   },
   "data":{
      "family_name":"Иванов",
      "given_name":"Иван",
      "patronymic_name":"Иванович",
      "passport_series_number":"1122334455",
      "passport_issued_at":"2012-12-20",
      "itn":"330500938709",
      "ssn":"11223344595",
      "status":"data_verified",
      "verified_at":"2014-10-22T10:26:12.035Z",
      "changed_at":"2014-10-22T10:26:10.604Z",
      "wallet":{
         "phone":"+380935895452"
      }
   }
}

Отчет об остатке кошельков проекта за период

Параметры

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/wallets/balance?from=2014-07-11&to=2014-07-13"
{
   "meta":{
      "code":200
   },
   "data":[
      {
         "tick":"2014-07-11",
         "data":{
            "amount":55572.14
         }
      },
      {
         "tick":"2014-07-12",
         "data":{
            "amount":55572.14
         }
      },
      {
         "tick":"2014-07-13",
         "data":{
            "amount":55572.14
         }
      }
   ]
}

Удаление кошелька

$ curl -uuser:user -X DELETE https://www.synq.ru/mserver2-dev/admin/wallets/+79260000006
{
   "meta":{
      "code":200
   }
}

Сервисы

Загрузка списка сервисов

$ curl -uadmin:admin https://www.synq.ru/mserver2-dev/admin/services
 {
  "meta" : {
    "code" : 200,
    "page" : {
      "total_elements" : 391
    }
  },
  "data" : [ {
    "id" : 1670,
    "name" : "CityLink (Королёв)",
    "min" : 10,
    "max" : 15000,
    "verification_required" : false,
    "parameters" : [ {
      "code" : "phoneNumber",
      "min_length" : 6,
      "max_length" : 7,
      "name" : "Логин",
      "pattern" : "^.{6,7}$",
      "type" : "text",
      "pattern_description" : "Логин",
      "items" : [ ]
    } ],
    "rate" : {
      "fix" : 0,
      "percent" : 3
    }
  }]
  }

Загрузка сервиса по идентификатору

$ curl -uadmin:admin https://www.synq.ru/mserver2-dev/admin/services/834
{
  "meta" : {
    "code" : 200
  },
  "data" : {
    "id" : 834,
    "name" : "Мегафон",
    "min" : 1,
    "max" : 15000,
    "verification_required" : false,
    "parameters" : [ {
      "code" : "phoneNumber",
      "min_length" : 10,
      "max_length" : 10,
      "name" : "№ Телефона",
      "pattern" : "^((6|9)\\d{9}|\\d{10})$",
      "type" : "numeric",
      "pattern_description" : "№ Телефона",
      "items" : [ ]
    } ],
    "rate" : {
      "fix" : 0,
      "percent" : 3
    }
  }
}

Создание сервиса

Параметры

$ curl -H 'Content-type:application/json' -u admin:admin -d '{"name":"Test Госуслуги РФ: ФНС", "verification_required": false, "group": "misc", "foreign_id": "39863886"}' https://www.synq.ru/mserver2-dev/admin/services
{
  "meta" : {
    "code" : 200
  },
  "data" : {
    "id" : 1716,
    "name" : "Test Госуслуги РФ: ФНС"
  }
}

Включение сервиса для проекта

Параметры

$ curl -H 'Content-type:application/json' -u admin:admin -d '{"project": "mbank", "rate": {"min": 30, "fix": 10, "max": 10000, "percent": 3.2}}' https://www.synq.ru/mserver2-dev/admin/services/1714/enable
{
  "meta" : {
    "code" : 200
  },
  "data" : {
    "id" : 1714,
    "name" : "Test Госуслуги РФ: ФНС",
    "min" : 1,
    "max" : 15000,
    "verification_required" : false,
    "parameters" : [ {
      "code" : "phoneNumber",
      "min_length" : 15,
      "max_length" : 25,
      "name" : "Индекс Документа",
      "pattern" : "^(\\d{15}|\\d{20}|\\d{25})$",
      "type" : "numeric",
      "pattern_description" : "Индекс Документа",
      "items" : [ ]
    }, {
      "code" : "2",
      "name" : "№ Телефона",
      "pattern" : "^\\d{10}$",
      "type" : "text",
      "pattern_description" : "№ Телефона",
      "items" : [ ]
    }, {
      "code" : "3",
      "name" : "Фамилия Плательщика",
      "pattern" : "^([А-Я]{2,70}|[А-Я]{2,70}\\-[А-Я]{2,70})$",
      "type" : "text",
      "pattern_description" : "Фамилия Плательщика",
      "items" : [ ]
    }, {
      "code" : "4",
      "name" : "Имя Плательщика",
      "pattern" : "^[А-Я]{2,50}$",
      "type" : "text",
      "pattern_description" : "Имя Плательщика",
      "items" : [ ]
    }, {
      "code" : "5",
      "name" : "Отчество Плательщика",
      "pattern" : "^[А-Я ]{2,50}$",
      "type" : "text",
      "pattern_description" : "Отчество Плательщика",
      "items" : [ ]
    } ],
    "rate" : {
      "min" : 30,
      "max" : 10000,
      "fix" : 10,
      "percent" : 3.2
    }
  }
}

Выключение сервиса для проекта

Параметры

curl -H 'Content-type:application/json' -u admin:admin -d '{"project": "mbank"}' https://www.synq.ru/mserver2-dev/admin/services/1714/disable
{
  "meta" : {
    "code" : 200
  },
  "data" : {
    "id" : 1714,
    "name" : "Test Госуслуги РФ: ФНС"
  }
}

Установка комиссии

Параметры

$ curl -H 'Content-type:application/json' -u admin:admin -d '{"project": "mbank", "rate": {"min": 3, "fix": 100, "max": 1000, "percent": 30.2}}' https://www.synq.ru/mserver2-dev/admin/services/1714/rate
{
  "meta" : {
    "code" : 200
  },
  "data" : {
    "id" : 1714,
    "name" : "Test Госуслуги РФ: ФНС",
    "min" : 1,
    "max" : 15000,
    "verification_required" : false,
    "parameters" : [ {
      "code" : "phoneNumber",
      "min_length" : 15,
      "max_length" : 25,
      "name" : "Индекс Документа",
      "pattern" : "^(\\d{15}|\\d{20}|\\d{25})$",
      "type" : "numeric",
      "pattern_description" : "Индекс Документа",
      "items" : [ ]
    }, {
      "code" : "2",
      "name" : "№ Телефона",
      "pattern" : "^\\d{10}$",
      "type" : "text",
      "pattern_description" : "№ Телефона",
      "items" : [ ]
    }, {
      "code" : "3",
      "name" : "Фамилия Плательщика",
      "pattern" : "^([А-Я]{2,70}|[А-Я]{2,70}\\-[А-Я]{2,70})$",
      "type" : "text",
      "pattern_description" : "Фамилия Плательщика",
      "items" : [ ]
    }, {
      "code" : "4",
      "name" : "Имя Плательщика",
      "pattern" : "^[А-Я]{2,50}$",
      "type" : "text",
      "pattern_description" : "Имя Плательщика",
      "items" : [ ]
    }, {
      "code" : "5",
      "name" : "Отчество Плательщика",
      "pattern" : "^[А-Я ]{2,50}$",
      "type" : "text",
      "pattern_description" : "Отчество Плательщика",
      "items" : [ ]
    } ],
    "rate" : {
      "min" : 3,
      "max" : 1000,
      "fix" : 100,
      "percent" : 30.2
    }
  }
}

Провайдеры

Создание провайдера

Параметры

$ curl -H 'Content-type:application/json' -u admin:admin -d '{"code":"rest_provider_1", "name":"Test provider 1", "jur_name": "Some info"}' https://www.synq.ru/mserver2-dev/admin/providers
{
  "meta" : {
    "code" : 200
  },
  "data" : {
    "id" : 124,
    "code" : "rest_provider_1",
    "name" : "Test provider 1"
  }
}

Редактирование провайдера

Параметры

$ curl -H 'Content-type:application/json' -u admin:admin -d '{"code":"rest_provider_2", "name":"Test provider 2", "jur_name": "Some info (changed)"}' https://www.synq.ru/mserver2-dev/admin/providers/124
{
  "meta" : {
    "code" : 200
  },
  "data" : {
    "id" : 124,
    "code" : "rest_provider_2",
    "name" : "Test provider 2"
  }
}

Загрузка списка провайдеров

$ curl -u admin:admin https://www.synq.ru/mserver2-dev/admin/providers
{
  "meta" : {
    "code" : 200,
    "page" : {
      "total_elements" : 3
    }
  },
  "data" : [ {
    "id" : 1,
    "code" : "tpr_out",
    "name" : "Кредит Пилот"
  }, {
    "id" : 2,
    "code" : "tpr_in",
    "name" : "ООО ТПР (агент)"
  }, {
    "id" : 3,
    "code" : "rapida_in",
    "name" : "ПС Рапида (агент)"
  } ]
}

Создание сервиса провайдера

Параметры

$ curl -H 'Content-type:application/json' -u admin:admin -d '{"name":"Provider service #1", "min":"10", "max": "10000", "parameters" : [{"code": "param1", "comments": "test comment", "min_length": 1, "max_length": 10, "pattern": "*", "pattern_description": "Phone number", "title" : "test title", "type": "numeric"}, {"code": "param2", "comments": "test comment2", "min_length": 1, "max_length": 10, "pattern": "***", "pattern_description": "Phone number2", "title" : "test title2", "type": "text", "items": [{"code" : "item1", "value": "Test Item 1"}, {"code" : "item2", "value": "Test Item 2"}]}]}' https://www.synq.ru/mserver2-dev/admin/providers/124/services
{
  "meta" : {
    "code" : 200
  },
  "data" : {
    "id" : 7208,
    "service_id" : 0,
    "name" : "Provider service #1",
    "min" : 10,
    "max" : 10000,
    "payment_type" : 0,
    "updated_at" : "2015-09-28T09:05:15.189Z",
    "version" : "0",
    "provider" : {
      "id" : 124,
      "code" : "rest_provider_2",
      "name" : "Test provider 2"
    },
    "parameters" : [ {
      "code" : "param2",
      "comments" : "test comment2",
      "min_length" : 1,
      "max_length" : 10,
      "pattern" : "***",
      "pattern_description" : "Phone number2",
      "title" : "test title2",
      "type" : "text",
      "items" : [ {
        "code" : "item1",
        "value" : "Test Item 1"
      }, {
        "code" : "item2",
        "value" : "Test Item 2"
      } ]
    }, {
      "code" : "param1",
      "comments" : "test comment",
      "min_length" : 1,
      "max_length" : 10,
      "pattern" : "*",
      "pattern_description" : "Phone number",
      "title" : "test title",
      "type" : "numeric",
      "items" : [ ]
    } ]
  }
}

Редактирование сервиса провайдера

Параметры

$ curl -H 'Content-type:application/json' -u admin:admin -d '{"name":"Provider service #1-2", "min":"10", "max": "10000", "parameters" : [{"code": "param1-2", "comments": "test comment", "min_length": 1, "max_length": 10, "pattern": "*", "pattern_description": "Phone number", "title" : "test title-2", "type": "numeric"}, {"code": "param2", "comments": "test comment2-2", "min_length": 1, "max_length": 10, "pattern": "***", "pattern_description": "Phone number2-2", "title" : "test title2-2", "type": "text", "items": [{"code" : "item1-2", "value": "Test Item 1-2"}, {"code" : "item2-2", "value": "Test Item 2-2"}]}]}' https://www.synq.ru/mserver2-dev/admin/providers/services/7208
{
  "meta" : {
    "code" : 200
  },
  "data" : {
    "id" : 7208,
    "service_id" : 0,
    "name" : "Provider service #1-2",
    "min" : 10,
    "max" : 10000,
    "payment_type" : 0,
    "updated_at" : "2015-09-28T09:26:21.493Z",
    "version" : "0",
    "provider" : {
      "id" : 124,
      "code" : "rest_provider_2",
      "name" : "Test provider 2"
    },
    "parameters" : [ {
      "code" : "param1-2",
      "comments" : "test comment",
      "min_length" : 1,
      "max_length" : 10,
      "pattern" : "*",
      "pattern_description" : "Phone number",
      "title" : "test title-2",
      "type" : "numeric",
      "items" : [ ]
    }, {
      "code" : "param2",
      "comments" : "test comment2-2",
      "min_length" : 1,
      "max_length" : 10,
      "pattern" : "***",
      "pattern_description" : "Phone number2-2",
      "title" : "test title2-2",
      "type" : "text",
      "items" : [ {
        "code" : "item2-2",
        "value" : "Test Item 2-2"
      }, {
        "code" : "item1-2",
        "value" : "Test Item 1-2"
      } ]
    } ]
  }
}

Загрузка списка сервисов провайдеров

$ curl -u admin:admin https://www.synq.ru/mserver2-dev/admin/providers/services
{
  "meta" : {
    "code" : 200,
    "page" : {
      "total_elements" : 3
    }
  },
  "data" : [ {
    "service_id" : 734524455,
    "name" : "MalNet (Москва)",
    "min" : 10,
    "max" : 15000,
    "payment_type" : 0,
    "updated_at" : "2014-12-29T17:01:03.081Z",
    "version" : "0",
    "provider" : {
      "id" : 1,
      "code" : "tpr_out",
      "name" : "Кредит Пилот"
    },
    "parameters" : [ {
      "code" : "phoneNumber",
      "comments" : "№ договора (1-20 символов)",
      "min_length" : 1,
      "max_length" : 20,
      "pattern" : "^[a-z0-9_\\.\\-]{1,20}$",
      "pattern_description" : "№ договора (1-20 символов)",
      "title" : "№ договора (1-20 символов)",
      "type" : "text"
    } ]
  }, {
    "service_id" : 980752136,
    "name" : "Mamba",
    "min" : 34,
    "max" : 15000,
    "payment_type" : 0,
    "updated_at" : "2014-12-29T17:01:03.117Z",
    "version" : "0",
    "provider" : {
      "id" : 1,
      "code" : "tpr_out",
      "name" : "Кредит Пилот"
    },
    "parameters" : [ {
      "code" : "phoneNumber",
      "comments" : "Логин",
      "min_length" : 1,
      "max_length" : -128,
      "pattern" : "^.{1,128}$",
      "pattern_description" : "Логин",
      "title" : "Логин",
      "type" : "text"
    } ]
  }, {
    "service_id" : 979311259,
    "name" : "Ростелеком Центр (Элтелекор) (29)",
    "min" : 0,
    "max" : 15000,
    "payment_type" : 0,
    "updated_at" : "2014-12-29T17:06:11.799Z",
    "version" : "0",
    "provider" : {
      "id" : 1,
      "code" : "tpr_out",
      "name" : "Кредит Пилот"
    },
    "parameters" : [ {
      "code" : "phoneNumber",
      "comments" : "№ моб.телефона (10 цифр)",
      "min_length" : 10,
      "max_length" : 10,
      "pattern" : "^(.{2,8}|.{20})$",
      "pattern_description" : "2-8 символов или 20 символов",
      "title" : "№ Счёта",
      "type" : "text"
    } ]
  } ]
}

Проекты

Загрузка списка проектов

$ curl -u admin:admin https://www.synq.ru/mserver2-dev/admin/projects
{
  "meta" : {
    "code" : 200,
    "page" : {
      "total_elements" : 2
    }
  },
  "data" : [ {
    "code" : "mbank",
    "name" : "МБанк"
  }, {
    "code" : "bov",
    "name" : "Банк Воронеж"
  } ]
}

Платежи

Поиск по платежам

Параметры (опциональные)

Поля для сортировки:

$ curl -uuser:user "https://www.synq.ru/mserver2-dev/admin/payments?service_name=mts&type=out&status=created&amount_from=0&amount_to=100000&date_from=2014-01-01T12:10:15.525Z&date_to=2014-12-01T00:00:00.00Z&order_by=amount&order_direction=desc&size=1"
{
   "meta":{
      "page":{
         "total_elements":14
      },
      "code":200
   },
   "data":[
      {
         "id":1401089244704,
         "client_payment_id":"409c1e06-5faa-11e4-a61c-b88d12284ddc",
         "amount":12000,
         "total":12070,
         "created_at":"2014-10-29T20:29:16.495Z",
         "status":"created",
         "type":"out",
         "service":{
            "id":15,
            "name":"MTS Украина"
         },
         "parameters":[
            {
               "code":"phoneNumber",
               "name":"№ телефона (9-10 цифр)",
               "value":"0509244512"
            }
         ],
         "outbound":{
            "id":35,
            "code":"tpr_out",
            "name":"ООО ТПР (провайдер)"
         },
         "wallet":{
            "phone":"+79270000001",
            "amount":8496.32,
            "verified":false,
            "ip":"37.110.42.197"
         }
      }
   ]
}

Пример фильтра по кошельку и IP

$ curl -uuser:user "https://www.synq.ru/mserver2-dev/admin/payments?wallet=%2B380935895452&client_ip=127.0.0.1&size=1"
{
   "meta":{
      "page":{
         "total_elements":2
      },
      "code":200
   },
   "data":[
      {
         "id":1401089245266,
         "client_payment_id":"96c280f4-8e2b-40a1-b250-806bb4a4b9f1",
         "amount":10000,
         "total":10000,
         "created_at":"2014-11-04T13:02:09.409Z",
         "processed_at":"2014-11-04T13:02:13.619Z",
         "status":"completed",
         "type":"p2p",
         "wallet":{
            "phone":"+380935895452",
            "amount":0,
            "name":"Иван Иванов",
            "verified":true,
            "ip":"127.0.0.1"
         },
         "destination":{
            "phone":"+79555555555"
         },
         "direction":"out",
         "client_ip":"127.0.0.1"
      }
   ]
}

Пример фильтра по inbound_payment_id (id платежа в IPSP)

$ curl -uuser:user "https://www.synq.ru/mserver2-dev/admin/payments?inbound_payment_id=6143708"
{
   "meta":{
      "code":200,
      "page":{
         "total_elements":1
      }
   },
   "data":[
      {
         "id":1401089245752,
         "client_payment_id":"6ea16c52-669e-11e4-86b1-3c07542cf2f2",
         "amount":42,
         "total":42,
         "created_at":"2014-11-07T16:52:17.990Z",
         "processed_at":"2014-11-07T16:52:21.791Z",
         "status":"completed",
         "type":"in",
         "inbound":{
            "id":62,
            "code":"ipsp_in",
            "name":"ООО ИПСП (агент)",
            "payment":{
               "amount":4200,
               "id":1401089245752,
               "type":"SALE",
               "date":"2014-11-07T16:52:19.804Z",
               "product_id":1721,
               "currency":"RUB",
               "card_holder_name":"TESTER TESTEROV",
               "exp_year":2014,
               "exp_month":11,
               "remote_ip":"81.95.134.13",
               "user_ip":"81.95.134.13",
               "card_number_mask":"541715******2399",
               "card_type":"MASTER_CARD",
               "recurring":false,
               "steps":[
                  {
                     "date":"2014-11-07T16:52:19.867Z",
                     "status":"PASSED_0",
                     "type":"ANTIFRAUD"
                  },
                  {
                     "eci":"06",
                     "date":"2014-11-07T16:52:21.571Z",
                     "status":"PASSED_0",
                     "type":"BANK",
                     "auth_id_response":"411421",
                     "date_local_trans":"2014-11-07T13:52:21.000Z",
                     "response_code":"APPROVED_00"
                  },
                  {
                     "date":"2014-11-07T16:52:19.843Z",
                     "status":"PASSED_0",
                     "type":"PAYMENT_INPUT"
                  }
               ]
            }
         },
         "card":{
            "state":"used",
            "title":"541715******2399",
            "type":"MasterCard",
            "bin":{
               "country":"Ukraine",
               "bank":"JCB PrivatBank",
               "type":"debit"
            }
         },
         "wallet":{
            "phone":"+79270000001",
            "amount":7462.54,
            "level":"anonymous",
            "name":"Пиэчпий Мбанков",
            "verified":true,
            "person_status":"data_verified",
            "enabled":true,
            "active":true,
            "role":"user",
            "created_at":"2014-10-29T16:33:14.045Z"
         },
         "client_ip":"81.95.134.13"
      }
   ]
}

Отчет о количестве платежей проекта за период

Параметры

Группировки

Подсчёт всех платежей за период

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/payments/count?date_from=2014-07-11&date_to=2014-07-12"
{
   "meta":{
      "code":200
   },
   "data":[
      {
         "tick":"2014-07-11",
         "data": {
             "count":123
         }
      },
      {
         "tick":"2014-07-12",
         "data": {
             "count":98
         }
      }
   ]
}

Пример с группировкой по статусу платежей

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/payments/count?date_from=2014-07-11&date_to=2014-07-11&group_by=status&tick=3h"
{
   "meta":{
      "code":200
   },
   "data":[
      {
         "tick":"2014-07-11T00:00:00",
         "data":{
            "count":83,
            "created":24,
            "processing":37,
            "completed":21,
            "declined":1
         }
      },
      {
         "tick":"2014-07-11T00:03:00",
         "data":{
            "count":83,
            "created":24,
            "processing":37,
            "completed":21,
            "declined":1
         }
      },
      ...
      {
         "tick":"2014-07-12T00:00:00",
         "data":{
            "count":83,
            "created":24,
            "processing":37,
            "completed":21,
            "declined":1
         }
      }
   ]
}

Пример группировки по типу поставщика

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/payments/count?date_from=2014-07-11&date_to=2014-07-11&group_by=provider_types&tick=3h"
{
   "meta":{
      "code":200
   },
   "data":[
      {
         "tick":"2014-07-12T00:00:00",
         "data":{
            "count":83,
            "providers":[
               {
                  "id" : 1,
                  "code" : "tpr_out",
                  "name" : "Кредит Пилот",
                  "type" : "outbound", 
                  "count": 50
               },
               {
                  "id" : 4,
                  "code" : "ipsp_in",
                  "name" : "ООО ИПСП (агент)",
                  "type" : "inbound",
                  "count": 50
                }
            ]
         }
      }
      ...
   ]
}

Пример группировки по сервису

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/payments/count?date_from=2014-07-11&date_to=2014-07-11&group_by=service_ids&tick=3h"
{
   "meta":{
      "code":200
   },
   "data":[
      {
         "tick":"2014-07-12T00:00:00",
         "data":{
            "count":83,
            "services":[
               {
                  "type" : "out",
                  "id" : 834,
                  "count": 50
               },
               {
                  "type" : "out",
                  "id" : 4,
                  "count": 30
                },
                {
                  "type" : "p2p",
                  "count": 20
                }
            ]
         }
      }
      ...
   ]
}

Пример группировки по сервису и статусу

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/payments/count?tick=month&service_ids=1691&group_by=service_ids,status"
{
  "meta" : {
    "code" : 200,
    "page" : {
      "total_elements" : 2
    }
  },
  "data" : [ {
    "data" : {
      "count" : 66,
      "services" : [ {
        "data" : {
          "declined" : 2,
          "created" : 51,
          "count" : 61,
          "completed" : 8
        },
        "id" : 1691,
        "type" : "out"
      }, {
        "data" : {
          "count" : 5,
          "completed" : 5
        },
        "id" : 1691,
        "type" : "inout"
      } ]
    },
    "tick" : "2015-02-28T22:00:00.000+0000"
  }, {
    "data" : {
      "count" : 15,
      "services" : [ {
        "data" : {
          "created" : 7,
          "count" : 14,
          "completed" : 7
        },
        "id" : 1691,
        "type" : "out"
      }, {
        "data" : {
          "declined" : 1,
          "count" : 1
        },
        "id" : 1691,
        "type" : "inout"
      } ]
    },
    "tick" : "2015-03-31T21:00:00.000+0000"
  } ]
}

Отчет о обороте платежей проекта за период

Параметры

Группировки

Оборот всех платежей за период * date_from и date_to - границы диапазона дат создания платежей * ipsp_payment_id - идентификатор платежа из IPSP * page - номер (начиная с 0) страницы, которую запрашивает клиент, по умолчанию 0 * size - размер страницы, которую запрашивает клиент, по умолчанию 20 * sort - поле сортировки, через запятую может следовать направление

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/payments/turnover?date_from=2014-07-11&date_to=2014-07-12"
{
   "meta":{
      "code":200
   },
   "data":[
      {
         "tick":"2014-07-11",
         "data": {
             "amount":1233424
         }
      },
      {
         "tick":"2014-07-12",
         "data": {
             "amount":98234342
         }
      }
   ]
}

Пример с группировкой по статусу платежей

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/payments/turnover?date_from=2014-07-11&date_to=2014-07-11&group_by=status&tick=3h"
{
   "meta":{
      "code":200
   },
   "data":[
      {
         "tick":"2014-07-11T00:00:00",
         "data":{
            "amount":83324324324,
            "created":2434234,
            "processing":3723434,
            "completed":2123423,
            "declined":12
         }
      },
      ...
   ]
}

Пример группировки по типу поставщика

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/payments/turnover?date_from=2014-07-11&date_to=2014-07-11&group_by=provider_types&tick=3h"
{
   "meta":{
      "code":200
   },
   "data":[
      {
         "tick":"2014-07-12T00:00:00",
         "data":{
            "amount":83,
            "providers":[
               {
                  "id" : 1,
                  "code" : "tpr_out",
                  "name" : "Кредит Пилот",
                  "type" : "outbound", 
                  "amount": 5043
               },
               {
                  "id" : 4,
                  "code" : "ipsp_in",
                  "name" : "ООО ИПСП (агент)",
                  "type" : "inbound",
                  "amount": 1293
                }
            ]
         }
      }
      ...
   ]
}

Пример группировки по сервису

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/payments/turnover?date_from=2014-07-11&date_to=2014-07-11&group_by=service_ids&tick=3h"
{
   "meta":{
      "code":200
   },
   "data":[
      {
         "tick":"2014-07-12T00:00:00",
         "data":{
            "amount":83243,
            "services":[
               {
                  "type" : "out",
                  "id" : 834,
                  "amount": 50234
               },
               {
                  "type" : "out",
                  "id" : 4,
                  "amount": 3012
               },
               {
                  "type" : "p2p",
                  "amount": 2033
               }
            ]
         }
      }
      ...
   ]
}

Пример группировки по сервису и статусу

$ curl -uadmin:admin "https://www.synq.ru/mserver2-dev/admin/payments/turnover?tick=month&service_ids=1691&group_by=service_ids,status"
{
  "meta" : {
    "code" : 200,
    "page" : {
      "total_elements" : 2
    }
  },
  "data" : [ {
    "data" : {
      "amount" : 154,
      "services" : [ {
        "data" : {
          "amount" : 144,
          "declined" : 20,
          "created" : 114,
          "completed" : 10
        },
        "id" : 1691,
        "type" : "out"
      }, {
        "data" : {
          "amount" : 10,
          "completed" : 10
        },
        "id" : 1691,
        "type" : "inout"
      } ]
    },
    "tick" : "2015-02-28T22:00:00.000+0000"
  }, {
    "data" : {
      "amount" : 114,
      "services" : [ {
        "data" : {
          "amount" : 14,
          "created" : 7,
          "completed" : 7
        },
        "id" : 1691,
        "type" : "out"
      }, {
        "data" : {
          "amount" : 100,
          "declined" : 100
        },
        "id" : 1691,
        "type" : "inout"
      } ]
    },
    "tick" : "2015-03-31T21:00:00.000+0000"
  } ]
}

Интеграция с БЭСТ

Поиск переводов клиента БЭСТ

Запрос на поиск переводов по идентификатору клиента денежных переводов БЭСТ. Запрос возвращает токен, который позволяет забрать результаты поиска в случае готовности. После того, как результаты поиска получены, они не будут доступны.

Параметры

curl -uadmin:test -X POST https://www.synq.ru/mserver2-dev/admin/best/client/147/transfer/search?type=out
{
  "meta" : {
    "code" : 200
  },
  "data" : "735796@656055620"
}

Получение результатов поиска переводов

Имея токен, идентифицирующий результат поиска можно получить список найденных переводов клиента БЭСТ.

curl -uadmin:test https://www.synq.ru/mserver2-dev/admin/best/client/transfer/search/735796@656055620
{
  "meta" : {
    "code" : 200,
    "page" : {
      "total_elements" : 1
    }
  },
  "data" : [ {
    "sender" : {
      "data" : {
        "country" : {
          "numeric" : "643"
        },
        "lastname" : "Арсеньев",
        "firstname" : "Алексей",
        "patronymic" : "Александрович",
        "isresident" : 1
      },
      "address" : {
        "phone" : "79261111111"
      },
      "data_extended" : {
        "birth_day" : "1982-01-01T21:00:00.000+0000",
        "birth_place" : "Город Орёл Орловской области"
      },
      "identification" : {
        "type" : "1",
        "series" : "2202",
        "number" : "655885",
        "issuer" : "Отделом УФМС России по гор Орёл",
        "issue_date" : "2013-02-06T20:00:00.000+0000",
        "dep_code" : "770-105"
      }
    },
    "receiver" : {
      "data" : {
        "country" : {
          "numeric" : "643"
        },
        "lastname" : "Арсеньев",
        "firstname" : "Алексей",
        "patronymic" : "Александрович",
        "isresident" : 1
      },
      "address" : { },
      "data_extended" : { },
      "identification" : { }
    },
    "number" : 413258621,
    "amount" : 30,
    "currency_alpha" : "RUR",
    "note" : "test payment",
    "smstosender" : 0,
    "smstoreceiver" : 0,
    "checknumber" : "33977399",
    "creating_date" : "2014-12-24T21:00:00.000+0000",
    "fee" : 30.00,
    "amount_charge" : 30,
    "currency_charge" : "RUR",
    "rate" : 1.0
  } ]
}

Коды ошибок

Рекомендуется опрашивать готовность данных поиска не чаще чем раз в 10 секунд.