/v1/onboard ⦸

Важно

Этот метод устарел. Не используйте его.

/v1/onboard

Запрос на подтверждение регистрации в консоли Яндекс Пэй.

Request

POST

https://example.merchant.ru/v1/onboard

Production

POST

https://sandbox.example.merchant.ru/v1/onboard

Sandbox

Body

application/json

{
    "apiKey": "string",
    "force": false,
    "merchantAuthToken": "string",
    "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b"
}

Name	Description
apiKey*	Type: string
merchantAuthToken*	Type: string Авторизационный токен, сгенерированный мерчантом
force	Type: boolean Default: `false`
merchantId	Type: string<uuid>

Responses

200 OK

Вебхук успешно получен и обработан. Тело ответа может быть любым, рекомендуем отправить {"status": "success"}. При получении 200 Яндекс Пэй прекращает отправку повторных вебхуков.

Body

application/json

{
    "status": "success"
}

Name

Description

status

Type: string

Default: success

400 Bad Request

Ошибка обработки вебхука. При отсутствии ответа или любом статусе кроме 200 Яндекс Пэй генерирует новый JWT-токен и повторяет отправку вебхука:

первые 10 раз через 5 мс;
далее с экспоненциально возрастающим интервалом до 15 минут;
затем каждые 15 минут в течение 24 часов. Общее время повторных отправок — 24 часа. После этого вебхук считается недоставленным.

Body

application/json

{
    "reason": "string",
    "reasonCode": "FORBIDDEN",
    "status": "fail"
}

Name	Description
reasonCode*	Type: string Код ошибки: `FORBIDDEN` — заказ существует, но был оплачен не через Яндекс Пэй; `ORDER_NOT_FOUND` — заказ не найден в системе продавца; `ORDER_AMOUNT_MISMATCH` — сумма заказа не совпадает с суммой в системе продавца; `ORDER_DETAILS_MISMATCH` — детали заказа отличаются от данных в системе продавца; `OTHER` — общая ошибка; `UNAUTHORIZED` — не удалось проверить подпись JWT-токена; `TOKEN_EXPIRED` — срок действия JWT-токена истек; `CONFLICT` — данные в нотификации расходятся с состоянием заказа в системе продавца. Например, пришла нотификация об оплате для отмененного заказа. Enum: `FORBIDDEN`, `ITEM_NOT_FOUND`, `ORDER_NOT_FOUND`, `ORDER_AMOUNT_MISMATCH`, `ORDER_DETAILS_MISMATCH`, `OUT_OF_INVENTORY`, `PICKUP_POINT_NOT_FOUND`, `SHIPPING_DETAILS_MISMATCH`, `OTHER`, `UNAUTHORIZED`, `TOKEN_EXPIRED`, `CONFLICT`
reason	Type: string Описание причины ошибки.
status	Type: string Default: `fail`

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

/v1/pickup-option-details ⦸

История изменений API