API Documentation
Русский
Русский
  • Авторизация
  • Подпись запросов
  • Список кодов ошибок
  • Webhooks
  • IFrame ордер
  • Виджет приема оплаты
  • Telegram MiniApp
  • API Reference
    • Базовый функционал
      • Проверка корректности подписи x-api-signature
      • Получение монет доступных для приема/отправки транзакций
      • Запрос текущей цены
      • Поиск операции по TX-хешу
      • Проверка корректности адреса
      • Получение истории транзакций
    • Авансовый счет
      • Получение аккаунтов текущего пользователя
      • Получение аккаунта по его ID
      • Получение адреса для пополнения баланса аккаунта
    • Блокчейн-адреса
      • Поиск по ID
      • Отслеживание транзакций
      • Поиск по адресу
      • Мета-данные
      • Транзакции адреса
      • Последняя транзакция адреса
      • Получение списка PayIn адресов
      • Получение списка бизнес адресов
      • Получение рекуррентных адресов
      • Получение списка PayOut адресов
      • Создание нового адрес бизнес кошелька
      • Создание нового адрес PayOut кошелька
    • Персональные адреса
      • Создание пользователя
      • Получение адреса
      • Получение списка адресов
      • Получение пользователя
      • Добавление доверенного адреса
      • Получение списка доверенных адресов
      • Удаление доверенного адреса
    • Ордера
      • Создание ордера
      • Получение информации об ордере
      • Получение списка ордеров
    • Выводы
      • Получение комиссии для проведения вывода
      • Синхронный вывод
      • Асинхронный вывод
      • Получение информации о выводе
    • Счета
      • Создание счета на оплату
      • Запрос получения информации об инвойсе
      • Получение списка счетов
    • Авто обмены
      • Создание авто-обмена
      • Поиск авто-обмена по ID
    • Выплаты 2.0
      • Создание авто-вывода
      • Поиск авто-вывода по ID
      • Дополнительное подтверждение вывода
    • Мост
      • Получение лимиов для кроссчейн перевода
      • Получение информации о кроссчейн переводе
      • Формирование токена комисси
      • Создание кроссчейн перевода
    • Обмены
      • Получение лимитов для кроссчейн обмена
      • Получение информации о кроссчейн обмене
      • Формирование токена комисси
      • Создание кроссчейн обмена
    • Рекуррентные платежи
      • Создание платежной связки
      • Получение платежной связки
      • Получение платежных связок по пользователю
      • Отключение платежной связки
      • Создание подписки
      • Получение подписки
      • Отключение подписки
      • Создание платежа
    • KYT
      • Проверка рисков транзакции
      • Проверка рисков вывода
      • Проверка риска вывода на указанный адрес
    • Партнерское API
      • Создание пользователя
      • Получение пользователя
      • Получение всех пользователей
      • Создание организации
      • Получение списка организаций
      • Получение авансовых балансов пользователя
      • Пополнение авансового баланса пользователя
      • Получение общих тарифов
      • Создание/обновление индивидуального тарифа
      • Получение индвидуальных тарифов
      • Создание API ключа
      • Получение API ключей
      • Удаление API ключа
    • Вебхуки
      • Получение вебхука
      • Получение вебхука (расширенный)
    • Сиротские транзакции
      • Получение транзакции
      • Получение списка транзакций
      • Получение токена комиссии
      • Вывод
    • Адресная книга
      • Добавление адреса
      • Удаление адреса
      • Обновление адреса
      • Получение списка адресов
Powered by GitBook
On this page
  1. API Reference
  2. Партнерское API

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

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

Если для данного 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

PreviousПолучение общих тарифовNextПолучение индвидуальных тарифов

Last updated 7 months ago

  • Запрос:
  • POSTСоздание/обновление индивидуального тарифа

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

post
Header parameters
x-api-public-keystringOptional

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

x-api-signaturestringOptional

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

Content-typestringOptional

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

Example: application/json
Body

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

userIdstringOptional

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

Example: 7376bfd8-2e53-4832-8445-50095093b5c2
organizationIdstringOptional

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

Example: 23fd734d-df33-4c6a-964c-55fba0c235ee
actionstring · enumOptional

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

Example: EXCHANGE_AUTOPossible values:
amountstringOptional

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

Example: 0.03
typestring · enumOptional

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

Example: PERCENTPossible values:
commentstring | nullOptional

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

Example: tariff for John
minAmountstring | nullOptional

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

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

Example: 0.1
maxAmountstring | nullOptional

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

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

Example: 3000
Responses
200Success
application/json
post
POST /partner/api/set-organization-tariff HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "userId": "7376bfd8-2e53-4832-8445-50095093b5c2",
  "organizationId": "23fd734d-df33-4c6a-964c-55fba0c235ee",
  "action": "EXCHANGE_AUTO",
  "amount": "0.03",
  "type": "PERCENT",
  "comment": "tariff for John",
  "minAmount": "0.1",
  "maxAmount": "3000"
}
200Success
{
  "success": true,
  "response": null
}