Использование оффера (campaigns/redeem)
Агрегатор или магазин передает в сервис ЮMoney информацию о лидах — об использовании скидки или бонуса пользователями.
 
Запрос
Адрес для отправки запроса
POST https://yoomoney.ru/api/offerwall/v1/campaigns/redeem
Параметры
ПараметрТипОписание
ymCampaignIdint
Идентификатор кампании в сервисе ЮMoney. Возвращается в ответе на запрос campaigns/create.
Обязательный параметр
pinСontentstring
Содержание пин-кода (буквенно-числовая строка, регистр символов не учитывается). См. campaigns/create
Обязательный для кампаний с 
campaignType=codeOnline
и 
campaignType=codeOffline
с одноразовыми пин-кодами (
one-off
).
clickIdstring
Уникальный идентификатор клика.
Генерируется в сервисе ЮMoney в момент ссылки и добавляется к 
acceptUrl
(уникальная ссылка для получения оффера, по которой перенаправляется пользователь). См. campaigns/create
Обязательный для кампаний:
  • campaignType=promo
    ;
  • campaignType=codeOnline
    с 
    pinType=reusable
    ;
  • campaignType=codeOffline
    с 
    pinType=reusable
    .
transactionIdstring (36)
Идентификатор заказа на стороне магазина (в рамках которого использован оффер).
Должен быть уникальным для одной рекламной кампании.
Подойдут монотонно возрастающие числа, строка случайных символов или любой другой вариант.
Обязательный параметр
redeemStatusenum
Статус лида. Возможные значения:
  • used
     — лид совершен пользователем;
  • approved
     — магазин или агрегатор выплачивает вознаграждение сервису ЮMoney за этот лид;
  • declined
     — магазин или агрегатор не будет выплачивать вознаграждение сервису ЮMoney за этот лид (например, при возврате товара).
Необязательный параметр
sceneRedeemstring
Место совершения лида (использования скидки или бонуса).
Необязательный параметр
redeemTimedatetime
Время совершения лида (использования скидки или бонуса).
Необязательный параметр
campaignFeevarchar (30)
Размер вознаграждение ЮMoney по факту совершения лида. Число в рублях или долларах, два знака после точки.
Обязательный параметр
feeCurrencyCurrencyCode
Код валюты вознаграждения ЮMoney.
  • 643
     — рубль РФ (задается по умолчанию, если значение не передано);
  • 840
     — доллар США.
Необязательный параметр
orderAmountvarchar (30)
Сумма заказа. Число в рублях или долларах, два знака после точки.
Необязательный параметр
orderCurrencyCurrencyCode
Код валюты заказа.
  • 643
     — рубль РФ (задается по умолчанию, если значение не передано);
  • 840
     — доллар США.
Необязательный параметр
cashbackAmountvarchar (30)
Сумма кэшбэка. Число в рублях или долларах, два знака после точки.
Необязательный параметр
Пример тела запроса
JSON
{
    "campaignFee": 10,
    "ymCampaignId": 1,
    "clickId": "615737-1227535-12368",
    "pinContent": "ab12",
    "redeemTime": "2017-12-31T23:59:59+03:30",
    "redeemStatus": "used",
    "sceneRedeem": "1",
    "transactionId": "1"
}
Пример запроса
cURL
curl -X POST \
--header 'Content-Type: application/json' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Authorization: Bearer <авторизационный токен>' -d '{
    "campaignFee": 10,
    "ymCampaignId": 1,
    "clickId": "615737-1227535-12368",
    "pinContent": "ab12",
    "redeemTime": "2017-12-31T23:59:59+03:30",
    "redeemStatus": "used",
    "sceneRedeem": "1",
    "transactionId": "1"
}' 'https://yoomoney.ru/api/offerwall/v1/campaigns/redeem'
 
Ответ
Состояние операции (в обработке или ошибка).