/v1/operations/

Запрос на получение деталей операций авторизации, списания, возврата или отмены платежа.

Request

GET

https://pay.yandex.ru/api/merchant/v1/operations/{external_operation_id}

Production

GET

https://sandbox.pay.yandex.ru/api/merchant/v1/operations/{external_operation_id}

Sandbox

Path parameters

Name

Description

external_operation_id*

Type: string

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

Max length: 2048

Responses

200 OK

Body

application/json
{
    "code": 200,
    "data": {
        "operation": {
            "amount": "123.45",
            "created": "2022-12-29T18:02:01Z",
            "externalOperationId": "string",
            "operationId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
            "operationType": "AUTHORIZE",
            "orderId": "string",
            "params": {},
            "pointsAmount": "123.45",
            "reason": "string",
            "status": "PENDING",
            "updated": "2022-12-29T18:02:01Z"
        }
    },
    "status": "success"
}

Name

Description

code

Type: number

Default: 200

data

Type: OperationResponseData

status

Type: string

Default: success

Enum: success

OperationResponseData

Name

Description

operation

Type: Operation

Operation

Name

Description

amount*

Type: string<double>

Сумма операции в фиатной валюте

Example: 123.45

operationId*

Type: string<uuid>

Max length: 2048

operationType*

Type: string

Enum: AUTHORIZE, BIND_CARD, REFUND, CAPTURE, VOID, RECURRING, PREPAYMENT, SUBMIT

orderId*

Type: string

Max length: 2048

created

Type: string<date-time>

Дата и время создания операции (ISO 8601)

externalOperationId

Type: string

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

Max length: 2048

params

Type: object

pointsAmount

Type: string<double>

Сумма операции в баллах Плюса

Example: 123.45

reason

Type: string

Причина ошибки

Max length: 2048

status

Type: string

Default: PENDING

Enum: PENDING, SUCCESS, FAIL

updated

Type: string<date-time>

Дата и время обновления операции (ISO 8601)

Предыдущая
Следующая