Get transaction status on contractor account

Request

GET

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

Query parameters

Name	Description
contractor_profile_id*	Type: string Driver's profile ID Example: `9b17db0cb1f24a38a5c3c8b4f6e4f63b`
id*	Type: string Transaction ID
park_id*	Type: string Partner ID Example: `ee6f33c4562b4e1f8646d157bd70b2c4`
version*	Type: integer Transaction version Min value: `1`

Responses

200 OK

Transaction status information

Body

application/json

{
    "id": "string",
    "park_id": "string",
    "contractor_profile_id": "string",
    "version_info": {
        "version": 0,
        "created_at": "2019-08-08T11:58:01+00:00",
        "status": "in_progress",
        "status_description": "string",
        "amount": "1050.5000",
        "fee_amount": "1050.5000"
    },
    "latest_version": 0,
    "latest_success_version": 0,
    "event_id": "string"
}

Name	Description
contractor_profile_id*	Type: string Contractor identifier Min length: `1` Max length: `100`
event_id*	Type: string ID of the event that initiates the creation of transactions via the api Min length: `1` Max length: `1000`
id*	Type: string Min length: `1` Max length: `1000`
latest_version*	Type: integer Min value: `1`
park_id*	Type: string Park ID Min length: `1` Max length: `100`
latest_success_version	Type: integer Min value: `1`
version_info	Type: EventVersion Transaction version

EventVersion

Transaction version

Name	Description
amount*	Type: string Example: `1050.5000` Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
created_at*	Type: string<date-time> Date and time in ISO 8601 format with timezone Example: `2019-08-08T11:58:01+00:00`
status*	Type: EventStatus Event processing status Enum: `in_progress`, `success`, `fail`
version*	Type: integer Min value: `1`
fee_amount	Type: string Example: `1050.5000` Pattern: `^-?[0-9]+(\.[0-9]{1,4})?$`
status_description	Type: string Min length: `1` Max length: `1000`

EventStatus

Event processing status

Type	Description
EventStatus	Enum: `in_progress`, `success`, `fail`

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

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 list of transaction categories