Получение ссылки на оплату заказа

Возвращает подписанную ссылку на страницу оплаты заказа.

Отправьте ссылку покупателю — он сможет оплатить заказ без входа в аккаунт. Доступ к заказу обеспечивает подпись в параметре signature.

Ссылка постоянна — для одного заказа метод всегда выдает одинаковое значение. Ссылка доступна для заказа в любом статусе — в том числе для оплаченного или отмененного.

Примечание

У ссылки нет срока действия, отозвать ее отдельно нельзя. Отзыв API‑токена не аннулирует ранее выданные ссылки.

Request

GET

https://api.kit.yandex.net/v1/orders/{id}/payment-link

Query parameters

Name

Description

source

Type: string

Метка источника перехода: попадает в параметр from итоговой ссылки, чтобы магазин мог отличать в аналитике переходы из разных интеграций. Если не передан, используется api.

Max length: 32

Pattern: ^[a-z0-9_-]+$

Example: api

Responses

200 OK

Ссылка на оплату заказа.

Body

application/json

{
  "payment_url": "https://checkout.kit.yandex.ru/orders/my-store/019b56d1-5ef0-7ed2-a155-7110d25ca5ce?signature=c2lnbmF0dXJl&from=api"
}

Name

Description

payment_url

Type: string<uri>

Подписанная ссылка на страницу оплаты заказа.

Example: https://checkout.kit.yandex.ru/orders/my-store/019b56d1-5ef0-7ed2-a155-7110d25ca5ce?signature=c2lnbmF0dXJl&from=api

400 Bad Request

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

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

401 Unauthorized

Не авторизован.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

404 Not Found

Ресурс не найден.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

500 Internal Server Error

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

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

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

Запись кодов маркировки «Честный знак»

Список ресурсов