Получение списка платежей по водителю¶

Получение списка платежей по водителю

Запрос (Request)¶

GET-запрос¶

https://sedi.ru:9031/api/SeDiExternalSystems/get-transactions/

Заголовки (Headers)¶

Название	Описание
X-Api-Key	API-ключ
X-Client-ID	Ключ, определяющий партнера

Параметры¶

Название	Описание
limit	Максимальное возвращаемое количество. Тип: Int
query	Фильтр запроса. Тип ParksParksDriverProfilesTransactionsListQuery

ParksParksDriverProfilesTransactionsListQuery¶

Название	Описание
park	Параметры такси-фирмы в запросе. Тип ParksParksDriverProfilesTransactionsListQueryPark

ParksParksDriverProfilesTransactionsListQueryPark¶

Название	Описание
id	Идентификатор такси-группы. Тип: String
driver_profile	Профиль водителя. Тип ParksParksDriverProfilesTransactionsListQueryParkDriverProfile
transaction	Фильтр по времени запроса, указание времени от и до. Тип ListQueryParkTransaction
description	Описание платежной операции. Тип: String

ListQueryParkTransaction¶

Название	Описание
event_at	Интервал дат. Тип: DateTimeInterval

DateTimeInterval¶

Название	Описание
from	Время От. Тип: String
to	Время До. Тип: String

Пример тела запроса¶

{
    "query": {
        "park": {
            "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
            "driver_profile": {
                "id": "7522120"
            },
            "transaction": {
                "event_at": {
                    "from": "2025-01-01T11:58:01+03:00",
                    "to": "2025-03-07T23:58:01+03:00"
                }
            }
        }
    },
    "limit": 20 
}

Ответ¶

200 OK¶

Список платежей получен успешно

Параметры¶

Название	Описание
limit	Запрошенное максимальное возвращаемое количество. Тип: Int
transactions	мМссив платежей. Тип: Transaction[]

Transaction¶

Название	Описание
id	Идентификатор платежной операции. Тип: String
order_id	Идентификатор заказа, если платеж по заказу. Тип: String
currency_code	Код валюты. Тип: String
event_at	Время платежной операции. Тип: String
amount	Сумма. Тип: String
description	Описание платежа. Тип: String
driver_profile_id	Идентификатор водителя. Тип: String
park_id	Идентификатор такси-группы. Тип: String

{
  "transactions": [
    {
      "id": "111",
      "order_id": "223344",
      "currency_code": "RUB",
      "event_at": "2020-05-11T10:00:05+03:00",
      "amount": "50.00",
      "description": "Оплата за заказ",
      "driver_profile_id": "75112",
      "park_id": "7548"
    }
  ],
  "limit": 20
}

403 Forbidden¶

Некорректный API KEY.

400 BadRequest¶

Некорректные параметры запроса или пустые заголовки.

500 InternalServerError¶

Ошибка в процессе выполнения запроса

Error. Ошибка добавления¶

{
  "code": "код ошибки",
  "message": "текстовое описание ошибки"
}