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

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

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

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

userIdstringOptional

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

Example: ed83d19f-30ef-4b3f-bca9-edd2c7714b16
organizationIdstringOptional

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

Example: a61799b2-cd0c-47fd-a7f0-216b2be184c7
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": "ed83d19f-30ef-4b3f-bca9-edd2c7714b16",
  "organizationId": "a61799b2-cd0c-47fd-a7f0-216b2be184c7",
  "action": "EXCHANGE_AUTO",
  "amount": "0.03",
  "type": "PERCENT",
  "comment": "tariff for John",
  "minAmount": "0.1",
  "maxAmount": "3000"
}
200Success
{
  "success": true,
  "response": null
}

Last updated