restTransactions.md

Транзакции, REST API, получение различной информации

Необходима аутентификация

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

• 0 - Транзакция ожидает подтверждения
• 1 - Транзакция подтверждена
• 2 - Транзакция отклонена Если транзакция осуществляется с пользователем, у которого нет приложения, то у транзакции автоматически будет установлен статус -1

Получение списка транзакций

Тип запроса: GET

URL запроса: /transaction/list

Параметры:

• token -- токен аутентификации, полученный через /auth/auth
• asset_id -- id контрагента, с кооторым нужно получить список транзакций (необязательный)

Если asset_id не указан, значит в ответе будут присутствовать все транзакции текущего пользователя со всеми контрагентами.

Ответ "Списка транзакций" содержит информацию об контрагенте и о пользователе

{
  "result": "ok",
  "status": "",
  "transactions": [
    {
      "from": {
        "id": 334,
        "type": "counterparty",
        "name": "Nikita",
        "color": null,
        "balance": "0.00",
        "comment": "User asset",
        "user": {
          "id": 2,
          "name": "Nikita",
          "avatar": "http://i.imgur.com/lMEa58i.png",
          "currency": "XXX",
          "birthday": "1992-04-10",
          "city": "Moscow",
          "blocked": 0,
          "materials": [],
          "organization": "Arcanite",
          "job_position": "_"
        },
        "check": null,
        "phone": []
      },
      "to": {
        "id": 335,
        "type": "counterparty",
        "name": "Фролов Антон",
        "color": null,
        "balance": "0.00",
        "comment": "User asset",
        "check": null,
        "phone": [
          {
            "id": 19,
            "asset_id": 335,
            "number": "79114328356"
          }
        ]
      },
      "balance": "0.00",
      "status": 1,
      "comment": "Тестовая транзакция",
      "sum": "500.00",
      "date": {
        "date": "2015-12-13 22:43:51.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    },
    {
      "from": {
        "id": 334,
        "type": "counterparty",
        "name": "Nikita",
        "color": null,
        "balance": "0.00",
        "comment": "User asset",
        "user": {
          "id": 2,
          "name": "Nikita",
          "avatar": "http://i.imgur.com/lMEa58i.png",
          "currency": "XXX",
          "birthday": "1992-04-10",
          "city": "Moscow",
          "blocked": 0,
          "materials": [],
          "organization": "Arcanite",
          "job_position": "_"
        },
        "check": null,
        "phone": []
      },
      "to": {
        "id": 335,
        "type": "counterparty",
        "name": "Фролов Антон",
        "color": null,
        "balance": "0.00",
        "comment": "User asset",
        "check": null,
        "phone": [
          {
            "id": 19,
            "asset_id": 335,
            "number": "79114328356"
          }
        ]
      },
      "balance": "0.00",
      "status": 1,
      "comment": "Тестовая транзакция",
      "sum": "-500.00",
      "date": {
        "date": "2015-12-13 23:07:16.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    }
  ]
}

Создание новой транзакции

Тип запроса: POST

URL запроса: /transaction/create

Параметры:

• token -- токен аутентификации, полученный через /auth/auth
• to -- id контрагента или актива, с которым нужно осуществить транзакцию (string)
• from -- id контрагента или актива который осуществляет транзакцию
• to_phone -- Если транзакция осуществляется с человеком из телефонной книги, то нужно указать его телефон (string)
• to_name -- И его имя (string)
• sum -- Сумма транзакции. Если положительное число то значит сумма движется от from к to ( Например дать человеку в долг ). Если отрицательное, то - взять в долг. (обязательный, число)
• balance -- баланс актива.
• comment -- Комментарий к транзакции (обязательный, текст)

Если from не указан - значит транзакция осуществляется от текущего пользователя, и для него создается контрагент в таблице asset Обязательно нужно указать параметр или to или to_phone и to_name Если указан параметр to_phone, то будет осуществлен поиск актива по телефону, и если такого нет, то создастся новый контрагент

Ответ удачной операции:

{
  "result": "ok",
  "status": ""
}

Одобрение транзакции

Тип запроса: POST

URL запроса: /transaction/confirm

Параметры:

• token -- токен аутентификации, полученный через /auth/auth
• transaction_id -- id транзакции для одобрения

Ответ удачной операции:

{
  "result": "ok",
  "status": ""
}

Отклонение транзакции

Тип запроса: POST

URL запроса: /transaction/reject

Параметры:

• token -- токен аутентификации, полученный через /auth/auth
• transaction_id -- id транзакции для отклонения

Ответ удачной операции:

{
  "result": "ok",
  "status": ""
}