ДеньгиOnline

2019-03-22 17:33:12

Действие transactions

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

Внимание!

В оперативном доступе гарантировано хранение данных о платежах за период в 2 месяца, более старые транзакции перемещаются в архив, и получение информации о них через API становится невозможным.

Параметры запроса

Запрос, помимо обязательных общих параметров, содержит в теге params следующие параметры:

Параметр Описание Тип данных Обязательность
from Дата (и, опционально, время) начала диапазона выборки YYYY-MM-DD HH:MM:SS Да
to Дата (и, опционально, время) конца диапазона выборки YYYY-MM-DD HH:MM:SS Да
limit

Максимальное число записей, выбираемых за один раз.
Если параметр limit не указан, по умолчанию будет выведено 100 транзакций

integer

Нет

offset

Сдвиг с начала диапазона.
Например, сочетание limit 10 + offset 20 означает "пропустить первые 20 записей, затем выбрать 10"

integer Нет

Параметры ответа

Ответ Системы в формате xml содержит, помимо общих, следующие теги:

Параметр Описание Формат параметра
from, to Отформатированные даты начала и конца диапазона из запроса YYYY-MM-DD HH:MM:SS
total

Общее количество записей, входящих в этот диапазон.

Внимание!

Число возвращенных записей может быть меньше общего числа записей за диапазон!
Например, за указанный диапазон есть 200 записей, но лимит выводимых записей определен в 100 записей, поэтому total будет равен 200, но список выведенных транзакций будет содержать 100 позиций. 

integer
limit, offset Параметры из запроса, определяющие длину списка и его начало integer

В тэге transactions (тэг, под которым группируются данные pay_status для одного инвойса) передаются следующие параметры:  

status Статус транзакции (см. действие pay_status) string (255)
income Cумма входящего платежа в его валюте decimal(11.4) разделитель — точка
amount Cумма входящего платежа в валюте основного баланса decimal(11.4) разделитель — точка
outcome Cумма выплаты в систему-получатель decimal(11.4) разделитель — точка
fee Процент комиссии по данной услуге decimal(11.4) разделитель — точка
rate Использованный курс конвертации decimal(11.4) разделитель — точка
ts_create Дата выставления счёта Дата в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС
ts_close Дата произведения выплаты Дата в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС
invoice ID инвойса integer
income_currency Валюта входящего платежа

string / integer ISO 4217 number-3

amount_currency Валюта основного баланса

string / integer ISO 4217 number-3

outcome_currency Валюта выплаты в систему-получатель

string / integer ISO 4217 number-3

fee_currency Валюта комиссии по данной услуге

string / integer ISO 4217 number-3

payment_type

Тип платежа

Возможные значения: 

  • payment - платеж, инициированный клиентом; 
  • balance - изменение баланса

payment / balance

Пример запроса (XML)

<?xml version="1.0" encoding="UTF-8"?>
<request>
    <project>1290</project>
    <timestamp>1408510823</timestamp>
    <action>transactions</action>
    <params>
        <from>2014-09-01</from>
        <to>2014-08-01</to>
        <limit>1</limit>
        <offset>10</offset>
    </params>
    <sign>b54e7db4d60be58c9a72626b9dfd78d5</sign>
</request>

Пример запроса (JSON)

{
  "request": {
    "project": "1290",
    "timestamp": "1408510823",
    "action": "transactions",
    "params": {
      "from": "2014-09-01",
      "to": "2014-08-01",
      "limit": "1",
      "offset": "10"
    },
    "sign": "b54e7db4d60be58c9a72626b9dfd78d5"
  }
}

Пример ответа (успех) (XML)

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>1</status>
    <reference>263177850</reference>
    <timestamp>1408510826</timestamp>
    <result>
        <from>2014-08-01 00:00:00</from>
        <to>2014-09-01 00:00:00</to>
        <total>95</total>
        <limit>1</limit>
        <offset>10</offset>
        <transactions>
            <transaction>
                <status>processing</status>
                <income>12.7700</income>
                <amount>12.77</amount>
                <outcome>12.77</outcome>
                <fee>0.0000</fee>
                <rate>1.0000</rate>
                <ts_create>2014-08-01 16:17:35</ts_create>
                <ts_close>2014-08-01 16:17:35</ts_close>
				<invoice>43244448</invoice>
				<income_currency>643</income_currency>
                <amount_currency>643</amount_currency>
                <outcome_currency>643</outcome_currency>
                <fee_currency>643</fee_currency>
				<payment_type>payment</payment_type>
			</transaction>
        </transactions>
    </result>
</response>

Пример ответа (успех) (JSON)

 {
  "response": {
    "status": "1",
    "reference": "263177850",
    "timestamp": "1408510826",
    "result": {
      "from": "2014-08-01 00:00:00",
      "to": "2014-09-01 00:00:00",
      "total": "95",
      "limit": "1",
      "offset": "10",
      "transactions": {
        "transaction": {
          "status": "processing",
          "income": "12.7700",
          "amount": "12.77",
          "outcome": "12.77",
          "fee": "0.0000",
          "rate": "1.0000",
          "ts_create": "2014-08-01 16:17:35",
          "ts_close": "2014-08-01 16:17:35",
          "invoice": "43244448",
          "income_currency": "643",
          "amount_currency": "643",
          "outcome_currency": "643",
          "fee_currency": "643",
          "payment_type": "payment"
        }
      }
    }
  }
}

Пример ответа (ошибка) (XML)

 <?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>32</status>
    <reference>263177850</reference>
    <timestamp>1358268196</timestamp>
</response>

Пример ответа (ошибка) (JSON)

 {
  "response": {
    "status": "32",
    "reference": "263177850",
    "timestamp": "1358268196"
  }
}