Активация и деактивация кассовой ссылки

В этом разделе описаны действия с кассовой ссылкой и платежными табличками:

Активация кассовой ссылки
Изменение торговой точки, привязанной к кассовой ссылке
Деактивация кассовой ссылки
Активация ранее деактивированной кассовой ссылки

Как это работает

Чтобы принимать платежи через платежную табличку, необходимо активировать кассовую ссылку. Когда вы активируете кассовую ссылку, платежная табличка привязывается к вашей торговой точке и вы можете начать принимать платежи.

Для активации кассовой ссылки вам нужны такие данные:

идентификатор торговой точки — менеджер ЮKassa сообщит его при подключении офлайн‑платежей;
кассовая ссылка — вы получите ее, отсканировав QR-код на табличке.

Вы передаете эти данные в ЮKassa — создаете объект кассовой ссылки, а затем получаете ее идентификатор. Он нужен, чтобы проводить платежи и управлять платежными табличками. Например, деактивировать кассовую ссылку на табличке или изменить торговую точку, привязанную к кассовой ссылке.

После успешной привязки табличку можно разместить в любом удобном для пользователей месте.

Активация кассовой ссылки

Шаг 1. Активируйте кассовую ссылку — создайте объект кассовой ссылки: передайте в запросе данные для аутентификации запроса, ключ идемпотентности и следующие данные:

в объекте recipient передайте идентификатор торговой точки, который получили от менеджера ЮKassa при подключении;
в объекте pos_link_data передайте кассовую ссылку, которую получили при сканировании QR-кода с платежной таблички.

Пример запроса на активацию кассовой ссылки

cURL

  curl https://api.yookassa.ru/v3/pos_links \
    -X POST \
    -u <Идентификатор магазина>:<Секретный ключ> \
    -H 'Idempotence-Key: <Ключ идемпотентности>' \
    -H 'Content-Type: application/json' \
    -d '{
            "recipient": {
              "gateway_id": "456"
            },
            "pos_link_data": {
              "link": "https://qr.nspk.ru/AD100003N2S98C2U48D6N60M12345678"
            }
          }'

В ответ на запрос ЮKassa вернет созданный объект кассовой ссылки в статусе active.

Пример созданного объекта кассовой ссылки

JSON

{
  "id": "pl-1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
  "status": "active",
  "type": "nspk",
  "recipient": {
    "gateway_id": "456"
  },
  "payment": {
    "id": "22e12f66-000f-5000-8000-18db351245c7",
    "status": "succeeded"
  }
}

Шаг 2. Сохраните идентификатор кассовой ссылки (id). Он нужен, чтобы управлять платежными табличками и принимать платежи — записывать сумму в кассовую ссылку.

Готово! Можно принимать платежи.

Изменение торговой точки, привязанной к кассовой ссылке

Отправьте ЮKassa запрос на изменение торговой точки и передайте в нем объект recipient с идентификатором новой торговой точки, к которой хотите привязать табличку и кассовую ссылку (gateway_id).

Пример запроса на изменение торговой точки

cURL

  curl https://api.yookassa.ru/v3/pos_links/{pos_link_id}/recipient \
    -X POST \
    -u <Идентификатор магазина>:<Секретный ключ> \
    -H 'Idempotence-Key: <Ключ идемпотентности>' \
    -H 'Content-Type: application/json' \
    -d '{
            "recipient": {
              "gateway_id": "456"
            }
          }'

В ответ на запрос ЮKassa вернет обновленный объект кассовой ссылки с новым идентификатором торговой точки.

Пример объекта кассовой ссылки

JSON

{
  "id": "pl-1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
  "status": "active",
  "type": "nspk",
  "recipient": {
    "gateway_id": "456"
  },
  "payment": {
    "id": "22e12f66-000f-5000-8000-18db351245c7",
    "status": "succeeded"
  }
}

Готово! Теперь платежи будут проходить на другой торговой точке, вы можете переместить платежную табличку.

Деактивация кассовой ссылки

Чтобы приостановить прием платежей по табличке, отправьте ЮKassa запрос на деактивацию с идентификатором кассовой ссылки и пустым телом запроса.

Пример запроса на деактивацию кассовой ссылки

cURL

  curl https://api.yookassa.ru/v3/pos_links/{pos_link_id}/deactivate \
    -X POST \
    -u <Идентификатор магазина>:<Секретный ключ>

В ответ на запрос ЮKassa вернет обновленный объект кассовой ссылки в статусе inactive.

Пример объекта кассовой ссылки

JSON

{
  "id": "pl-1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
  "status": "inactive",
  "type": "nspk",
  "recipient": {
    "gateway_id": "456"
  },
  "payment": {
    "id": "22e12f66-000f-5000-8000-18db351245c7",
    "status": "succeeded"
  }
}

Готово! Платежи по этой табличке теперь недоступны.

Активация ранее деактивированной кассовой ссылки

Чтобы вновь принимать платежи по этой платежной табличке, отправьте ЮKassa запрос на активацию деактивированной ссылки с идентификатором кассовой ссылки и пустым телом запроса.

Пример запроса на активацию деактивированной ссылки

cURL

  curl https://api.yookassa.ru/v3/pos_links/{pos_link_id}/activate \
    -X POST \
    -u <Идентификатор магазина>:<Секретный ключ>

В ответ на запрос ЮKassa вернет обновленный объект кассовой ссылки в статусе active.

Пример объекта кассовой ссылки

JSON

{
  "id": "pl-1da5c87d-0984-50e8-a7f3-8de646dd9ec9",
  "status": "active",
  "type": "nspk",
  "recipient": {
    "gateway_id": "456"
  },
  "payment": {
    "id": "22e12f66-000f-5000-8000-18db351245c7",
    "status": "succeeded"
  }
}

Готово! Платежи по этой табличке вновь доступны.

Что почитать еще

О платежных табличках

Проведение платежей

Основы работы с API

Обработка ответов: формат ответа