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

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

GET

## Урл запроса

/api/v2/transactions

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

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

<table><thead><tr><th width="180">Название</th><th width="81" data-type="checkbox">Обяз.</th><th width="151">Формат</th><th>Описание</th><th data-hidden>Описание</th><th data-hidden>Формат</th><th data-hidden data-type="checkbox">Обязательно</th></tr></thead><tbody><tr><td>filter[id]</td><td>false</td><td>string(1-200)</td><td>Фильтр по нашему идентификатору транзакции</td><td>Ваш уникальный номер заявки</td><td></td><td>false</td></tr><tr><td>filter[order_id]</td><td>false</td><td>string(1-255)</td><td>Фильтр по вашему идентификатору операции</td><td>Сумма по заявке</td><td></td><td>false</td></tr><tr><td>filter[account]</td><td>false</td><td>string(1-255)</td><td>Фильтр по</td><td></td><td></td><td>false</td></tr><tr><td>filter[action]</td><td>false</td><td>string(1-255)</td><td>Фильтр по действию транзакции. Допустимые значения "deposit", "withdrawal";</td><td></td><td></td><td>false</td></tr><tr><td>filter[method]</td><td>false</td><td>string(1-255)</td><td>Фильтр по методу ввода или вывода. Допустимые значения - коды методов ввода и вывода, указанные в нашей документации.</td><td></td><td></td><td>false</td></tr><tr><td>filter[type]</td><td>false</td><td>string(1-255)</td><td>Фильтр по типу транзакции. Допустимые значения "site", "invoice", "registry"</td><td></td><td></td><td>false</td></tr><tr><td>filter[create_at][start]</td><td>false</td><td>string(1-255)</td><td>Фильтр по времени создания транзакции, ограничивающий начало диапазона ( транзакции, созданные после указанного времени ). <br>Формат:<br>"2020-01-01T00:00:00+03:00"</td><td></td><td></td><td>false</td></tr><tr><td>filter[create_at][end]</td><td>false</td><td>string(1-255)</td><td>Фильтр по времени создания транзакции, ограничивающий начало диапазона ( транзакции, созданные до указанного времени ). <br>Формат:<br>"2020-01-01T00:00:00+03:00"</td><td></td><td></td><td>false</td></tr><tr><td>filter[amount][min]</td><td>false</td><td>string(1-255)</td><td>Фильтр по сумме транзакции, ограничивающий по сумме "снизу" ( транзакции, сумма которых превышает указанную )</td><td></td><td></td><td>false</td></tr><tr><td>filter[amount][max]</td><td>false</td><td>string(1-255)</td><td>Фильтр по сумме транзакции, ограничивающий по сумме "сверху" ( транзакции, сумма которых меньше указанной )</td><td></td><td></td><td>false</td></tr><tr><td>page[number]</td><td>false</td><td>integer</td><td>Номер "страницы" выдаваемой информации. По умолчанию 1</td><td></td><td></td><td>false</td></tr><tr><td>page[size]</td><td>false</td><td>integer</td><td>Размер "страницы" выдаваемой информации. По умолчанию 20</td><td></td><td></td><td>false</td></tr><tr><td>sort</td><td>false</td><td>string(1-255)</td><td>Название поля, по которому выполнять сортировку. Если перед ним указать минус, то сортировка будет в обратном порядке. По умолчанию "-id"</td><td></td><td></td><td>false</td></tr></tbody></table>

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

{% tabs %}
{% tab title="CURL" %}

```sh
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'
```

{% endtab %}

{% tab title="PHP + Guzzle" %}

```php
$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,
    ]
]);
```

{% endtab %}
{% endtabs %}

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

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

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

```
{
  "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"
    }
  ]
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://fkassa.gitbook.io/firekassa-api-v2/transactions/list.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.