Получение списка транзакций по водителю (курьеру)

Request

POST

https://fleet-api.taxi.yandex.net/v2/parks/driver-profiles/transactions/list

Headers

Name	Description
Accept-Language	Type: string Предпочитаемый язык ответа Min length: `2` Example: `ru`
X-API-Key	Type: string API-ключ Min length: `1` Example: `<API-ключ>`
X-Client-ID	Type: string Идентификатор клиента Min length: `1` Example: `<Идентификатор клиента>`

Body

application/json

{
  "query": {
    "park": {
      "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
      "driver_profile": {
        "id": "33de650c6a1a40bfa78dd981817da866"
      },
      "transaction": {
        "event_at": {
          "from": "2019-08-08T11:58:01+03:00",
          "to": null
        },
        "category_ids": [
          "partner_service_manual"
        ]
      }
    }
  },
  "limit": 40,
  "cursor": "example"
}

Name	Description
query	Type: ParksParksDriverProfilesTransactionsListQuery Example `{ "park": { "id": "ee6f33c4562b4e1f8646d157bd70b2c4", "driver_profile": { "id": "33de650c6a1a40bfa78dd981817da866" }, "transaction": { "event_at": { "from": "2019-08-08T11:58:01+03:00", "to": null }, "category_ids": [ "partner_service_manual" ] } } }`
cursor	Type: RequestCursor Курсор для получения следующий порции данных, значение должно быть взято из ответа на предыдущий запрос Min length: `1` Example: `example`
limit	Type: TransactionsListLimit Ограничение сверху на число транзакций в ответе Default: `40` Min value: `1` Max value: `1000` Example: `40`

ParkId

Идентификатор партнёра

Type: string

Min length: 1

Max length: 100

Example: ee6f33c4562b4e1f8646d157bd70b2c4

DriverProfileId

Идентификатор водителя

Type: string

Min length: 1

Max length: 100

Example: 33de650c6a1a40bfa78dd981817da866

ParksParksDriverProfilesTransactionsListQueryParkDriverProfile

Name

Description

Type: DriverProfileId

Идентификатор водителя

Min length: 1

Max length: 100

Example: 33de650c6a1a40bfa78dd981817da866

Example

{
  "id": "33de650c6a1a40bfa78dd981817da866"
}

DateTime

ISO 8601 с временной зоной

Type: string<date-time>

Example: 2019-08-08T11:58:01+03:00

DateTimeInterval

Name

Description

from

Type: DateTime

ISO 8601 с временной зоной

Example: 2019-08-08T11:58:01+03:00

Type: DateTime

ISO 8601 с временной зоной

Example: 2019-08-08T11:58:01+03:00

Example

{
  "from": "2019-08-08T11:58:01+03:00",
  "to": null
}

TransactionCategoryId

Категория транзакции. Допустимые значения можно получить через API /v2/parks/transactions/categories/list.

Type: string

Min length: 1

Max length: 100

Example: partner_service_manual

TransactionCategoryIds

Массив неповторяющихся идентификаторов категорий транзакций

Type: TransactionCategoryId[]

Min items: 1

Max items: 100

Example

[
  "partner_service_manual"
]

ListQueryParkTransaction

Name

Description

event_at

Type: DateTimeInterval

Example

{
  "from": "2019-08-08T11:58:01+03:00",
  "to": null
}

category_ids

Type: TransactionCategoryIds

Массив неповторяющихся идентификаторов категорий транзакций

Min items: 1

Max items: 100

Example

[
  "partner_service_manual"
]

Example

{
  "event_at": {
    "from": "2019-08-08T11:58:01+03:00",
    "to": null
  },
  "category_ids": [
    "partner_service_manual"
  ]
}

ParksParksDriverProfilesTransactionsListQueryPark

Name	Description
driver_profile	Type: ParksParksDriverProfilesTransactionsListQueryParkDriverProfile Example `{ "id": "33de650c6a1a40bfa78dd981817da866" }`
id	Type: ParkId Идентификатор партнёра Min length: `1` Max length: `100` Example: `ee6f33c4562b4e1f8646d157bd70b2c4`
transaction	Type: ListQueryParkTransaction Example `{ "event_at": { "from": "2019-08-08T11:58:01+03:00", "to": null }, "category_ids": [ "partner_service_manual" ] }`

Example

{
  "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "driver_profile": {
    "id": "33de650c6a1a40bfa78dd981817da866"
  },
  "transaction": {
    "event_at": {
      "from": "2019-08-08T11:58:01+03:00",
      "to": null
    },
    "category_ids": [
      "partner_service_manual"
    ]
  }
}

ParksParksDriverProfilesTransactionsListQuery

Name

Description

park

Type: ParksParksDriverProfilesTransactionsListQueryPark

Example

