Создание/обновление индивидуального тарифа

Метод позволяет создать или обновить индивидуальный тариф.

Если для данного userId и action уже существует тариф, то остальные указанные данные перезапишут этот тариф

Запрос:

Параметр	Обязателен	Тип	Описание
userId	Да	Строка	Идентификатор пользователя
action	Да	Строка	Целевое действие по тарифу
amount	Да	Строка	Доля комиссии от суммы операции (например, 0.01 означает комиссию в 1% от суммы операции)
minAmount	Нет	Строка или null	Минимальная комиссия, для списания (например, при совершении операции будет списан 1% от суммы операции, но не менее чем minAmount) null - без ограничений
maxAmount	Нет	Строка или null	Максимальная комиссия, для списания (например, при совершении операции будет списан 1% от суммы операции, но не более чем maxAmount) null - без ограничений
comment	Нет	Строка или null	Пользовательский комментарий/заметка для тарифа

Параметр action может принимать следующие значения:

Тариф	Описание
INTERNAL_TRANSFER	Внутренний перевод
ORDER_DEPOSIT	Пополнение по ордеру
WALLET_DEPOSIT	Пополнение кошелька
WALLET_WITHDRAWAL	Вывод с кошелька
PAYOUT_DEPOSIT	Пополнение выплатного баланса
PAYOUT_WITHDRAWAL	Вывод с выплатного баланса
PERSONAL_DEPOSIT	Пополнение персональных адресов
PERSONAL_WITHDRAWAL	Вывод с персонального адреса
COLLECT_WITHDRAWAL	Вывод с головного адреса
RECURRENT_DEPOSIT	Пополнение рекурентного адреса (по подписке)
RECURRENT_WITHDRAWAL	Вывод с рекурентного адреса
BRIDGE_INTERNAL	Блокчейн мост
BRIDGE_EXTERNAL	Блокчейн мост через API
EXCHANGE_INTERNAL	Обмен
EXCHANGE_AUTO	Обмен через API

Создание/обновление индивидуального тарифа

post

Header parameters

x-api-public-keystringOptional

Публичный API-ключ

x-api-signaturestringOptional

Подпись тела запроса приватным API-ключем

Content-typestringOptional

Тип тела запроса

Example: application/json

Body

application/json

Тело запроса создания индивидуального тарифа

userIdstringOptional

Идентификатор пользователя

Example: ff72f744-beda-4cc4-8b44-2b3deb584f99

organizationIdstringOptional

Идентификатор организации

Example: 2a06421c-edae-4df1-9851-17d6479449e2

actionstring · enumOptional

Целевое действие по тарифу

Example: EXCHANGE_AUTOPossible values:

amountstringOptional

Доля комиссии от суммы операции (например, 0.01 означает комиссию в 1% от суммы операции)

Example: 0.03

typestring · enumOptional

Тип суммы тарифа

Example: PERCENTPossible values:

commentstring · nullableOptional

Комментарий тарифа

Example: tariff for John

minAmountstring · nullableOptional

Минимальная комиссия, для списания (например, при совершении операции будет списан 1% от суммы операции, но не менее чем minAmount)

null - без ограничений

Example: 0.1

maxAmountstring · nullableOptional

Максимальная комиссия, для списания (например, при совершении операции будет списан 1% от суммы операции, но не более чем maxAmount)

null - без ограничений

Example: 3000

Responses

200Success

application/json

post

/partner/api/set-organization-tariff

HTTPcURLJavaScriptPython

POST /partner/api/set-organization-tariff HTTP/1.1
Host: app.apollopayment.io
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "userId": "ff72f744-beda-4cc4-8b44-2b3deb584f99",
  "organizationId": "2a06421c-edae-4df1-9851-17d6479449e2",
  "action": "EXCHANGE_AUTO",
  "amount": "0.03",
  "type": "PERCENT",
  "comment": "tariff for John",
  "minAmount": "0.1",
  "maxAmount": "3000"
}

200Success

{
  "success": true,
  "response": null
}