📋Список транзакций

Метод запроса

GET

Урл запроса

/api/v2/transactions

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

На вход принимаются следующие параметры

Название	Обяз.	Формат	Описание
filter[id]		string(1-200)	Фильтр по нашему идентификатору транзакции
filter[order_id]		string(1-255)	Фильтр по вашему идентификатору операции
filter[account]		string(1-255)	Фильтр по
filter[action]		string(1-255)	Фильтр по действию транзакции. Допустимые значения "deposit", "withdrawal";
filter[method]		string(1-255)	Фильтр по методу ввода или вывода. Допустимые значения - коды методов ввода и вывода, указанные в нашей документации.
filter[type]		string(1-255)	Фильтр по типу транзакции. Допустимые значения "site", "invoice", "registry"
filter[create_at][start]		string(1-255)	Фильтр по времени создания транзакции, ограничивающий начало диапазона ( транзакции, созданные после указанного времени ). Формат: "2020-01-01T00:00:00+03:00"
filter[create_at][end]		string(1-255)	Фильтр по времени создания транзакции, ограничивающий начало диапазона ( транзакции, созданные до указанного времени ). Формат: "2020-01-01T00:00:00+03:00"
filter[amount][min]		string(1-255)	Фильтр по сумме транзакции, ограничивающий по сумме "снизу" ( транзакции, сумма которых превышает указанную )
filter[amount][max]		string(1-255)	Фильтр по сумме транзакции, ограничивающий по сумме "сверху" ( транзакции, сумма которых меньше указанной )
page[number]		integer	Номер "страницы" выдаваемой информации. По умолчанию 1
page[size]		integer	Размер "страницы" выдаваемой информации. По умолчанию 20
sort		string(1-255)	Название поля, по которому выполнять сортировку. Если перед ним указать минус, то сортировка будет в обратном порядке. По умолчанию "-id"

Пример запроса

CURL

curl --request GET \
  --url https://{{your_api_domain}}/api/v2/transactions \
  --header 'Authorization: Bearer {{your_api_token}}' \
  -d 'filter[created_at][min]=2020-01-01T00:00:00+03:00' \
  -d 'page[number]=2' \
  -d 'sort=amount'

PHP + Guzzle

$httpClient = new \GuzzleHttp\Client();
$response = $httpClient->get('https://{{your_api_domain}}/api/v2/transactions', [
    'query' => [
        'filter[created_at][min]' => '2020-01-01T00:00:00+03:00',
        'page[number]'            => 2,
        'sort'                    => 'amount',
    ],
    'headers' => [
        'Authorization' => 'Bearer ' . $yourApiToken,
    ]
]);

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

Название	Формат	Описание
items[].id	string(1-255)	Номер транзакции
items[].created_at	string(1-255)	Время создания транзакции. Формат: "2020-01-01T00:00:00+03:00"
items[].updated_at	string(1-255)	Время последнего обновления транзакции. Формат: "2020-01-01T00:00:00+03:00"
items[].order_id	string(1-255)	Идентификатор транзакции в вашей системе
items[].action	string(1-255)	Действие, "deposit" или "withdrawal"
items[].method	string(1-255)	Метод ввода или вывода
items[].type	string(1-255)	Тип транзакции
items[].account	string(1-255)	Контрагент
items[].amount	string(1-255)	Сумма
items[].currency	string(1-255)	Валюта
items[].payment_amount	string(1-255)	Реально оплаченная сумма
items[].commission	string(1-255)	Комиссия по транзакции
items[].comment	string(1-255)	Примечание по транзакции
items[].status	string(1-255)	Статус транзакции
items[].payment_error_code	string(1-255)	Код ошибки
items[].payment_error	string(1-255)	Сообщение об ошибке
items[].payment_code	string(1-255)	Платежный код
items[].payment_url	string(1-255)	Ссылка на оплату
items[].wallet_number	string(1-255)	Номер кошелька
items[].card_number	string(1-255)	Номер карты для оплаты
items[].crypto_address	string(1-255)	Номер крипто кошелька
items[].bank_id	string(1-255)	Номер банка
items[].last_name	string(1-255)	Фамилия
items[].first_name	string(1-255)	Имя
items[].middle_name	string(1-255)	Отчество
page[number]	integer	Номер полученной страницы
page[size]	integer	Размер полученной страницы

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

{
  "page": {
    "number": 1,
    "size": 20
  },
  "items": [
    {
      "id": 20,
      "created_at": "2020-01-01T00:00:00+03:00",
      "updated_at": "2020-01-01T00:00:00+03:00",
      "action": "deposit",
      "method": "wallet",
      "type": "site",
      "order_id": "order 123",
      "account": "account123",
      "amount": "105.23",
      "currency": "RUB",
      "payment_amount": "55.23",
      "commission": "2.04",
      "comment": "Transaction comment",
      "status": "process",
      "payment_url": "http://your.host/your-url",
      "payment_code": "code1",
      "payment_error_code": "error code 1",
      "payment_error": "some payment error",
      "wallet_number": "79344344444",
      "card_number": "3947333443347584",
      "first_name": "Ivan",
      "last_name": "Ivanov",
      "middle_name": "Ivanovich",
      "crypto_address": "TQSZsABz2vNizCA26HKEEyoybdeZmCpvP6",
      "crypto_blockchain": "tron",
      "bank_id": "1000000111"
    }
  ]
}