{
  "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "driver_profile": {
    "id": "33de650c6a1a40bfa78dd981817da866"
  },
  "transaction": {
    "event_at": {
      "from": "2019-08-08T11:58:01+03:00",
      "to": null
    },
    "category_ids": [
      "partner_service_manual"
    ]
  }
}

Example

{
  "park": {
    "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "driver_profile": {
      "id": "33de650c6a1a40bfa78dd981817da866"
    },
    "transaction": {
      "event_at": {
        "from": "2019-08-08T11:58:01+03:00",
        "to": null
      },
      "category_ids": [
        "partner_service_manual"
      ]
    }
  }
}

TransactionsListLimit

Ограничение сверху на число транзакций в ответе

Type: integer

Default: 40

Min value: 1

Max value: 1000

RequestCursor

Курсор для получения следующий порции данных, значение должно быть взято из ответа на предыдущий запрос

Type: string

Min length: 1

Example: example

Responses

200 OK

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

Body

application/json

{
  "transactions": [
    {
      "id": "100200400",
      "event_at": "2019-08-08T11:58:01+03:00",
      "category_id": "partner_service_manual",
      "category_name": "Платежи по расписанию",
      "amount": "12345.1434",
      "currency_code": "RUB",
      "description": "Списание №13",
      "created_by": {
        "identity": "dispatcher",
        "passport_uid": "123456789",
        "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a",
        "dispatcher_name": "Вася Пупкин"
      },
      "driver_profile_id": "33de650c6a1a40bfa78dd981817da866",
      "order_id": "c8d40acf182b4b32af72f6ad2029031b",
      "event_id": "ee6f33c4562b4e1f8646d157bd70b2c4"
    }
  ],
  "limit": 40,
  "cursor": ""
}

Name	Description
cursor	Type: ResponseCursor Курсор для получения следующий порции данных Example: ``
limit	Type: TransactionsListLimit Ограничение сверху на число транзакций в ответе Default: `40` Min value: `1` Max value: `1000` Example: `40`
transactions	Type: ParksTransactionsList Example [ { "id": "100200400", "event_at": "2019-08-08T11:58:01+03:00", "category_id": "partner_service_manual", "category_name": "Платежи по расписанию", "amount": "12345.1434", "currency_code": "RUB", "description": "Списание №13", "created_by": { "identity": "dispatcher", "passport_uid": "123456789", "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a", "dispatcher_name": "Вася Пупкин" }, "driver_profile_id": "33de650c6a1a40bfa78dd981817da866", "order_id": "c8d40acf182b4b32af72f6ad2029031b", "event_id": "ee6f33c4562b4e1f8646d157bd70b2c4" } ]

TransactionId

Type: string

Min length: 1

Max length: 100

Example: 100200400

TransactionCategoryName

Локализованное название категории транзакции

Type: string

Min length: 1

Max length: 100

Example: Платежи по расписанию

Amount

Сумма с фиксированной точностью

Type: string

Max length: 20

Example: 12345.1434

CurrencyCode

Type: string

Example: RUB

Description

Type: string

Example: Списание №13

PassportUID

Паспортный идентификатор пользователя

Type: string

Example: 123456789

DispatcherID

Идентификатор диспетчера

Type: string

Example: 3621b3429ea04d989adf5ff4d5515d6a

DispatcherName

Имя диспетчера

Type: string

Example: Вася Пупкин

TransactionCreatedByDispatcher

Name	Description
dispatcher_id	Type: DispatcherID Идентификатор диспетчера Example: `3621b3429ea04d989adf5ff4d5515d6a`
dispatcher_name	Type: DispatcherName Имя диспетчера Example: `Вася Пупкин`
identity	Type: string Const: `dispatcher` Example: `dispatcher`
passport_uid	Type: PassportUID Паспортный идентификатор пользователя Example: `123456789`

Example

{
  "identity": "dispatcher",
  "passport_uid": "123456789",
  "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a",
  "dispatcher_name": "Вася Пупкин"
}

TransactionCreatedByTechSupport

Name

Description

identity

Type: string

Const: tech-support

Example: tech-support

Example

{
  "identity": "tech-support"
}

FleetAPIClientID

fleet-api client id

Type: string

Example: taxi/park/abc123

FleetAPIKeyID

fleet-api api key id

Type: string

Example: 521

TransactionCreatedByFleetAPI

Name	Description
client_id	Type: FleetAPIClientID fleet-api client id Example: `taxi/park/abc123`
identity	Type: string Const: `fleet-api` Example: `fleet-api`
key_id	Type: FleetAPIKeyID fleet-api api key id Example: `521`

Example

{
  "identity": "fleet-api",
  "client_id": "taxi/park/abc123",
  "key_id": "521"
}

TransactionCreatedByPlatform

Name

Description

identity

Type: string

Const: platform

