Внесите корректировки в платежные данные

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Введение

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

Изучение страницы «Корректировки счетов».

Перейдите на страницу «Корректировки счетов», как описано ниже.

Добавить корректировку счета

Для внесения корректировки в счет:

1. Перейдите на страницу «Корректировки счетов» .
2. Щелчок + Настройка .
3. Введите следующую информацию:

   Поле	Описание
   Имя	Описательное название, которое будет отображаться в платежном документе.
   Корректирование %	Сумма корректировки в виде положительного или отрицательного процента. Положительный процент увеличивает долю выручки или комиссионные сборы в сделке на этот процент. Отрицательный процент уменьшает долю выручки или комиссионные сборы в сделке на этот процент. Введите положительное или отрицательное число с точностью до двух знаков после запятой.
   Месяц выставления счетов	Месяц выставления счета для корректировки. Выберите месяц из выпадающего списка.
   Тип транзакции	Тип транзакции, к которой вы хотите применить корректировку. Выберите значение из выпадающего списка: Все транзакции Оплата (транзакции по модели оплаты) Покупка (сделки по модели распределения доходов) Возврат средств (в рамках модели распределения доходов)
   Продукт	Для каждого продукта API необходимо применить корректировку. Вы не можете применить одну корректировку к нескольким продуктам API. Если вам необходимо применить корректировку к нескольким продуктам API, создайте корректировку для каждого продукта отдельно. Выберите продукт API из выпадающего меню.
   Разработчик	Разработчик, к которому вы хотите применить корректировку. Вы можете применить корректировку ко всем разработчикам (по умолчанию) или к конкретному разработчику. Выберите «Все разработчики» или выберите конкретного разработчика из выпадающего меню.

4. Нажмите «Создать корректировку» .

Редактирование корректировки счета

Чтобы отредактировать корректировку счета:

1. Перейдите на страницу «Корректировки счетов» .
2. Наведите курсор на нужную корректировку счета и щелкните. в меню действий.
3. При необходимости внесите необходимые корректировки в счет.
4. Нажмите «Обновить корректировку» .

Внесение корректировок в платежные системы с помощью API.

В следующих разделах описано, как вносить корректировки в платежные данные с помощью API.

Внесение корректировок в счет с помощью API.

Вы можете изменить платежные данные, отправив POST-запрос на адрес /organizations/{org_name}/billing-adjustments. В теле запроса укажите:

• Название для корректировки счета.
• Процент корректировки, то есть положительное или отрицательное процентное значение, которое соответственно увеличивает или уменьшает счет.
• Рассчитываемый месяц.
• Расчетный год.
• Организация, к которой применяется корректировка счета.

Вы также можете указать другие свойства, например:

• Тип транзакции, к которой вы хотите применить корректировку (например, транзакция покупки).
• Разработчик, к которому вы хотите применить корректировку.
• Вы можете применить корректировку к разработчикам, использующим предоплаченные тарифы, разработчикам, использующим постоплатные тарифы, или к обоим типам.
• Пакет API, к которому вы хотите применить корректировку.
• API-продукт, к которому вы хотите применить корректировку.

Полный список свойств корректировки счетов, которые можно указать в запросе на корректировку, см. в разделе «Настройки конфигурации корректировки счетов» .

Если необязательное свойство не указано, корректировка платежного документа будет применяться ко всем свойствам, указанным в нем. Например, если тип транзакции не указан, корректировка платежного документа будет применяться ко всем типам транзакций.

В следующем примере производится корректировка выставления счетов за открытый расчетный месяц, июнь 2013 года. Корректировка уменьшает сумму на 3% и применяется к транзакциям покупки, платежному продукту и разработчикам, использующим постоплатные тарифы. Поскольку свойства для идентификации конкретного разработчика или пакета API не указаны, корректировка будет применена ко всем разработчикам (которые являются разработчиками, использующими постоплатные тарифы) и платежному продукту во всех пакетах API.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "name": "Purchase Adjustment Negative3",
  "adjustmentPercentageFactor": -3,
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
  },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \
