Create transaction on driver (courier) account

Request

POST

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

Headers

Name	Description
X-API-Key*	Type: string API-key Example: `<API key>` Min length: `1`
X-Client-ID*	Type: string Client ID Example: `<Client ID>` Min length: `1`
X-Idempotency-Token*	Type: string Idempotent request token. Must contain only printable ASCII characters Example: `c56fa6537e5a4adbbce6ef3593210fb9` Min length: `16` Max length: `64`

Body

application/json

{
    "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "driver_profile_id": "33de650c6a1a40bfa78dd981817da866",
    "category_id": "partner_service_manual_3",
    "amount": "12345.1434",
    "description": "Charging #13"
}

Name	Description
amount*	Type: string Fixed-point sum Example: `12345.1434` Max length: `20`
category_id*	Type: string Category of the transaction being created Categories with `is_creatable` = true are allowed in the list of transaction categories Example: `partner_service_manual_3`
description*	Type: string Example: `Charging #13`
driver_profile_id*	Type: string Driver ID Example: `33de650c6a1a40bfa78dd981817da866` Min length: `1` Max length: `100`
park_id*	Type: string Partner ID Example: `ee6f33c4562b4e1f8646d157bd70b2c4` Min length: `1` Max length: `100`

Responses

200 OK

Transaction has been successfully created

Body

application/json

{
    "event_at": "2019-08-08T11:58:01+03:00",
    "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "driver_profile_id": "33de650c6a1a40bfa78dd981817da866",
    "category_id": "partner_service_manual",
    "amount": "12345.1434",
    "currency_code": "RUB",
    "description": "Charging #13",
    "created_by": {
        "identity": "dispatcher",
        "passport_uid": "123456789",
        "dispatcher_id": "3621b3429ea04d989adf5ff4d5515d6a",
        "dispatcher_name": "John Smith"
    }
}

Name	Description
amount*	Type: string Fixed-point sum Example: `12345.1434` Max length: `20`
category_id*	Type: string Transaction category. Possible values can be obtained through the API /v2/parks/transactions/categories/list. Example: `partner_service_manual` Min length: `1` Max length: `100`
created_by*	Type: TransactionCreatedByDispatcher or TransactionCreatedByTechSupport or TransactionCreatedByFleetAPI or TransactionCreatedByPlatform
currency_code*	Type: string Example: `RUB`
description*	Type: string Example: `Charging #13`
driver_profile_id*	Type: string Driver ID Example: `33de650c6a1a40bfa78dd981817da866` Min length: `1` Max length: `100`
event_at*	Type: string<date-time> ISO 8601 with time zone Example: `2019-08-08T11:58:01+03:00`
park_id*	Type: string Partner ID Example: `ee6f33c4562b4e1f8646d157bd70b2c4` Min length: `1` Max length: `100`

TransactionCreatedByDispatcher

Name	Description
dispatcher_id*	Type: string Dispatcher ID Example: `3621b3429ea04d989adf5ff4d5515d6a`
dispatcher_name*	Type: string Dispatcher name Example: `John Smith`
identity*	Type: string Example: `dispatcher` Enum: `dispatcher`
passport_uid*	Type: string User passport ID Example: `123456789`

TransactionCreatedByTechSupport

Name

Description

identity*

Type: string

Example: tech-support

Enum: tech-support

TransactionCreatedByFleetAPI

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

TransactionCreatedByPlatform

Name

Description

identity*

Type: string

Example: platform

Enum: platform

400 Bad Request

Invalid request parameters

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

401 Unauthorized

Request authorization parameters are missing

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

403 Forbidden

Insufficient rights to execute the request

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

429 Too Many Requests

Limit of requests was exceeded

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

500 Internal Server Error

Internal server error

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

Was the article helpful?

Getting order track

Getting list of transactions by driver (courier)