Список пин-кодов по статусу (campaigns/get-pins-by-status)
Метод позволяет получить все пин-коды для определенной кампании по статусу: вы передаете статус, а в ответ получаете список всех пин-кодов в этом статусе.
 
Запрос
Адрес для отправки запроса
POST https://yoomoney.ru/api/offerwall/v1/campaigns/get-pins-by-status
Параметры
Агрегатор или магазин определяется по токену.
ПараметрТипОписание
partnerCampaignIdint
Идентификатор кампании. Возвращается в ответе на запрос campaigns/create.
Обязательный параметр
pinStatusstring
Статус пин-кода. Возможные значения:
  • 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'
 
Ответ
Параметры
ПараметрТипОписание
ymCampaignIdintУникальный идентификатор кампании.
pinStatusstringСтатус выбранных пин-кодов.
pinsobjectОбъект, содержащий все пин-коды в этом статусе.
Пример тела ответа
JSON
{
    "status": "success",
  "result": {
    "ymCampaignId": 60,
    "pinStatus": "accepted_by_user",
    "pins": [
      "dykLadno",
      "storubley",
      "1234567"
    ]
  }
}