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

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

Введение

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

Как пользоваться страницей "Корректировки платежей"

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

Как добавить корректирующую проводку

Чтобы добавить корректировку платежа:

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} – идентификатор корректирующей проводки (он возвращается в ответе при создании корректирующей проводки). Пример:

$ 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

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

Дальнейшие действия

Монетизация позволяет возвращать средства разработчикам. Это может потребоваться, если разработчик недоволен сервисом и запрашивает частичный или полный возврат средств за использование в течение определенного периода. Подробнее о том, как выставлять кредитовые авизо…