Example: platform

Example

{
  "identity": "platform"
}

TransactionCreatedBy

One of 4 types

Type: TransactionCreatedByDispatcher

Example

{
  "identity": "dispatcher",
  "passport_uid": "123456789",
  "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a",
  "dispatcher_name": "Вася Пупкин"
}

Type: TransactionCreatedByTechSupport
Example
```
{
  "identity": "tech-support"
}
```

Type: TransactionCreatedByFleetAPI

Example

{
  "identity": "fleet-api",
  "client_id": "taxi/park/abc123",
  "key_id": "521"
}

Type: TransactionCreatedByPlatform
Example
```
{
  "identity": "platform"
}
```

Example

{
  "identity": "dispatcher",
  "passport_uid": "123456789",
  "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a",
  "dispatcher_name": "Вася Пупкин"
}

OrderId

Идентификатор заказа

Type: string

Min length: 1

Max length: 100

Example: c8d40acf182b4b32af72f6ad2029031b

FleetExternalBusinessEventId

Идентификатор события, инициирующий создание транзакций через api

Type: string

Min length: 1

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Transaction

Name	Description
amount	Type: Amount Сумма с фиксированной точностью Max length: `20` Example: `12345.1434`
category_id	Type: TransactionCategoryId Категория транзакции. Допустимые значения можно получить через API /v2/parks/transactions/categories/list. Min length: `1` Max length: `100` Example: `partner_service_manual`
category_name	Type: TransactionCategoryName Локализованное название категории транзакции Min length: `1` Max length: `100` Example: `Платежи по расписанию`
created_by	Type: TransactionCreatedBy Example `{ "identity": "dispatcher", "passport_uid": "123456789", "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a", "dispatcher_name": "Вася Пупкин" }`
currency_code	Type: CurrencyCode Example: `RUB`
description	Type: Description Example: `Списание №13`
event_at	Type: DateTime ISO 8601 с временной зоной Example: `2019-08-08T11:58:01+03:00`
id	Type: TransactionId Min length: `1` Max length: `100` Example: `100200400`
driver_profile_id	Type: DriverProfileId Идентификатор водителя Min length: `1` Max length: `100` Example: `33de650c6a1a40bfa78dd981817da866`
event_id	Type: FleetExternalBusinessEventId Идентификатор события, инициирующий создание транзакций через api Min length: `1` Example: `ee6f33c4562b4e1f8646d157bd70b2c4`
order_id	Type: OrderId Идентификатор заказа Min length: `1` Max length: `100` Example: `c8d40acf182b4b32af72f6ad2029031b`

Example

{
  "id": "100200400",
  "event_at": "2019-08-08T11:58:01+03:00",
  "category_id": "partner_service_manual",
  "category_name": "Платежи по расписанию",
  "amount": "12345.1434",
  "currency_code": "RUB",
  "description": "Списание №13",
  "created_by": {
    "identity": "dispatcher",
    "passport_uid": "123456789",
    "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a",
    "dispatcher_name": "Вася Пупкин"
  },
  "driver_profile_id": "33de650c6a1a40bfa78dd981817da866",
  "order_id": "c8d40acf182b4b32af72f6ad2029031b",
  "event_id": "ee6f33c4562b4e1f8646d157bd70b2c4"
}

ParksTransactionsList

Type: Transaction[]

Example

[
  {
    "id": "100200400",
    "event_at": "2019-08-08T11:58:01+03:00",
    "category_id": "partner_service_manual",
    "category_name": "Платежи по расписанию",
    "amount": "12345.1434",
    "currency_code": "RUB",
    "description": "Списание №13",
    "created_by": {
      "identity": "dispatcher",
      "passport_uid": "123456789",
      "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a",
      "dispatcher_name": "Вася Пупкин"
    },
    "driver_profile_id": "33de650c6a1a40bfa78dd981817da866",
    "order_id": "c8d40acf182b4b32af72f6ad2029031b",
    "event_id": "ee6f33c4562b4e1f8646d157bd70b2c4"
  }
]

ResponseCursor

Курсор для получения следующий порции данных

Type: string

Example: ``

400 Bad Request

Некорректные параметры запроса

Body

application/json

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

Name

Description

message

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Example: example

401 Unauthorized

Отсутствуют параметры авторизации запроса

Body

application/json

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

Name

Description

message

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Example: example

403 Forbidden

Недостаточно прав для выполнения запроса

Body

application/json

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

Name

Description

message

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Example: example

429 Too Many Requests

Превышено допустимое число запросов

Body

application/json

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

Name

Description

message

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Example: example

500 Internal Server Error

Внутренняя ошибка сервера

Body

application/json

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

Name

Description

message

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Example: example

Была ли статья полезна?

Создание транзакции на балансе водителя (курьера) (Устаревший)

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