Список пин-кодов по статусу (campaigns/get-pins-by-status)

Метод позволяет получить все пин-коды для определенной кампании по статусу: вы передаете статус, а в ответ получаете список всех пин-кодов в этом статусе.

Запрос

Адрес для отправки запроса

POST https://yoomoney.ru/api/offerwall/v1/campaigns/get-pins-by-status

Параметры

Агрегатор или магазин определяется по токену.

Параметр	Тип	Описание
partnerCampaignId	int	Идентификатор кампании. Возвращается в ответе на запрос campaigns/create. Обязательный параметр
pinStatus	string	Статус пин-кода. Возможные значения: `new_unused` — ещё не использован; `accepted_by_user` — принят пользователем; `redeem_received` — использован пользователем. Обязательный параметр

Пример тела запроса

JSON
{
  "pinStatus": "accepted_by_user",
  "ymCampaignId": 60
}

Пример запроса

cURL
curl -X POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer: <авторизационный токен>' \
  -d '{
    "pinStatus": "accepted_by_user",
    "ymCampaignId": 60
  }' 'https://yoomoney.ru/api/offerwall/v1/campaigns/get-pins-by-status'

Ответ

Параметры

Параметр	Тип	Описание
ymCampaignId	int	Уникальный идентификатор кампании.
pinStatus	string	Статус выбранных пин-кодов.
pins	object	Объект, содержащий все пин-коды в этом статусе.

Пример тела ответа

JSON
{
  "status": "success",
  "result": {
    "ymCampaignId": 60,
    "pinStatus": "accepted_by_user",
    "pins": [
      "dykLadno",
      "storubley",
      "1234567"
    ]
  }
}