-u email:password

Ответ должен выглядеть примерно так (показана только часть ответа):

{
  "adjustmentPercentageFactor" : -3,
  "billingMonth" : 6,
  "billingYear" : 2017,
  "developerBillingType" : "POSTPAID",
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
  "isPublished" : false,
  "name" : "Purchase Adjustment Negative3",
  "organization" : {
   ...
  },
  "product" : {
    "customAtt1Name" : "user",
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "payment",
    "organization" : {
      ...
    },
    "status" : "CREATED",
    "transactionSuccessCriteria" : "Status=='200 OK'"
  },
  "transactionType" : "PURCHASE"
}

Просмотр корректировок платежей с помощью API

Вы можете просмотреть конкретную корректировку выставления счетов или все корректировки выставления счетов для организации. Чтобы просмотреть конкретную корректировку выставления счетов, отправьте GET-запрос по адресу /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} , где {billing_adjustment_id} — это идентификатор конкретной корректировки выставления счетов (ID возвращается в ответе при создании корректировки выставления счетов). Например:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

Чтобы просмотреть все корректировки счетов для организации, отправьте GET-запрос по адресу /organizations/{org_name}/billing-adjustments . Например:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ 
-u email:password

Ответ должен выглядеть примерно так (показана только часть ответа):

{
  "billingAdjustment" : [ {
    "adjustmentPercentageFactor" : -3,
    "billingMonth" : 6,
    "billingYear" : 2017,
    "developerBillingType" : "POSTPAID",
    "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
    "isPublished" : false,
    "name" : "Purchase Adjustment Negative3",
    "organization" : {
      ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    },
    "transactionType" : "PURCHASE"
  }, {
    "adjustmentPercentageFactor" : 5.0000,
    "billingMonth" : 5,
    "billingYear" : 2017,
    "id" : "53c363c0-7e1d-4dc1-9392-cf86656225f2",
    "isPublished" : false,
    "monetizationPackage" : {
      "description" : "Communications",
      "displayName" : "Communications",
      "id" : "communications",
      "name" : "Communications",
      "organization" : {
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Messaging",
        "displayName" : "Messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
          ...
        },
        "status" : "CREATED"
      }, {
        ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Test Package Adjustment",
    "organization" : {
     ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    }
  } ],
  "totalRecords" : 2
}

Обновление корректировки счета с помощью API

Обновить корректировку счета можно, отправив PUT-запрос по адресу /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} , где {billing_adjustment_id} — это идентификатор конкретной корректировки счета. При обновлении необходимо указать в теле запроса обновляемые свойства и идентификатор корректировочной корректировки счета, которую нужно обновить. Также необходимо указать обязательные свойства для корректировки счета, а именно: название, процент корректировки, месяц выставления счета, год выставления счета и организацию.

Например, следующий вызов API обновляет коэффициент корректировки в процентах и ​​его название (обновленные свойства выделены в примере):

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c ",
  "adjustmentPercentageFactor": -5,
  "name" : "Purchase Adjustment Negative5",
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
    },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

Удаление корректировки платежа с помощью API

Удалить корректировку счета можно, отправив запрос DELETE по адресу /organizations/{org_name}/billing-adjustments/{billing_adjustment_id} , где {billing_adjustment_id} — это идентификатор корректировки счета, которую необходимо удалить. Например:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

Настройки конфигурации корректировки платежей для API

Для корректировки счетов доступны следующие параметры конфигурации:

Следующие шаги

Монетизация предоставляет вам возможность выдавать кредиты разработчику. Это может потребоваться, если разработчик недоволен услугой и запрашивает частичный или полный возврат средств за использование в течение определенного периода. Узнайте, как выдавать кредиты, в разделе «Выдача кредитов» .